|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.map.JsonSerializer<T>
org.codehaus.jackson.map.ser.SerializerBase<T>
org.codehaus.jackson.map.ser.ContainerSerializerBase<Map<?,?>>
org.codehaus.jackson.map.ser.MapSerializer
public class MapSerializer
Standard serializer implementation for serializing {link java.util.Map} types.
Note: about the only configurable setting currently is ability to filter out entries with specified names.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonSerializer |
---|
JsonSerializer.None |
Field Summary | |
---|---|
protected HashSet<String> |
_ignoredEntries
Set of entries to omit during serialization, if any |
protected JsonSerializer<Object> |
_valueSerializer
Value serializer to use, if it can be statically determined |
protected JavaType |
_valueType
Declared type of contained values |
protected boolean |
_valueTypeIsStatic
Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used) |
protected TypeSerializer |
_valueTypeSerializer
Type serializer used for values, if any. |
static MapSerializer |
instance
Default instance that can be used for Map types that have no specific custom annotations. |
Fields inherited from class org.codehaus.jackson.map.ser.SerializerBase |
---|
_handledType |
Constructor Summary | |
---|---|
protected |
MapSerializer()
|
protected |
MapSerializer(HashSet<String> ignoredEntries,
JavaType valueType,
boolean valueTypeIsStatic,
TypeSerializer vts)
|
Method Summary | |
---|---|
ContainerSerializerBase<?> |
_withValueTypeSerializer(TypeSerializer vts)
|
static MapSerializer |
construct(String[] ignoredList,
JavaType mapType,
boolean staticValueType,
TypeSerializer vts)
Factory method used to construct Map serializers. |
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint)
Get the representation of the schema to which this serializer will conform. |
void |
resolve(SerializerProvider provider)
Need to get callback to resolve value serializer, if static typing is used (either being forced, or because value type is final) |
void |
serialize(Map<?,?> value,
JsonGenerator jgen,
SerializerProvider provider)
Method that can be called to ask implementation to serialize values of type this serializer handles. |
protected void |
serializeFields(Map<?,?> value,
JsonGenerator jgen,
SerializerProvider provider)
Method called to serialize fields, when the value type is not statically known. |
protected void |
serializeFieldsUsing(Map<?,?> value,
JsonGenerator jgen,
SerializerProvider provider,
JsonSerializer<Object> ser)
Method called to serialize fields, when the value type is statically known, so that value serializer is passed and does not need to be fetched from provider. |
protected void |
serializeTypedFields(Map<?,?> value,
JsonGenerator jgen,
SerializerProvider provider)
|
void |
serializeWithType(Map<?,?> value,
JsonGenerator jgen,
SerializerProvider provider,
TypeSerializer typeSer)
Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information. |
Methods inherited from class org.codehaus.jackson.map.ser.ContainerSerializerBase |
---|
withValueTypeSerializer |
Methods inherited from class org.codehaus.jackson.map.ser.SerializerBase |
---|
createObjectNode, createSchemaNode, createSchemaNode, handledType, wrapAndThrow, wrapAndThrow |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final MapSerializer instance
protected final HashSet<String> _ignoredEntries
protected final boolean _valueTypeIsStatic
protected final JavaType _valueType
protected JsonSerializer<Object> _valueSerializer
protected final TypeSerializer _valueTypeSerializer
Constructor Detail |
---|
protected MapSerializer()
protected MapSerializer(HashSet<String> ignoredEntries, JavaType valueType, boolean valueTypeIsStatic, TypeSerializer vts)
Method Detail |
---|
public ContainerSerializerBase<?> _withValueTypeSerializer(TypeSerializer vts)
_withValueTypeSerializer
in class ContainerSerializerBase<Map<?,?>>
public static MapSerializer construct(String[] ignoredList, JavaType mapType, boolean staticValueType, TypeSerializer vts)
ignoredList
- Array of entry names that are to be filtered on
serialization; null if nonemapType
- Declared type information (needed for static typing)staticValueType
- Whether static typing should be used for the
Map (which includes its contents)vts
- Type serializer to use for map entry values, if anypublic void serialize(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException
JsonSerializer
serialize
in class SerializerBase<Map<?,?>>
value
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for
serializing Objects value contains, if any.
IOException
JsonGenerationException
public void serializeWithType(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer) throws IOException, JsonGenerationException
JsonSerializer
Default implementation will ignore serialization of type information,
and just calls JsonSerializer.serialize(T, org.codehaus.jackson.JsonGenerator, org.codehaus.jackson.map.SerializerProvider)
: serializers that can embed
type information should override this to implement actual handling.
serializeWithType
in class JsonSerializer<Map<?,?>>
value
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for
serializing Objects value contains, if any.typeSer
- Type serializer to use for including type information
IOException
JsonGenerationException
protected void serializeFields(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException
IOException
JsonGenerationException
protected void serializeFieldsUsing(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider, JsonSerializer<Object> ser) throws IOException, JsonGenerationException
IOException
JsonGenerationException
protected void serializeTypedFields(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
SchemaAware
getSchema
in interface SchemaAware
getSchema
in class SerializerBase<Map<?,?>>
provider
- The serializer provider.typeHint
- A hint about the type.
public void resolve(SerializerProvider provider) throws JsonMappingException
resolve
in interface ResolvableSerializer
provider
- Provider that has constructed serializer this method
is called on.
JsonMappingException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |