Class MapEntrySerializer
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
-
- com.fasterxml.jackson.databind.ser.ContainerSerializer<java.util.Map.Entry<?,?>>
-
- com.fasterxml.jackson.databind.ser.impl.MapEntrySerializer
-
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,ContextualSerializer
,java.io.Serializable
public class MapEntrySerializer extends ContainerSerializer<java.util.Map.Entry<?,?>> implements ContextualSerializer
- Since:
- 2.5
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer
JsonSerializer.None
-
-
Field Summary
Fields Modifier and Type Field Description protected PropertySerializerMap
_dynamicValueSerializers
If value type cannot be statically determined, mapping from runtime value types to serializers are stored in this object.protected JavaType
_entryType
protected JsonSerializer<java.lang.Object>
_keySerializer
Key serializer to use, if it can be statically determinedprotected JavaType
_keyType
protected BeanProperty
_property
Map-valued property being serialized with this instanceprotected java.lang.Object
_suppressableValue
Value that indicates suppression mechanism to use for values contained; either "filter" (of whichequals()
is called), or marker value ofMARKER_FOR_EMPTY
, or null to indicate no filtering for non-null values.protected boolean
_suppressNulls
Flag that indicates what to do with `null` values, distinct from handling of_suppressableValue
protected JsonSerializer<java.lang.Object>
_valueSerializer
Value serializer to use, if it can be statically determinedprotected JavaType
_valueType
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.static java.lang.Object
MARKER_FOR_EMPTY
-
Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
-
Constructor Summary
Constructors Modifier Constructor Description MapEntrySerializer(JavaType type, JavaType keyType, JavaType valueType, boolean staticTyping, TypeSerializer vts, BeanProperty property)
protected
MapEntrySerializer(MapEntrySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> keySer, JsonSerializer<?> valueSer)
Deprecated.protected
MapEntrySerializer(MapEntrySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> keySer, JsonSerializer<?> valueSer, java.lang.Object suppressableValue, boolean suppressNulls)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected JsonSerializer<java.lang.Object>
_findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider)
protected JsonSerializer<java.lang.Object>
_findAndAddDynamic(PropertySerializerMap map, java.lang.Class<?> type, SerializerProvider provider)
ContainerSerializer<?>
_withValueTypeSerializer(TypeSerializer vts)
Method that needs to be implemented to allow construction of a new serializer object with givenTypeSerializer
, used when addition type information is to be embedded.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.boolean
hasSingleElement(java.util.Map.Entry<?,?> value)
Method called to determine if the given value (of type handled by this serializer) contains exactly one element.boolean
isEmpty(SerializerProvider prov, java.util.Map.Entry<?,?> entry)
Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).void
serialize(java.util.Map.Entry<?,?> 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.protected void
serializeDynamic(java.util.Map.Entry<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider)
void
serializeWithType(java.util.Map.Entry<?,?> value, com.fasterxml.jackson.core.JsonGenerator g, 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.MapEntrySerializer
withContentInclusion(java.lang.Object suppressableValue, boolean suppressNulls)
MapEntrySerializer
withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, java.lang.Object suppressableValue, boolean suppressNulls)
-
Methods inherited from class com.fasterxml.jackson.databind.ser.ContainerSerializer
hasContentTypeAnnotation, withValueTypeSerializer
-
Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_neitherNull, _nonEmpty, acceptJsonFormatVisitor, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
-
Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer
getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
-
-
-
-
Field Detail
-
MARKER_FOR_EMPTY
public static final java.lang.Object MARKER_FOR_EMPTY
- Since:
- 2.9
-
_property
protected final BeanProperty _property
Map-valued property being serialized with this instance
-
_valueTypeIsStatic
protected final boolean _valueTypeIsStatic
Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)
-
_entryType
protected final JavaType _entryType
-
_keyType
protected final JavaType _keyType
-
_valueType
protected final JavaType _valueType
-
_keySerializer
protected JsonSerializer<java.lang.Object> _keySerializer
Key serializer to use, if it can be statically determined
-
_valueSerializer
protected JsonSerializer<java.lang.Object> _valueSerializer
Value serializer to use, if it can be statically determined
-
_valueTypeSerializer
protected final TypeSerializer _valueTypeSerializer
Type identifier serializer used for values, if any.
-
_dynamicValueSerializers
protected PropertySerializerMap _dynamicValueSerializers
If value type cannot be statically determined, mapping from runtime value types to serializers are stored in this object.
-
_suppressableValue
protected final java.lang.Object _suppressableValue
Value that indicates suppression mechanism to use for values contained; either "filter" (of whichequals()
is called), or marker value ofMARKER_FOR_EMPTY
, or null to indicate no filtering for non-null values. Note that inclusion value for Map instance itself is handled by caller (POJO property that refers to the Map value).- Since:
- 2.5
-
_suppressNulls
protected final boolean _suppressNulls
Flag that indicates what to do with `null` values, distinct from handling of_suppressableValue
- Since:
- 2.9
-
-
Constructor Detail
-
MapEntrySerializer
public MapEntrySerializer(JavaType type, JavaType keyType, JavaType valueType, boolean staticTyping, TypeSerializer vts, BeanProperty property)
-
MapEntrySerializer
@Deprecated protected MapEntrySerializer(MapEntrySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> keySer, JsonSerializer<?> valueSer)
Deprecated.
-
MapEntrySerializer
protected MapEntrySerializer(MapEntrySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> keySer, JsonSerializer<?> valueSer, java.lang.Object suppressableValue, boolean suppressNulls)
-
-
Method Detail
-
_withValueTypeSerializer
public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)
Description copied from class:ContainerSerializer
Method that needs to be implemented to allow construction of a new serializer object with givenTypeSerializer
, used when addition type information is to be embedded.- Specified by:
_withValueTypeSerializer
in classContainerSerializer<java.util.Map.Entry<?,?>>
-
withResolved
public MapEntrySerializer withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, java.lang.Object suppressableValue, boolean suppressNulls)
- Since:
- 2.9
-
withContentInclusion
public MapEntrySerializer withContentInclusion(java.lang.Object suppressableValue, boolean suppressNulls)
- Since:
- 2.9
-
createContextual
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException
Description copied from interface:ContextualSerializer
Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.- Specified by:
createContextual
in interfaceContextualSerializer
- Parameters:
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 cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)- Returns:
- Serializer to use for serializing values of specified property; may be this instance or a new instance.
- Throws:
JsonMappingException
-
getContentType
public JavaType getContentType()
Description copied from class:ContainerSerializer
Accessor for finding declared (static) element type for type this serializer is used for.- Specified by:
getContentType
in classContainerSerializer<java.util.Map.Entry<?,?>>
-
getContentSerializer
public JsonSerializer<?> getContentSerializer()
Description copied from class:ContainerSerializer
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. Note that for dynamic types this may return null; if so, caller has to instead useContainerSerializer.getContentType()
andSerializerProvider.findContentValueSerializer(com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.BeanProperty)
.- Specified by:
getContentSerializer
in classContainerSerializer<java.util.Map.Entry<?,?>>
-
hasSingleElement
public boolean hasSingleElement(java.util.Map.Entry<?,?> value)
Description copied from class:ContainerSerializer
Method called to determine if the given value (of type handled by this serializer) contains exactly one element.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).
Note, too, that as of now (2.9) this method is only called by serializer itself; and specifically is not used for non-array/collection types like
Map
orMap.Entry
instances.- Specified by:
hasSingleElement
in classContainerSerializer<java.util.Map.Entry<?,?>>
-
isEmpty
public boolean isEmpty(SerializerProvider prov, java.util.Map.Entry<?,?> entry)
Description copied from class:JsonSerializer
Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).Default implementation will consider only null values to be empty.
NOTE: replaces
JsonSerializer.isEmpty(Object)
, which was deprecated in 2.5- Overrides:
isEmpty
in classJsonSerializer<java.util.Map.Entry<?,?>>
-
serialize
public void serialize(java.util.Map.Entry<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws java.io.IOException
Description copied from class:JsonSerializer
Method that can be called to ask implementation to serialize values of type this serializer handles.- Specified by:
serialize
in classStdSerializer<java.util.Map.Entry<?,?>>
- Parameters:
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.- Throws:
java.io.IOException
-
serializeWithType
public void serializeWithType(java.util.Map.Entry<?,?> value, com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws java.io.IOException
Description copied from class:JsonSerializer
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.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, asSTART-ARRAY
/END-ARRAY
andSTART-OBJECT
/END-OBJECT
pairs need to be properly handled with respect to serializing of contents.- Overrides:
serializeWithType
in classJsonSerializer<java.util.Map.Entry<?,?>>
- Parameters:
value
- Value to serialize; can not be null.g
- 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- Throws:
java.io.IOException
-
serializeDynamic
protected void serializeDynamic(java.util.Map.Entry<?,?> value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider) throws java.io.IOException
- Throws:
java.io.IOException
-
_findAndAddDynamic
protected final JsonSerializer<java.lang.Object> _findAndAddDynamic(PropertySerializerMap map, java.lang.Class<?> type, SerializerProvider provider) throws JsonMappingException
- Throws:
JsonMappingException
-
_findAndAddDynamic
protected final JsonSerializer<java.lang.Object> _findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider) throws JsonMappingException
- Throws:
JsonMappingException
-
-