Top Description Fields Constructors Methods
tools.jackson.databind.deser.jdk

public Class EnumDeserializer

extends StdScalarDeserializer<Object>
Class Inheritance
Annotations
@JacksonStdImpl
Imports
java.util.Objects, .Optional, com.fasterxml.jackson.annotation.JsonFormat, tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.annotation.JacksonStdImpl, tools.jackson.databind.cfg.*, tools.jackson.databind.deser.SettableBeanProperty, .ValueInstantiator, tools.jackson.databind.deser.std.StdScalarDeserializer, tools.jackson.databind.introspect.AnnotatedClass, .AnnotatedMethod, tools.jackson.databind.type.LogicalType, tools.jackson.databind.util.ClassUtil, .CompactStringObjectMap, .EnumResolver

Deserializer class that can deserialize instances of specified Enum class from Strings and Integers.

Field Summary

Modifier and TypeField and Description
protected final Boolean
private final Enum<?>
protected Object[]
protected final boolean
_hasAsValueAnnotation

Marker flag that indicates whether the Enum class has @JsonValue annotated accessor (or equivalent), used to populate _lookupByName.

protected final boolean
_isFromIntValue

Marker flag for cases where we expect actual integral value for Enum, based on @JsonValue (and equivalent) annotated accessor.

protected final CompactStringObjectMap
_lookupByEnumNaming

Look up map with key as Enum.name() converted by EnumNamingStrategy#convertEnumToExternalName(MapperConfig, AnnotatedClass, String) and value as Enums.

protected final CompactStringObjectMap
protected final CompactStringObjectMap
_lookupByToString

Alternatively, we may need a different lookup object if "use toString" is defined.

private Boolean
private Boolean

Constructor Summary

AccessConstructor and Description
public
EnumDeserializer(EnumResolver byNameResolver, boolean caseInsensitive, EnumResolver byEnumNamingResolver, EnumResolver toStringResolver)

protected
EnumDeserializer(EnumDeserializer base, boolean caseInsensitive, Boolean useDefaultValueForUnknownEnum, Boolean useNullForUnknownEnum)

Method Summary

Modifier and TypeMethod and Description
private final Object
protected Object
protected Class<?>
protected Object
protected Object
private CompactStringObjectMap
public ValueDeserializer<?>
createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.

public Object
deserialize(JsonParser p, DeserializationContext ctxt)

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.

public static ValueDeserializer<?>

Returns:

Deserializer based on given factory method
deserializerForCreator
(DeserializationConfig config, Class<?> enumClass, AnnotatedMethod factory, ValueInstantiator valueInstantiator, SettableBeanProperty[] creatorProps, EnumResolver byNameResolver)

Factory method used when Enum instances are to be deserialized using a creator (static factory method)

public static ValueDeserializer<?>

Returns:

Deserializer based on given no-args factory method
deserializerForNoArgsCreator
(DeserializationConfig config, Class<?> enumClass, AnnotatedMethod factory)

Factory method used when Enum instances are to be deserialized using a zero-/no-args factory method

public Object
getEmptyValue(DeserializationContext ctxt)

Overrides tools.jackson.databind.ValueDeserializer.getEmptyValue.

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).

public boolean
isCachable()

Overrides tools.jackson.databind.ValueDeserializer.isCachable.

Because of costs associated with constructing Enum resolvers, let's cache instances by default.

public LogicalType
logicalType()

Overrides tools.jackson.databind.deser.std.StdScalarDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

protected boolean
protected boolean
public EnumDeserializer
withResolved(Boolean caseInsensitive, Boolean useDefaultValueForUnknownEnum, Boolean useNullForUnknownEnum)

Inherited from tools.jackson.databind.deser.std.StdScalarDeserializer:
deserializedeserializeWithTypegetEmptyAccessPatterngetNullAccessPatternsupportsUpdate

Field Detail

_caseInsensitiveback to summary
protected final Boolean _caseInsensitive
_enumDefaultValueback to summary
private final Enum<?> _enumDefaultValue
_enumsByIndexback to summary
protected Object[] _enumsByIndex
_hasAsValueAnnotationback to summary
protected final boolean _hasAsValueAnnotation

Marker flag that indicates whether the Enum class has @JsonValue annotated accessor (or equivalent), used to populate _lookupByName.

Since
2.20
_isFromIntValueback to summary
protected final boolean _isFromIntValue

Marker flag for cases where we expect actual integral value for Enum, based on @JsonValue (and equivalent) annotated accessor.

_lookupByEnumNamingback to summary
protected final CompactStringObjectMap _lookupByEnumNaming

Look up map with key as Enum.name() converted by EnumNamingStrategy#convertEnumToExternalName(MapperConfig, AnnotatedClass, String) and value as Enums.

_lookupByNameback to summary
protected final CompactStringObjectMap _lookupByName
_lookupByToStringback to summary
protected final CompactStringObjectMap _lookupByToString

Alternatively, we may need a different lookup object if "use toString" is defined.

_useDefaultValueForUnknownEnumback to summary
private Boolean _useDefaultValueForUnknownEnum
_useNullForUnknownEnumback to summary
private Boolean _useNullForUnknownEnum

