public class MapEntrySerializer extends ContainerSerializer<Map.Entry<?,?>> implements ContextualSerializer
JsonSerializer.None
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 JavaType |
_entryType |
protected JsonSerializer<Object> |
_keySerializer
Key serializer to use, if it can be statically determined
|
protected JavaType |
_keyType |
protected BeanProperty |
_property
Map-valued property being serialized with this instance
|
protected 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 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 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 Object |
MARKER_FOR_EMPTY |
_handledType
Modifier | Constructor and 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,
Object suppressableValue,
boolean suppressNulls) |
Modifier and Type | Method and Description |
---|---|
protected JsonSerializer<Object> |
_findAndAddDynamic(PropertySerializerMap map,
Class<?> type,
SerializerProvider provider) |
protected JsonSerializer<Object> |
_findAndAddDynamic(PropertySerializerMap map,
JavaType type,
SerializerProvider provider) |
ContainerSerializer<?> |
_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. |
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(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,
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(Map.Entry<?,?> value,
JsonGenerator gen,
SerializerProvider provider)
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) |
void |
serializeWithType(Map.Entry<?,?> value,
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(Object suppressableValue,
boolean suppressNulls) |
MapEntrySerializer |
withResolved(BeanProperty property,
JsonSerializer<?> keySerializer,
JsonSerializer<?> valueSerializer,
Object suppressableValue,
boolean suppressNulls) |
hasContentTypeAnnotation, withValueTypeSerializer
_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
getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
public static final Object MARKER_FOR_EMPTY
protected final BeanProperty _property
protected final boolean _valueTypeIsStatic
protected final JavaType _entryType
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 _suppressableValue
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).protected final boolean _suppressNulls
_suppressableValue
public MapEntrySerializer(JavaType type, JavaType keyType, JavaType valueType, boolean staticTyping, TypeSerializer vts, BeanProperty property)
@Deprecated protected MapEntrySerializer(MapEntrySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> keySer, JsonSerializer<?> valueSer)
protected MapEntrySerializer(MapEntrySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> keySer, JsonSerializer<?> valueSer, Object suppressableValue, boolean suppressNulls)
public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)
ContainerSerializer
TypeSerializer
, used when
addition type information is to be embedded._withValueTypeSerializer
in class ContainerSerializer<Map.Entry<?,?>>
public MapEntrySerializer withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Object suppressableValue, boolean suppressNulls)
public MapEntrySerializer withContentInclusion(Object suppressableValue, boolean suppressNulls)
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 cannot 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.Entry<?,?>>
public JsonSerializer<?> getContentSerializer()
ContainerSerializer
ContainerSerializer.getContentType()
and
SerializerProvider.findContentValueSerializer(com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.BeanProperty)
.getContentSerializer
in class ContainerSerializer<Map.Entry<?,?>>
public boolean hasSingleElement(Map.Entry<?,?> 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).
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.
hasSingleElement
in class ContainerSerializer<Map.Entry<?,?>>
public boolean isEmpty(SerializerProvider prov, Map.Entry<?,?> entry)
JsonSerializer
Default implementation will consider only null values to be empty.
NOTE: replaces JsonSerializer.isEmpty(Object)
, which was deprecated in 2.5
isEmpty
in class JsonSerializer<Map.Entry<?,?>>
public void serialize(Map.Entry<?,?> value, JsonGenerator gen, SerializerProvider provider) throws IOException
JsonSerializer
serialize
in class StdSerializer<Map.Entry<?,?>>
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.Entry<?,?> value, JsonGenerator g, 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.Entry<?,?>>
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 informationIOException
protected void serializeDynamic(Map.Entry<?,?> value, JsonGenerator gen, SerializerProvider provider) throws IOException
IOException
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 © 2021 JBoss by Red Hat. All rights reserved.