public class EnumMapSerializer extends ContainerSerializer<EnumMap<? extends Enum<?>,?>> implements ContextualSerializer
EnumMaps. Somewhat tricky to
implement because actual Enum value type may not be available;
and if not, it can only be gotten from actual instance.JsonSerializer.None| Modifier and Type | Field and Description |
|---|---|
protected EnumValues |
_keyEnums
If we know enumeration used as key, this will contain
value set to use for serialization
|
protected BeanProperty |
_property
Property for which this serializer is being used, if any;
null for root values.
|
protected boolean |
_staticTyping |
protected JsonSerializer<Object> |
_valueSerializer
Value serializer to use, if it can be statically determined
|
protected JavaType |
_valueType |
protected TypeSerializer |
_valueTypeSerializer
Type serializer used for values, if any.
|
_handledType| Constructor and Description |
|---|
EnumMapSerializer(EnumMapSerializer src,
BeanProperty property,
JsonSerializer<?> ser)
Constructor called when a contextual instance is created.
|
EnumMapSerializer(JavaType valueType,
boolean staticTyping,
EnumValues keyEnums,
TypeSerializer vts,
JsonSerializer<Object> valueSerializer) |
| Modifier and Type | Method and Description |
|---|---|
EnumMapSerializer |
_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. |
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
We consider possibility here that an EnumMap might actually just be serialized
as something like a Record, given that number of keys is bound, just like
with Objects/Records (and not unbounded like regular maps)
|
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.
|
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint)
Default implementation simply claims type is "string"; usually
overriden by custom serializers.
|
boolean |
hasSingleElement(EnumMap<? extends Enum<?>,?> value)
Method called to determine if the given value (of type handled by
this serializer) contains exactly one element.
|
boolean |
isEmpty(EnumMap<? extends Enum<?>,?> value)
Method called to check whether given serializable value is
considered "empty" value (for purposes of suppressing serialization
of empty values).
|
void |
serialize(EnumMap<? extends Enum<?>,?> value,
JsonGenerator jgen,
SerializerProvider provider)
Method that can be called to ask implementation to serialize
values of type this serializer handles.
|
protected void |
serializeContents(EnumMap<? extends Enum<?>,?> value,
JsonGenerator jgen,
SerializerProvider provider) |
protected void |
serializeContentsUsing(EnumMap<? extends Enum<?>,?> value,
JsonGenerator jgen,
SerializerProvider provider,
JsonSerializer<Object> valueSer) |
void |
serializeWithType(EnumMap<? extends Enum<?>,?> value,
JsonGenerator jgen,
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.
|
EnumMapSerializer |
withValueSerializer(BeanProperty prop,
JsonSerializer<?> ser) |
hasContentTypeAnnotation, withValueTypeSerializercreateObjectNode, createSchemaNode, createSchemaNode, findConvertingContentSerializer, findPropertyFilter, getSchema, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrowgetDelegatee, isUnwrappingSerializer, replaceDelegatee, unwrappingSerializer, usesObjectIdprotected final boolean _staticTyping
protected final BeanProperty _property
protected final EnumValues _keyEnums
protected final JavaType _valueType
protected final JsonSerializer<Object> _valueSerializer
protected final TypeSerializer _valueTypeSerializer
public EnumMapSerializer(JavaType valueType, boolean staticTyping, EnumValues keyEnums, TypeSerializer vts, JsonSerializer<Object> valueSerializer)
public EnumMapSerializer(EnumMapSerializer src, BeanProperty property, JsonSerializer<?> ser)
public EnumMapSerializer _withValueTypeSerializer(TypeSerializer vts)
ContainerSerializerTypeSerializer, used when
addition type information is to be embedded._withValueTypeSerializer in class ContainerSerializer<EnumMap<? extends Enum<?>,?>>public EnumMapSerializer withValueSerializer(BeanProperty prop, JsonSerializer<?> ser)
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException
ContextualSerializercreateContextual in interface ContextualSerializerprovider - 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 can not provide it and
null is passed instead (in which case impls usually pass 'this' serializer as is)JsonMappingExceptionpublic JavaType getContentType()
ContainerSerializergetContentType in class ContainerSerializer<EnumMap<? extends Enum<?>,?>>public JsonSerializer<?> getContentSerializer()
ContainerSerializerContainerSerializer.getContentType() and
SerializerProvider.findValueSerializer(java.lang.Class<?>, com.fasterxml.jackson.databind.BeanProperty).getContentSerializer in class ContainerSerializer<EnumMap<? extends Enum<?>,?>>public boolean isEmpty(EnumMap<? extends Enum<?>,?> value)
JsonSerializerDefault implementation will consider only null values to be empty.
isEmpty in class ContainerSerializer<EnumMap<? extends Enum<?>,?>>public boolean hasSingleElement(EnumMap<? extends Enum<?>,?> value)
ContainerSerializerNote: 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).
hasSingleElement in class ContainerSerializer<EnumMap<? extends Enum<?>,?>>public void serialize(EnumMap<? extends Enum<?>,?> value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException
JsonSerializerserialize in class StdSerializer<EnumMap<? extends Enum<?>,?>>value - Value to serialize; can not be null.jgen - Generator used to output resulting Json contentprovider - Provider that can be used to get serializers for
serializing Objects value contains, if any.IOExceptionJsonGenerationExceptionpublic void serializeWithType(EnumMap<? extends Enum<?>,?> value, JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer) throws IOException, JsonGenerationException
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, jgen); serialize(value, jgen, provider); typeSer.writeTypeSuffixForScalar(value, jgen);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<EnumMap<? extends Enum<?>,?>>value - Value to serialize; can not be null.jgen - 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 informationIOExceptionJsonGenerationExceptionprotected void serializeContents(EnumMap<? extends Enum<?>,?> value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException
IOExceptionJsonGenerationExceptionprotected void serializeContentsUsing(EnumMap<? extends Enum<?>,?> value, JsonGenerator jgen, SerializerProvider provider, JsonSerializer<Object> valueSer) throws IOException, JsonGenerationException
IOExceptionJsonGenerationExceptionpublic JsonNode getSchema(SerializerProvider provider, Type typeHint) throws JsonMappingException
StdSerializergetSchema in interface SchemaAwaregetSchema in class StdSerializer<EnumMap<? extends Enum<?>,?>>provider - The serializer provider.typeHint - A hint about the type.JsonMappingExceptionpublic void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
acceptJsonFormatVisitor in interface JsonFormatVisitableacceptJsonFormatVisitor in class StdSerializer<EnumMap<? extends Enum<?>,?>>typeHint - Type of element (entity like property) being visitedJsonMappingExceptionCopyright © 2014 FasterXML. All Rights Reserved.