Constructor Detail

EnumDeserializerback to summary
public EnumDeserializer(EnumResolver byNameResolver, boolean caseInsensitive, EnumResolver byEnumNamingResolver, EnumResolver toStringResolver)
EnumDeserializerback to summary
protected EnumDeserializer(EnumDeserializer base, boolean caseInsensitive, Boolean useDefaultValueForUnknownEnum, Boolean useNullForUnknownEnum)

Method Detail

_deserializeAltStringback to summary
private final Object _deserializeAltString(JsonParser p, DeserializationContext ctxt, CompactStringObjectMap lookup, String nameOrig) throws JacksonException
_deserializeOtherback to summary
protected Object _deserializeOther(JsonParser p, DeserializationContext ctxt) throws JacksonException
_enumClassback to summary
protected Class<?> _enumClass()
_fromIntegerback to summary
protected Object _fromInteger(JsonParser p, DeserializationContext ctxt, int index) throws JacksonException
_fromStringback to summary
protected Object _fromString(JsonParser p, DeserializationContext ctxt, String text) throws JacksonException
_resolveCurrentLookupback to summary
private CompactStringObjectMap _resolveCurrentLookup(DeserializationContext ctxt)
createContextualback to summary
public ValueDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Doc from tools.jackson.databind.ValueDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Annotations
@Override
deserializeback to summary
public Object deserialize(JsonParser p, DeserializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles. Returned instance is to be constructed by method itself.

Pre-condition for this method is that the parser points to the first event that is part of value to deserializer (and which is never JSON 'null' literal, more on this below): for simple types it may be the only value; and for structured types the Object start marker or a FIELD_NAME.

The two possible input conditions for structured types result from polymorphism via fields. In the ordinary case, Jackson calls this method when it has encountered an OBJECT_START, and the method implementation must advance to the next token to see the first field name. If the application configures polymorphism via a field, then the object looks like the following.

      {
          "@class": "class name",
          ...
      }
  
Jackson consumes the two tokens (the @class field name and its value) in order to learn the class and select the deserializer. Thus, the stream is pointing to the FIELD_NAME for the first field after the @class. Thus, if you want your method to work correctly both with and without polymorphism, you must begin your method with:
       if (p.currentToken() == JsonToken.START_OBJECT) {
         p.nextToken();
       }
  
This results in the stream pointing to the field name, so that the two conditions align.

Post-condition is that the parser will point to the last event that is part of deserialized value (or in case deserialization fails, event that was not recognized or usable, which may be the same event as the one it pointed to upon call).

Handling null values (JsonToken.VALUE_NULL)
: Note that this method is never called for the JSON null literal to avoid every deserializer from having to handle null values. Instead, the ValueDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override ValueDeserializer#getNullValue(DeserializationContext) and usually also ValueDeserializer#getNullAccessPattern().

Annotations
@Override
deserializerForCreatorback to summary
public static ValueDeserializer<?> deserializerForCreator(DeserializationConfig config, Class<?> enumClass, AnnotatedMethod factory, ValueInstantiator valueInstantiator, SettableBeanProperty[] creatorProps, EnumResolver byNameResolver)

Factory method used when Enum instances are to be deserialized using a creator (static factory method)

Returns:ValueDeserializer<?>

Deserializer based on given factory method

deserializerForNoArgsCreatorback to summary
public static ValueDeserializer<?> deserializerForNoArgsCreator(DeserializationConfig config, Class<?> enumClass, AnnotatedMethod factory)

Factory method used when Enum instances are to be deserialized using a zero-/no-args factory method

Returns:ValueDeserializer<?>

Deserializer based on given no-args factory method

getEmptyValueback to summary
public Object getEmptyValue(DeserializationContext ctxt)

Overrides tools.jackson.databind.ValueDeserializer.getEmptyValue.

Doc from tools.jackson.databind.ValueDeserializer.getEmptyValue.

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings). Usually this is same as getNullValue (which in turn is usually simply Java null), but it can be overridden for specific types. Or, if type should never be converted from empty String, method can also throw an exception.

This method may be called once, or multiple times, depending on what getEmptyAccessPattern() returns.

Default implementation simply calls getNullValue and returns value.

Annotations
@Override
isCachableback to summary
public boolean isCachable()

Overrides tools.jackson.databind.ValueDeserializer.isCachable.

Because of costs associated with constructing Enum resolvers, let's cache instances by default.

Annotations
@Override
logicalTypeback to summary
public LogicalType logicalType()

Overrides tools.jackson.databind.deser.std.StdScalarDeserializer.logicalType.

Doc from tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces. Typically used for further configuring handling of values, for example, to find which coercions are legal.

Annotations
@Override
useDefaultValueForUnknownEnumback to summary
protected boolean useDefaultValueForUnknownEnum(DeserializationContext ctxt)
useNullForUnknownEnumback to summary
protected boolean useNullForUnknownEnum(DeserializationContext ctxt)
withResolvedback to summary
public EnumDeserializer withResolved(Boolean caseInsensitive, Boolean useDefaultValueForUnknownEnum, Boolean useNullForUnknownEnum)