jackson-databind 2.16.0 · com.fasterxml.jackson.databind.ser.impl.MapEntrySerializer

Modifier and Type	Field and Description
protected PropertySerializerMap	_dynamicValueSerializers If value type cannot be statically determined, mapping from runtime value types to serializers are stored in this object.
protected final JavaType	_entryType
protected JsonSerializer<Object>	_keySerializer Key serializer to use, if it can be statically determined
protected final JavaType	_keyType
protected final BeanProperty	_property Map-valued property being serialized with this instance
protected final Object	_suppressableValue Value that indicates suppression mechanism to use for values contained; either "filter" (of which `equals()` is called), or marker value of `MARKER_FOR_EMPTY`, or null to indicate no filtering for non-null values.
protected final boolean	_suppressNulls Flag that indicates what to do with `null` values, distinct from handling of `_suppressableValue`
protected JsonSerializer<Object>	_valueSerializer Value serializer to use, if it can be statically determined
protected final JavaType	_valueType
protected final boolean	_valueTypeIsStatic Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)
protected final TypeSerializer	_valueTypeSerializer Type identifier serializer used for values, if any.
public static final Object	MARKER_FOR_EMPTY

Access	Constructor and Description
public	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, Object suppressableValue, boolean suppressNulls) Deprecated as a consequence of `MapEntrySerializer` being deprecated.

Method Summary

Modifier and Type	Method and Description
protected final JsonSerializer<Object>	_findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider)
protected final JsonSerializer<Object>	_findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider)
public ContainerSerializer<?>	_withValueTypeSerializer(TypeSerializer vts) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer. Deprecated as a consequence of `ContainerSerializer` being deprecated. 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.
public JsonSerializer<?>	createContextual(SerializerProvider Serializer provider to use for accessing config, other serializers provider, BeanProperty 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) property) Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.
public JsonSerializer<?>	getContentSerializer() Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.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.
public JavaType	getContentType() Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType. Accessor for finding declared (static) element type for type this serializer is used for.
public boolean	hasSingleElement(Map.Entry<?, ?> value) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement. Method called to determine if the given value (of type handled by this serializer) contains exactly one element.
public boolean	isEmpty(SerializerProvider prov, Map.Entry<?, ?> entry) Overrides com.fasterxml.jackson.databind.JsonSerializer.isEmpty. Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
public void	serialize(Map.Entry<?, ?> Value to serialize; can not be null. value, JsonGenerator Generator used to output resulting Json content gen, SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. provider) Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles.
protected void	serializeDynamic(Map.Entry<?, ?> value, JsonGenerator gen, SerializerProvider provider)
public void	serializeWithType(Map.Entry<?, ?> Value to serialize; can not be null. value, JsonGenerator Generator used to output resulting Json content g, SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. provider, TypeSerializer Type serializer to use for including type information typeSer) Overrides com.fasterxml.jackson.databind.JsonSerializer.serializeWithType. 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.
public MapEntrySerializer	withContentInclusion(Object suppressableValue, boolean suppressNulls) Deprecated as a consequence of `MapEntrySerializer` being deprecated.
public MapEntrySerializer	withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Object suppressableValue, boolean suppressNulls) Deprecated as a consequence of `MapEntrySerializer` being deprecated.

Inherited from com.fasterxml.jackson.databind.ser.ContainerSerializer:: hasContentTypeAnnotation withValueTypeSerializer

Field Detail

_dynamicValueSerializers	back to summary
protected PropertySerializerMap _dynamicValueSerializers If value type cannot be statically determined, mapping from runtime value types to serializers are stored in this object.

_entryType	back to summary
protected final JavaType _entryType

_keySerializer	back to summary
protected JsonSerializer<Object> _keySerializer Key serializer to use, if it can be statically determined

_keyType	back to summary
protected final JavaType _keyType

_property	back to summary
protected final BeanProperty _property Map-valued property being serialized with this instance

_suppressableValue back to summary

_suppressableValue	back to summary
protected final Object _suppressableValue Value that indicates suppression mechanism to use for values contained; either "filter" (of which `equals()` is called), or marker value of `MARKER_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

protected final Object _suppressableValue

Value that indicates suppression mechanism to use for values contained; either "filter" (of which equals() is called), or marker value of MARKER_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 back to summary

_suppressNulls	back to summary
protected final boolean _suppressNulls Flag that indicates what to do with `null` values, distinct from handling of `_suppressableValue` Since 2.9

protected final boolean _suppressNulls

Flag that indicates what to do with `null` values, distinct from handling of _suppressableValue

Since: 2.9

_valueSerializer	back to summary
protected JsonSerializer<Object> _valueSerializer Value serializer to use, if it can be statically determined

_valueType	back to summary
protected final JavaType _valueType

_valueTypeIsStatic	back to summary
protected final boolean _valueTypeIsStatic Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)

_valueTypeSerializer	back to summary
protected final TypeSerializer _valueTypeSerializer Type identifier serializer used for values, if any.

MARKER_FOR_EMPTY	back to summary
public static final Object MARKER_FOR_EMPTY Since 2.9

Constructor Detail

MapEntrySerializer	back to summary
public MapEntrySerializer(JavaType type, JavaType keyType, JavaType valueType, boolean staticTyping, TypeSerializer vts, BeanProperty property)

MapEntrySerializer	back to summary
protected MapEntrySerializer(MapEntrySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> keySer, JsonSerializer<?> valueSer) Deprecated Annotations @Deprecated

MapEntrySerializer	back to summary
protected MapEntrySerializer(MapEntrySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> keySer, JsonSerializer<?> valueSer, Object suppressableValue, boolean suppressNulls) Deprecated as a consequence of `MapEntrySerializer` being deprecated. See corresponding docs for further information. Annotations @SuppressWarnings:unchecked

Method Detail

_findAndAddDynamic	back to summary
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider) throws JsonMappingException

_findAndAddDynamic	back to summary
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider) throws JsonMappingException

_withValueTypeSerializer back to summary

_withValueTypeSerializer	back to summary
public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer. Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer. Deprecated as a consequence of `ContainerSerializer` being deprecated. See corresponding docs for further information. 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. Annotations @Override

public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer.

Deprecated

as a consequence of ContainerSerializer being deprecated. See corresponding docs for further information.

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.

Annotations

@Override

createContextual	back to summary
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. 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. Parameters provider:SerializerProvider Serializer provider to use for accessing config, other serializers property:BeanProperty 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:JsonSerializer<?> Serializer to use for serializing values of specified property; may be this instance or a new instance. Annotations @Override

createContextual

back to summary

public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

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.

Parameters

provider:SerializerProvider: Serializer provider to use for accessing config, other serializers
property:BeanProperty: 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:JsonSerializer<?>

Serializer to use for serializing values of specified property; may be this instance or a new instance.

Annotations

@Override

getContentSerializer back to summary

getContentSerializer	back to summary
public JsonSerializer<?> getContentSerializer() Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentSerializer. Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.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. Note that for dynamic types this may return null; if so, caller has to instead use `getContentType()` and `com.fasterxml.jackson.databind.SerializerProvider#findContentValueSerializer`. Annotations @Override

