Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.ser.std

public Class EnumSerializer

extends StdScalarSerializer<Enum<?>>
implements ContextualSerializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.ser.ContextualSerializer
Annotations
@JacksonStdImpl
Imports
java.io.IOException, java.lang.reflect.Type, java.util.LinkedHashSet, .Set, .Objects, com.fasterxml.jackson.annotation.JsonFormat, .JsonFormat.Shape, com.fasterxml.jackson.core.*, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.annotation.JacksonStdImpl, com.fasterxml.jackson.databind.introspect.AnnotatedClass, .EnumNamingStrategyFactory, com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper, .JsonStringFormatVisitor, com.fasterxml.jackson.databind.node.ArrayNode, .ObjectNode, com.fasterxml.jackson.databind.ser.ContextualSerializer, com.fasterxml.jackson.databind.util.EnumValues

Deprecated

as a consequence of StdScalarSerializer being deprecated. See corresponding docs for further information.

Standard serializer used for java.lang.Enum types.

Based on StdScalarSerializer since the JSON value is scalar (String).

Field Summary

Modifier and TypeField and Description
protected final 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 final EnumValues
_values

This map contains pre-resolved values (since there are ways to customize actual String constants to use) to use as serializations.

protected final EnumValues
_valuesByEnumNaming

Map with key as converted property class defined implementation of EnumNamingStrategy and with value as Enum names collected using Enum.name().

protected final EnumValues
private static final long

Constructor Summary

AccessConstructor and Description
public
EnumSerializer(EnumValues v, Boolean serializeAsIndex)

Deprecated Since 2.16
public
EnumSerializer(EnumValues v, Boolean serializeAsIndex, EnumValues valuesByEnumNaming)

Deprecated Since 2.16
public
EnumSerializer(EnumValues v, Boolean serializeAsIndex, EnumValues valuesByEnumNaming, EnumValues valuesByToString)

Method Summary

Modifier and TypeMethod 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 final boolean
public void
public static EnumSerializer
construct(Class<?> enumClass, SerializationConfig config, BeanDescription beanDesc, JsonFormat.Value format)

Deprecated as a consequence of EnumSerializer being deprecated.
Factory method used by com.fasterxml.jackson.databind.ser.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.

public JsonSerializer<?>
createContextual(SerializerProvider
Serializer provider to use for accessing config, other serializers
serializers
,
BeanProperty
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)
property
)

Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

To support some level of per-property configuration, we will need to make things contextual.
public EnumValues
public JsonNode
getSchema(SerializerProvider
The serializer provider.
provider
,
Type
A hint about the type.
typeHint
)

Overrides com.fasterxml.jackson.databind.ser.std.StdScalarSerializer.getSchema.

Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Deprecated Since 2.15
Default implementation simply claims type is "string"; usually overriden by custom serializers.
public final void
serialize(Enum<?>
Value to serialize; can not be null.
en
,
JsonGenerator
Generator used to output resulting Json content
gen
,
SerializerProvider
Provider that can be used to get serializers for serializing Objects value contains, if any.
serializers
)

Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.
Inherited from com.fasterxml.jackson.databind.ser.std.StdScalarSerializer:
serializeWithType

Field Detail

_serializeAsIndexback to summary
protected final 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).

Since
2.1
_valuesback to summary
protected final EnumValues _values

This map contains pre-resolved values (since there are ways to customize actual String constants to use) to use as serializations.

_valuesByEnumNamingback to summary
protected final EnumValues _valuesByEnumNaming

Map with key as converted property class defined implementation of EnumNamingStrategy and with value as Enum names collected using Enum.name().

Since
2.15
_valuesByToStringback to summary
protected final EnumValues _valuesByToString

Map that contains pre-resolved values for Enum#toString to use for serialization, while respecting com.fasterxml.jackson.annotation.JsonProperty and com.fasterxml.jackson.databind.cfg.EnumFeature#WRITE_ENUMS_TO_LOWERCASE.

Since
2.16
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

Constructor Detail

EnumSerializerback to summary
public EnumSerializer(EnumValues v, Boolean serializeAsIndex)

Deprecated

Since 2.16

Annotations
@Deprecated
EnumSerializerback to summary
public EnumSerializer(EnumValues v, Boolean serializeAsIndex, EnumValues valuesByEnumNaming)

Deprecated

Since 2.16

Annotations
@Deprecated
Since
2.15
EnumSerializerback to summary
public EnumSerializer(EnumValues v, Boolean serializeAsIndex, EnumValues valuesByEnumNaming, EnumValues valuesByToString)
Since
2.16

Method Detail

_isShapeWrittenUsingIndexback to summary
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.

_serializeAsIndexback to summary
protected final boolean _serializeAsIndex(SerializerProvider serializers)
acceptJsonFormatVisitorback to summary
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.ser.std.StdScalarSerializer.acceptJsonFormatVisitor.

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Doc from com.fasterxml.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor.

Default implementation specifies no format. This behavior is usually overriden by custom serializers.

Parameters
typeHint:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Type of element (entity like property) being visited

Annotations
@Override
constructback to summary
public static EnumSerializer construct(Class<?> enumClass, SerializationConfig config, BeanDescription beanDesc, JsonFormat.Value format)

Deprecated

as a consequence of EnumSerializer being deprecated. See corresponding docs for further information.

Factory method used by com.fasterxml.jackson.databind.ser.BasicSerializerFactory for constructing serializer instance of Enum types.

Annotations
@SuppressWarnings:unchecked
Since
2.1
constructEnumNamingStrategyValuesback to summary
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.

Since
2.15
createContextualback to summary
public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

To support some level of per-property configuration, we will need to make things contextual. We are limited to "textual vs index" choice here, however.

Parameters
serializers:SerializerProvider

Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Serializer provider to use for accessing config, other serializers

property:BeanProperty

Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

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)

Returns:JsonSerializer<?>

Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Serializer to use for serializing values of specified property; may be this instance or a new instance.

Annotations
@Override
getEnumValuesback to summary
public EnumValues getEnumValues()
getSchemaback to summary
public JsonNode getSchema(SerializerProvider provider, Type typeHint)

Overrides com.fasterxml.jackson.databind.ser.std.StdScalarSerializer.getSchema.

Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Doc from com.fasterxml.jackson.databind.ser.std.StdSerializer.getSchema.

Deprecated

Since 2.15

Default implementation simply claims type is "string"; usually overriden by custom serializers.

Parameters
provider:SerializerProvider

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

The serializer provider.

typeHint:Type

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

A hint about the type.

Returns:JsonNode

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Json-schema for this serializer.

Annotations
@Deprecated
@Override
serializeback to summary
public final void serialize(Enum<?> en, JsonGenerator gen, SerializerProvider serializers) throws IOException

Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

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

Parameters
en:Enum<?>

Value to serialize; can not be null.

gen:JsonGenerator

Generator used to output resulting Json content

serializers:SerializerProvider

Provider that can be used to get serializers for serializing Objects value contains, if any.

Annotations
@Override