public class MapEntrySerializer extends ContainerSerializer<java.util.Map.Entry<?,?>> implements ContextualSerializer
JsonSerializer.None
Modifier and Type | Field and Description |
---|---|
static java.lang.Object |
MARKER_FOR_EMPTY |
Constructor and Description |
---|
MapEntrySerializer(JavaType type,
JavaType keyType,
JavaType valueType,
boolean staticTyping,
TypeSerializer vts,
BeanProperty property) |
Modifier and Type | Method and Description |
---|---|
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(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,
JsonGenerator gen,
SerializerProvider provider)
Method that can be called to ask implementation to serialize
values of type this serializer handles.
|
void |
serializeWithType(java.util.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(java.lang.Object suppressableValue,
boolean suppressNulls) |
MapEntrySerializer |
withResolved(BeanProperty property,
JsonSerializer<?> keySerializer,
JsonSerializer<?> valueSerializer,
java.lang.Object suppressableValue,
boolean suppressNulls) |
withValueTypeSerializer
acceptJsonFormatVisitor, getSchema, getSchema, handledType, wrapAndThrow, wrapAndThrow
getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
public MapEntrySerializer(JavaType type, JavaType keyType, JavaType valueType, boolean staticTyping, TypeSerializer vts, BeanProperty property)
public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)
ContainerSerializer
TypeSerializer
, used when
addition type information is to be embedded.public MapEntrySerializer withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, java.lang.Object suppressableValue, boolean suppressNulls)
public MapEntrySerializer withContentInclusion(java.lang.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<java.util.Map.Entry<?,?>>
public JsonSerializer<?> getContentSerializer()
ContainerSerializer
ContainerSerializer.getContentType()
and
SerializerProvider.findValueSerializer(java.lang.Class<?>, com.fasterxml.jackson.databind.BeanProperty)
.getContentSerializer
in class ContainerSerializer<java.util.Map.Entry<?,?>>
public boolean hasSingleElement(java.util.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<java.util.Map.Entry<?,?>>
public boolean isEmpty(SerializerProvider prov, java.util.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<java.util.Map.Entry<?,?>>
public void serialize(java.util.Map.Entry<?,?> value, JsonGenerator gen, SerializerProvider provider) throws java.io.IOException
JsonSerializer
serialize
in class StdSerializer<java.util.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.java.io.IOException
public void serializeWithType(java.util.Map.Entry<?,?> value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws java.io.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<java.util.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 informationjava.io.IOException
Copyright © 2010 - 2020 Adobe. All Rights Reserved