public class MapSerializer extends ContainerSerializer<Map<?,?>> implements ContextualSerializer
Note: about the only configurable setting currently is ability to filter out entries with specified names.
JsonSerializer.None
Modifier and Type | Field and Description |
---|---|
protected PropertySerializerMap |
_dynamicValueSerializers
If value type can not be statically determined, mapping from
runtime value types to serializers are stored in this object.
|
protected Object |
_filterId
Id of the property filter to use, if any; null if none.
|
protected HashSet<String> |
_ignoredEntries
Set of entries to omit during serialization, if any
|
protected JsonSerializer<Object> |
_keySerializer
Key serializer to use, if it can be statically determined
|
protected JavaType |
_keyType
Declared type of keys
|
protected BeanProperty |
_property
Map-valued property being serialized with this instance
|
protected boolean |
_sortKeys
Flag set if output is forced to be sorted by keys (usually due
to annotation).
|
protected Object |
_suppressableValue
Value that indicates suppression mechanism to use; either one of
values of
JsonInclude.Include , or actual object to compare
against ("default value") |
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 identifier serializer used for values, if any.
|
protected static JavaType |
UNSPECIFIED_TYPE |
_handledType
Modifier | Constructor and Description |
---|---|
protected |
MapSerializer(HashSet<String> ignoredEntries,
JavaType keyType,
JavaType valueType,
boolean valueTypeIsStatic,
TypeSerializer vts,
JsonSerializer<?> keySerializer,
JsonSerializer<?> valueSerializer) |
protected |
MapSerializer(MapSerializer src,
BeanProperty property,
JsonSerializer<?> keySerializer,
JsonSerializer<?> valueSerializer,
HashSet<String> ignored) |
protected |
MapSerializer(MapSerializer src,
Object filterId,
boolean sortKeys) |
protected |
MapSerializer(MapSerializer src,
TypeSerializer vts)
Deprecated.
|
protected |
MapSerializer(MapSerializer src,
TypeSerializer vts,
Object suppressableValue) |
Modifier and Type | Method and Description |
---|---|
protected void |
_ensureOverride() |
protected JsonSerializer<Object> |
_findAndAddDynamic(PropertySerializerMap map,
Class<?> type,
SerializerProvider provider) |
protected JsonSerializer<Object> |
_findAndAddDynamic(PropertySerializerMap map,
JavaType type,
SerializerProvider provider) |
protected Map<?,?> |
_orderEntries(Map<?,?> input) |
MapSerializer |
_withValueTypeSerializer(TypeSerializer vts)
Method that needs to be implemented to allow construction of a new
serializer object with given
TypeSerializer , used when
addition type information is to be embedded. |
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
Default implementation specifies no format.
|
static MapSerializer |
construct(String[] ignoredList,
JavaType mapType,
boolean staticValueType,
TypeSerializer vts,
JsonSerializer<Object> keySerializer,
JsonSerializer<Object> valueSerializer,
Object filterId) |
JsonSerializer<?> |
createContextual(SerializerProvider provider,
BeanProperty property)
Method called to see if a different (or differently configured) serializer
is needed to serialize values of specified property.
|
JsonSerializer<?> |
getContentSerializer()
Accessor for serializer used for serializing contents
(List and array elements, Map values etc) of the
container for which this serializer is used, if it is
known statically.
|
JavaType |
getContentType()
Accessor for finding declared (static) element type for
type this serializer is used for.
|
JsonSerializer<?> |
getKeySerializer()
Accessor for currently assigned key serializer.
|
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint)
Default implementation simply claims type is "string"; usually
overriden by custom serializers.
|
boolean |
hasSingleElement(Map<?,?> value)
Method called to determine if the given value (of type handled by
this serializer) contains exactly one element.
|
boolean |
isEmpty(SerializerProvider prov,
Map<?,?> value)
Method called to check whether given serializable value is
considered "empty" value (for purposes of suppressing serialization
of empty values).
|
void |
serialize(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider provider)
Method that can be called to ask implementation to serialize
values of type this serializer handles.
|
void |
serializeFields(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider provider)
Method called to serialize fields, when the value type is not statically known;
but we know that no value suppression is needed (which simplifies processing a bit)
|
protected void |
serializeFieldsUsing(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
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.
|
void |
serializeFilteredFields(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider provider,
PropertyFilter filter)
Deprecated.
|
void |
serializeFilteredFields(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider provider,
PropertyFilter filter,
Object suppressableValue)
Helper method used when we have a JSON Filter to use for potentially
filtering out Map entries.
|
void |
serializeOptionalFields(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider provider,
Object suppressableValue) |
protected void |
serializeTypedFields(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider provider)
Deprecated.
|
protected void |
serializeTypedFields(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
SerializerProvider provider,
Object suppressableValue) |
void |
serializeWithType(Map<?,?> value,
com.fasterxml.jackson.core.JsonGenerator gen,
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.
|
MapSerializer |
withContentInclusion(Object suppressableValue)
Mutant factory for constructing an instance with different inclusion strategy
for content (Map values).
|
MapSerializer |
withFilterId(Object filterId) |
MapSerializer |
withResolved(BeanProperty property,
JsonSerializer<?> keySerializer,
JsonSerializer<?> valueSerializer,
HashSet<String> ignored,
boolean sortKeys) |
hasContentTypeAnnotation, isEmpty, withValueTypeSerializer
createObjectNode, createSchemaNode, createSchemaNode, findConvertingContentSerializer, findPropertyFilter, getSchema, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow
getDelegatee, isUnwrappingSerializer, replaceDelegatee, unwrappingSerializer, usesObjectId
protected static final JavaType UNSPECIFIED_TYPE
protected final BeanProperty _property
protected final HashSet<String> _ignoredEntries
protected final boolean _valueTypeIsStatic
protected final JavaType _keyType
protected final JavaType _valueType
protected JsonSerializer<Object> _keySerializer
protected JsonSerializer<Object> _valueSerializer
protected final TypeSerializer _valueTypeSerializer
protected PropertySerializerMap _dynamicValueSerializers
protected final Object _filterId
protected final boolean _sortKeys
protected final Object _suppressableValue
JsonInclude.Include
, or actual object to compare
against ("default value")protected MapSerializer(HashSet<String> ignoredEntries, JavaType keyType, JavaType valueType, boolean valueTypeIsStatic, TypeSerializer vts, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer)
protected MapSerializer(MapSerializer src, BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, HashSet<String> ignored)
@Deprecated protected MapSerializer(MapSerializer src, TypeSerializer vts)
protected MapSerializer(MapSerializer src, TypeSerializer vts, Object suppressableValue)
protected MapSerializer(MapSerializer src, Object filterId, boolean sortKeys)
protected void _ensureOverride()
public MapSerializer _withValueTypeSerializer(TypeSerializer vts)
ContainerSerializer
TypeSerializer
, used when
addition type information is to be embedded._withValueTypeSerializer
in class ContainerSerializer<Map<?,?>>
public MapSerializer withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, HashSet<String> ignored, boolean sortKeys)
public MapSerializer withFilterId(Object filterId)
public MapSerializer withContentInclusion(Object suppressableValue)
public static MapSerializer construct(String[] ignoredList, JavaType mapType, boolean staticValueType, TypeSerializer vts, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer, Object filterId)
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException
ContextualSerializer
createContextual
in interface ContextualSerializer
provider
- Serializer provider to use for accessing config, other serializersproperty
- Method or field that represents the property
(and is used to access value to serialize).
Should be available; but there may be cases where caller can not provide it and
null is passed instead (in which case impls usually pass 'this' serializer as is)JsonMappingException
public JavaType getContentType()
ContainerSerializer
getContentType
in class ContainerSerializer<Map<?,?>>
public JsonSerializer<?> getContentSerializer()
ContainerSerializer
ContainerSerializer.getContentType()
and
SerializerProvider.findValueSerializer(java.lang.Class<?>, com.fasterxml.jackson.databind.BeanProperty)
.getContentSerializer
in class ContainerSerializer<Map<?,?>>
public boolean isEmpty(SerializerProvider prov, Map<?,?> value)
JsonSerializer
Default implementation will consider only null values to be empty.
NOTE: replaces JsonSerializer.isEmpty(Object)
, deprecated in 2.5
isEmpty
in class JsonSerializer<Map<?,?>>
public boolean hasSingleElement(Map<?,?> value)
ContainerSerializer
Note: although it might seem sensible to instead define something like "getElementCount()" method, this would not work well for containers that do not keep track of size (like linked lists may not).
hasSingleElement
in class ContainerSerializer<Map<?,?>>
public JsonSerializer<?> getKeySerializer()
MapSerializer
:
depedencies are resolved during createContextual(com.fasterxml.jackson.databind.SerializerProvider, com.fasterxml.jackson.databind.BeanProperty)
method
(which can be overridden by custom implementations), but for some
dynamic types, it is possible that serializer is only resolved
during actual serialization.public void serialize(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws IOException
JsonSerializer
serialize
in class StdSerializer<Map<?,?>>
value
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for
serializing Objects value contains, if any.IOException
public void serializeWithType(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOException
JsonSerializer
Default implementation will throw UnsupportedOperationException
to indicate that proper type handling needs to be implemented.
For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like:
// note: method to call depends on whether this type is serialized as JSON scalar, object or Array! typeSer.writeTypePrefixForScalar(value, gen); serialize(value, gen, provider); typeSer.writeTypeSuffixForScalar(value, gen);and implementations for type serialized as JSON Arrays or Objects would differ slightly, as
START-ARRAY>/END-ARRAY
and
START-OBJECT>/END-OBJECT
pairs
need to be properly handled with respect to serializing of contents.
serializeWithType
in class JsonSerializer<Map<?,?>>
value
- Value to serialize; can not be null.gen
- 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 informationIOException
public void serializeFields(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws IOException
IOException
public void serializeOptionalFields(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, Object suppressableValue) throws IOException
IOException
protected void serializeFieldsUsing(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, JsonSerializer<Object> ser) throws IOException
IOException
public void serializeFilteredFields(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, PropertyFilter filter, Object suppressableValue) throws IOException
IOException
@Deprecated public void serializeFilteredFields(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, PropertyFilter filter) throws IOException
IOException
protected void serializeTypedFields(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider, Object suppressableValue) throws IOException
IOException
@Deprecated protected void serializeTypedFields(Map<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws IOException
IOException
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
StdSerializer
getSchema
in interface SchemaAware
getSchema
in class StdSerializer<Map<?,?>>
provider
- The serializer provider.typeHint
- A hint about the type.public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
StdSerializer
acceptJsonFormatVisitor
in interface JsonFormatVisitable
acceptJsonFormatVisitor
in class StdSerializer<Map<?,?>>
typeHint
- Type of element (entity like property) being visitedJsonMappingException
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider) throws JsonMappingException
JsonMappingException
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider) throws JsonMappingException
JsonMappingException
Copyright © 2014-2015 FasterXML. All Rights Reserved.