Module tools.jackson.databind

Package tools.jackson.databind.util

Class EnumResolver

java.lang.Object

tools.jackson.databind.util.EnumResolver

All Implemented Interfaces:

Serializable

public class EnumResolver
extends Object
implements Serializable

Helper class used to resolve String values (either JSON Object field names or regular String values) into Java Enum instances.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Enum<?>	_defaultValue
protected final Class<Enum<?>>	_enumClass
protected final Enum<?>[]	_enums
protected final HashMap<String,Enum<?>>	_enumsById
protected final boolean	_hasAsValueAnnotation	Marker for case where enum values to match are from @JsonValue-annotated method.
protected final boolean	_isFromIntValue	Marker for case where value may come from @JsonValue annotated accessor and is expected/likely to come from actual integral number value (and not String).
protected final boolean	_isIgnoreCase	Marker for case-insensitive handling

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EnumResolver(Class<Enum<?>> enumClass, Enum<?>[] enums, HashMap<String,Enum<?>> enumsById, Enum<?> defaultValue, boolean isIgnoreCase, boolean isFromIntValue, boolean hasAsValueAnnotation)

Method Summary

Modifier and Type	Method	Description
protected static Class<Enum<?>>	_enumClass(Class<?> cls)
protected static Enum<?>[]	_enumConstants(Class<Enum<?>> enumCls)
protected static Enum<?>	_enumDefault(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enums)	Internal helper method used to resolve JsonEnumDefaultValue
protected static boolean	_isIntType(Class<?> erasedType)
static EnumResolver	constructFor(DeserializationConfig config, AnnotatedClass annotatedClass)	Factory method for constructing an EnumResolver based on the given DeserializationConfig and AnnotatedClass of the enum to be resolved.
CompactStringObjectMap	constructLookup()
static EnumResolver	constructUsingEnumNamingStrategy(DeserializationConfig config, AnnotatedClass annotatedClass, EnumNamingStrategy enumNamingStrategy)	Factory method for constructing an EnumResolver with EnumNamingStrategy applied.
static EnumResolver	constructUsingIndex(DeserializationConfig config, AnnotatedClass annotatedClass)	Factory method for constructing resolver that maps from index of Enum.values() into Enum value.
static EnumResolver	constructUsingMethod(DeserializationConfig config, AnnotatedClass annotatedClass, AnnotatedMember accessor)	Method used when actual String serialization is indicated using @JsonValue on a method in Enum class.
static EnumResolver	constructUsingToString(DeserializationConfig config, AnnotatedClass annotatedClass)	Factory method for constructing resolver that maps from Enum.toString() into Enum value
Enum<?>	findEnum(String key)
Enum<?>	getDefaultValue()
Enum<?>	getEnum(int index)
Class<Enum<?>>	getEnumClass()
Collection<String>	getEnumIds()
List<Enum<?>>	getEnums()
Enum<?>[]	getRawEnums()
boolean	hasAsValueAnnotation()	Accessor for checking whether @JsonValue annotated accessor is used to get enum values to use for deserialization.
boolean	isFromIntValue()	Accessor for checking if we have a special case in which value to map is from @JsonValue annotated accessor with integral type: this matters for cases where incoming content value is of integral type and should be mapped to specific value and NOT to Enum.index().
int	lastValidIndex()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_enumClass

protected final Class<Enum<?>> _enumClass

_enums

protected final Enum<?>[] _enums

_enumsById

protected final HashMap<String,Enum<?>> _enumsById

_defaultValue

protected final Enum<?> _defaultValue

_isIgnoreCase

protected final boolean _isIgnoreCase

Marker for case-insensitive handling

_isFromIntValue

protected final boolean _isFromIntValue

Marker for case where value may come from @JsonValue annotated accessor and is expected/likely to come from actual integral number value (and not String).

Special case is needed since this specifically means that Enum.index() should NOT be used or default to.

_hasAsValueAnnotation

protected final boolean _hasAsValueAnnotation

Marker for case where enum values to match are from @JsonValue-annotated method.

Since:

2.20

Constructor Details

EnumResolver

protected EnumResolver(Class<Enum<?>> enumClass,
 Enum<?>[] enums,
 HashMap<String,Enum<?>> enumsById,
 Enum<?> defaultValue,
 boolean isIgnoreCase,
 boolean isFromIntValue,
 boolean hasAsValueAnnotation)

Method Details

constructFor

public static EnumResolver constructFor(DeserializationConfig config,
 AnnotatedClass annotatedClass)

Factory method for constructing an EnumResolver based on the given DeserializationConfig and AnnotatedClass of the enum to be resolved.

Parameters:

config - the deserialization configuration to use

annotatedClass - the annotated class of the enum to be resolved

Returns:

the constructed EnumResolver

constructUsingToString

public static EnumResolver constructUsingToString(DeserializationConfig config,
 AnnotatedClass annotatedClass)

Factory method for constructing resolver that maps from Enum.toString() into Enum value

Since:

2.16

constructUsingIndex

public static EnumResolver constructUsingIndex(DeserializationConfig config,
 AnnotatedClass annotatedClass)

Factory method for constructing resolver that maps from index of Enum.values() into Enum value.

constructUsingEnumNamingStrategy

public static EnumResolver constructUsingEnumNamingStrategy(DeserializationConfig config,
 AnnotatedClass annotatedClass,
 EnumNamingStrategy enumNamingStrategy)

Factory method for constructing an EnumResolver with EnumNamingStrategy applied.

Since:

2.16

constructUsingMethod

public static EnumResolver constructUsingMethod(DeserializationConfig config,
 AnnotatedClass annotatedClass,
 AnnotatedMember accessor)

Method used when actual String serialization is indicated using @JsonValue on a method in Enum class.

_enumClass

protected static Class<Enum<?>> _enumClass(Class<?> cls)

_enumConstants

protected static Enum<?>[] _enumConstants(Class<Enum<?>> enumCls)

constructLookup

public CompactStringObjectMap constructLookup()

_enumDefault

protected static Enum<?> _enumDefault(MapperConfig<?> config,
 AnnotatedClass annotatedClass,
 Enum<?>[] enums)

Internal helper method used to resolve JsonEnumDefaultValue

Since:

2.16

_isIntType

protected static boolean _isIntType(Class<?> erasedType)

findEnum

public Enum<?> findEnum(String key)

getEnum

public Enum<?> getEnum(int index)

getDefaultValue

public Enum<?> getDefaultValue()

getRawEnums

public Enum<?>[] getRawEnums()

getEnums

public List<Enum<?>> getEnums()

getEnumIds

public Collection<String> getEnumIds()

getEnumClass

public Class<Enum<?>> getEnumClass()

lastValidIndex

public int lastValidIndex()

isFromIntValue

public boolean isFromIntValue()

Accessor for checking if we have a special case in which value to map is from @JsonValue annotated accessor with integral type: this matters for cases where incoming content value is of integral type and should be mapped to specific value and NOT to Enum.index().

hasAsValueAnnotation

public boolean hasAsValueAnnotation()

Accessor for checking whether @JsonValue annotated accessor is used to get enum values to use for deserialization.