public JsonSerializer<?> getContentSerializer()

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentSerializer.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.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. Note that for dynamic types this may return null; if so, caller has to instead use getContentType() and com.fasterxml.jackson.databind.SerializerProvider#findContentValueSerializer.

Annotations

@Override

getContentType	back to summary
public JavaType getContentType() Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType. Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType. Accessor for finding declared (static) element type for type this serializer is used for. Annotations @Override

getContentType

back to summary

public JavaType getContentType()

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType.

Accessor for finding declared (static) element type for type this serializer is used for.

Annotations

@Override

hasSingleElement back to summary

hasSingleElement	back to summary
public boolean hasSingleElement(Map.Entry<?, ?> value) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement. Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement. 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` or `Map.Entry` instances. Annotations @Override

public boolean hasSingleElement(Map.Entry<?, ?> value)

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement.

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 or Map.Entry instances.

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty(SerializerProvider prov, Map.Entry<?, ?> entry) Overrides com.fasterxml.jackson.databind.JsonSerializer.isEmpty. Doc from com.fasterxml.jackson.databind.JsonSerializer.isEmpty. 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 `isEmpty(Object)`, which was deprecated in 2.5 Annotations @Override

public boolean isEmpty(SerializerProvider prov, Map.Entry<?, ?> entry)

Overrides com.fasterxml.jackson.databind.JsonSerializer.isEmpty.

Doc from com.fasterxml.jackson.databind.JsonSerializer.isEmpty.

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 isEmpty(Object), which was deprecated in 2.5

Annotations

@Override

serialize	back to summary
public void serialize(Map.Entry<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOException Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize. Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles. Parameters value:Map.Entry<?, ?> Value to serialize; can not be null. gen:JsonGenerator Generator used to output resulting Json content provider:SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. Annotations @Override

serialize

back to summary

public void serialize(Map.Entry<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.

Parameters

value:Map.Entry<?, ?>: Value to serialize; can not be null.
gen:JsonGenerator: Generator used to output resulting Json content
provider:SerializerProvider: Provider that can be used to get serializers for serializing Objects value contains, if any.

Annotations

@Override

serializeDynamic	back to summary
protected void serializeDynamic(Map.Entry<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOException

serializeWithType back to summary

serializeWithType	back to summary
public void serializeWithType(Map.Entry<?, ?> value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException Overrides com.fasterxml.jackson.databind.JsonSerializer.serializeWithType. Doc from com.fasterxml.jackson.databind.JsonSerializer.serializeWithType. 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, as `START-ARRAY`/`END-ARRAY` and `START-OBJECT`/`END-OBJECT` pairs need to be properly handled with respect to serializing of contents. Parameters value:Map.Entry<?, ?> Value to serialize; can not be null. g:JsonGenerator Generator used to output resulting Json content provider:SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. typeSer:TypeSerializer Type serializer to use for including type information Annotations @Override

public void serializeWithType(Map.Entry<?, ?> value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException

Overrides com.fasterxml.jackson.databind.JsonSerializer.serializeWithType.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serializeWithType.

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, as START-ARRAY/END-ARRAY and START-OBJECT/END-OBJECT pairs need to be properly handled with respect to serializing of contents.

Parameters

value:Map.Entry<?, ?>: Value to serialize; can not be null.
g:JsonGenerator: Generator used to output resulting Json content
provider:SerializerProvider: Provider that can be used to get serializers for serializing Objects value contains, if any.
typeSer:TypeSerializer: Type serializer to use for including type information

Annotations

@Override

withContentInclusion	back to summary
public MapEntrySerializer withContentInclusion(Object suppressableValue, boolean suppressNulls) Deprecated as a consequence of `MapEntrySerializer` being deprecated. See corresponding docs for further information. Since 2.9

withResolved	back to summary
public MapEntrySerializer withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Object suppressableValue, boolean suppressNulls) Deprecated as a consequence of `MapEntrySerializer` being deprecated. See corresponding docs for further information. Since 2.9

public Class MapEntrySerializer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail