public class EnumSerializer extends StdScalarSerializer<Enum<?>> implements ContextualSerializer
Enum types.
Based on StdScalarSerializer since the JSON value is
scalar (String).
JsonSerializer.None| Modifier and Type | Field and Description |
|---|---|
protected Boolean |
_serializeAsIndex
Flag that is set if we statically know serialization choice
between index and textual format (null if it needs to be dynamically
checked).
|
protected EnumValues |
_values
This map contains pre-resolved values (since there are ways
to customize actual String constants to use) to use as
serializations.
|
protected EnumValues |
_valuesByEnumNaming
Map with key as converted property class defined implementation of
EnumNamingStrategy
and with value as Enum names collected using Enum.name(). |
_handledType| Constructor and Description |
|---|
EnumSerializer(EnumValues v,
Boolean serializeAsIndex) |
EnumSerializer(EnumValues v,
Boolean serializeAsIndex,
EnumValues valuesByEnumNaming) |
| Modifier and Type | Method and Description |
|---|---|
protected static Boolean |
_isShapeWrittenUsingIndex(Class<?> enumClass,
JsonFormat.Value format,
boolean fromClass,
Boolean defaultValue)
Helper method called to check whether serialization should be done using
index (number) or not.
|
protected boolean |
_serializeAsIndex(SerializerProvider serializers) |
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
Default implementation specifies no format.
|
static EnumSerializer |
construct(Class<?> enumClass,
SerializationConfig config,
BeanDescription beanDesc,
JsonFormat.Value format)
Factory method used by
BasicSerializerFactory
for constructing serializer instance of Enum types. |
protected static EnumValues |
constructEnumNamingStrategyValues(SerializationConfig config,
Class<Enum<?>> enumClass,
AnnotatedClass annotatedClass)
Factory method used to resolve an instance of
EnumValues
with EnumNamingStrategy applied for the target class. |
JsonSerializer<?> |
createContextual(SerializerProvider serializers,
BeanProperty property)
To support some level of per-property configuration, we will need
to make things contextual.
|
EnumValues |
getEnumValues() |
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint)
Deprecated.
Since 2.15
|
void |
serialize(Enum<?> en,
JsonGenerator gen,
SerializerProvider serializers)
Method that can be called to ask implementation to serialize
values of type this serializer handles.
|
serializeWithType_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrowgetDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterIdprotected final EnumValues _values
protected final Boolean _serializeAsIndex
protected final EnumValues _valuesByEnumNaming
EnumNamingStrategy
and with value as Enum names collected using Enum.name().public EnumSerializer(EnumValues v, Boolean serializeAsIndex)
public EnumSerializer(EnumValues v, Boolean serializeAsIndex, EnumValues valuesByEnumNaming)
public static EnumSerializer construct(Class<?> enumClass, SerializationConfig config, BeanDescription beanDesc, JsonFormat.Value format)
BasicSerializerFactory
for constructing serializer instance of Enum types.public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException
createContextual in interface ContextualSerializerserializers - 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)JsonMappingExceptionpublic EnumValues getEnumValues()
public final void serialize(Enum<?> en, JsonGenerator gen, SerializerProvider serializers) throws IOException
JsonSerializerserialize in class StdSerializer<Enum<?>>en - Value to serialize; can not be null.gen - Generator used to output resulting Json contentserializers - Provider that can be used to get serializers for
serializing Objects value contains, if any.IOException@Deprecated public JsonNode getSchema(SerializerProvider provider, Type typeHint)
StdSerializergetSchema in interface SchemaAwaregetSchema in class StdScalarSerializer<Enum<?>>provider - The serializer provider.typeHint - A hint about the type.public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
StdSerializeracceptJsonFormatVisitor in interface JsonFormatVisitableacceptJsonFormatVisitor in class StdScalarSerializer<Enum<?>>typeHint - Type of element (entity like property) being visitedJsonMappingExceptionprotected final boolean _serializeAsIndex(SerializerProvider serializers)
protected static Boolean _isShapeWrittenUsingIndex(Class<?> enumClass, JsonFormat.Value format, boolean fromClass, Boolean defaultValue)
protected static EnumValues constructEnumNamingStrategyValues(SerializationConfig config, Class<Enum<?>> enumClass, AnnotatedClass annotatedClass)
EnumValues
with EnumNamingStrategy applied for the target class.Copyright © 2008–2023 FasterXML. All rights reserved.