Jackson 3.0.1 · tools.jackson.databind.ser.jdk.MapEntrySerializer

Field Summary

Modifier and Type	Field and Description
protected final JavaType	_entryType
protected ValueSerializer<Object>	_keySerializer Key serializer to use, if it can be statically determined
protected final JavaType	_keyType
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 ValueSerializer<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

Inherited from tools.jackson.databind.ser.std.StdContainerSerializer:: _dynamicValueSerializers _property

Constructor Summary

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, ValueSerializer<?> keySer, ValueSerializer<?> valueSer, Object suppressableValue, boolean suppressNulls)

Method Summary

Modifier and Type	Method and Description
public StdContainerSerializer<?>	_withValueTypeSerializer(TypeSerializer vts) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer. 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 ValueSerializer<?>	createContextual(SerializationContext provider, BeanProperty property) Overrides tools.jackson.databind.ValueSerializer.createContextual. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed).
public ValueSerializer<?>	getContentSerializer() Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.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 tools.jackson.databind.ser.std.StdContainerSerializer.getContentType. Accessor for finding declared (static) element type for type this serializer is used for.
public boolean	hasSingleElement(Map.Entry<?, ?> value) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement. Method called to determine if the given value (of type handled by this serializer) contains exactly one element.
public boolean	isEmpty(SerializationContext ctxt, Map.Entry<?, ?> entry) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.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, JsonGenerator g, SerializationContext ctxt) Implements abstract tools.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, SerializationContext ctxt)
public void	serializeWithType(Map.Entry<?, ?> value, JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer) Overrides tools.jackson.databind.ValueSerializer.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)
public MapEntrySerializer	withResolved(BeanProperty property, ValueSerializer<?> keySerializer, ValueSerializer<?> valueSerializer, Object suppressableValue, boolean suppressNulls)

Inherited from tools.jackson.databind.ser.std.StdContainerSerializer:: _findAndAddDynamic _findAndAddDynamic withValueTypeSerializer

Field Detail

_entryType	back to summary
protected final JavaType _entryType

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

_keyType	back to summary
protected final JavaType _keyType

_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).

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

_valueSerializer	back to summary
protected ValueSerializer<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

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, ValueSerializer<?> keySer, ValueSerializer<?> valueSer, Object suppressableValue, boolean suppressNulls) Annotations @SuppressWarnings:unchecked

Method Detail

_withValueTypeSerializer back to summary

_withValueTypeSerializer	back to summary
public StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer. Doc from tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer. 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 StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer.

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 ValueSerializer<?> createContextual(SerializationContext provider, BeanProperty property) Overrides tools.jackson.databind.ValueSerializer.createContextual. Doc from tools.jackson.databind.ValueSerializer.createContextual. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). 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. Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use. Annotations @Override

createContextual

back to summary

public ValueSerializer<?> createContextual(SerializationContext provider, BeanProperty property)

Overrides tools.jackson.databind.ValueSerializer.createContextual.

Doc from tools.jackson.databind.ValueSerializer.createContextual.

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). 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.

Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.

Annotations

@Override

getContentSerializer back to summary

getContentSerializer	back to summary
public ValueSerializer<?> getContentSerializer() Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentSerializer. Doc from tools.jackson.databind.ser.std.StdContainerSerializer.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 `tools.jackson.databind.SerializationContext#findContentValueSerializer`. Annotations @Override

public ValueSerializer<?> getContentSerializer()

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentSerializer.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.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 tools.jackson.databind.SerializationContext#findContentValueSerializer.

Annotations

@Override

getContentType	back to summary
public JavaType getContentType() Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentType. Doc from tools.jackson.databind.ser.std.StdContainerSerializer.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 tools.jackson.databind.ser.std.StdContainerSerializer.getContentType.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.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 tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement. Doc from tools.jackson.databind.ser.std.StdContainerSerializer.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 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 tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.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 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
public boolean isEmpty(SerializationContext ctxt, Map.Entry<?, ?> entry) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.isEmpty. Doc from tools.jackson.databind.ValueSerializer.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. Annotations @Override

isEmpty

back to summary

public boolean isEmpty(SerializationContext ctxt, Map.Entry<?, ?> entry)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.isEmpty.

Doc from tools.jackson.databind.ValueSerializer.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.

Annotations

@Override

serialize	back to summary
public void serialize(Map.Entry<?, ?> value, JsonGenerator g, SerializationContext ctxt) throws JacksonException Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize. Doc from tools.jackson.databind.ValueSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles. Annotations @Override

serialize

back to summary

public void serialize(Map.Entry<?, ?> value, JsonGenerator g, SerializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize.

Doc from tools.jackson.databind.ValueSerializer.serialize.

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

Annotations

@Override

serializeDynamic	back to summary
protected void serializeDynamic(Map.Entry<?, ?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException

serializeWithType back to summary

serializeWithType	back to summary
public void serializeWithType(Map.Entry<?, ?> value, JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException Overrides tools.jackson.databind.ValueSerializer.serializeWithType. Doc from tools.jackson.databind.ValueSerializer.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. Annotations @Override

public void serializeWithType(Map.Entry<?, ?> value, JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException

Overrides tools.jackson.databind.ValueSerializer.serializeWithType.

Doc from tools.jackson.databind.ValueSerializer.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.

Annotations

@Override

withContentInclusion	back to summary
public MapEntrySerializer withContentInclusion(Object suppressableValue, boolean suppressNulls)

withResolved	back to summary
public MapEntrySerializer withResolved(BeanProperty property, ValueSerializer<?> keySerializer, ValueSerializer<?> valueSerializer, Object suppressableValue, boolean suppressNulls)

public Class MapEntrySerializer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail