Class EnumResolver
- java.lang.Object
-
- com.fasterxml.jackson.databind.util.EnumResolver
-
- All Implemented Interfaces:
java.io.Serializable
public class EnumResolver extends java.lang.Object implements java.io.SerializableHelper 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 java.lang.Enum<?>_defaultValueprotected java.lang.Class<java.lang.Enum<?>>_enumClassprotected java.lang.Enum<?>[]_enumsprotected java.util.HashMap<java.lang.String,java.lang.Enum<?>>_enumsByIdprotected boolean_hasAsValueAnnotationMarker for case where enum values to match are from@JsonValue-annotated method.protected boolean_isFromIntValueMarker for case where value may come from@JsonValueannotated accessor and is expected/likely to come from actual integral number value (and not String).protected boolean_isIgnoreCaseMarker for case-insensitive handlingprivate static longserialVersionUID
-
Constructor Summary
Constructors Modifier Constructor Description protectedEnumResolver(java.lang.Class<java.lang.Enum<?>> enumClass, java.lang.Enum<?>[] enums, java.util.HashMap<java.lang.String,java.lang.Enum<?>> map, java.lang.Enum<?> defaultValue, boolean isIgnoreCase, boolean isFromIntValue)Deprecated.Since 2.20; use variant that also takeshasAsValueAnnotationargumentprotectedEnumResolver(java.lang.Class<java.lang.Enum<?>> enumClass, java.lang.Enum<?>[] enums, java.util.HashMap<java.lang.String,java.lang.Enum<?>> map, java.lang.Enum<?> defaultValue, boolean isIgnoreCase, boolean isFromIntValue, boolean hasAsValueAnnotation)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static java.lang.Class<java.lang.Enum<?>>_enumClass(java.lang.Class<?> enumCls0)protected static java.lang.Enum<?>[]_enumConstants(java.lang.Class<?> enumCls)protected static java.lang.Enum<?>_enumDefault(AnnotationIntrospector intr, AnnotatedClass annotatedClass, java.lang.Enum<?>[] enums)Internal helper method used to resolve Enum default value to use (if any).protected java.lang.Enum<?>_findEnumCaseInsensitive(java.lang.String key)protected static boolean_isIntType(java.lang.Class<?> erasedType)static EnumResolverconstructFor(DeserializationConfig config, AnnotatedClass annotatedClass)Factory method for constructing anEnumResolverbased on the givenDeserializationConfigandAnnotatedClassof the enum to be resolved.CompactStringObjectMapconstructLookup()static EnumResolverconstructUsingEnumNamingStrategy(DeserializationConfig config, AnnotatedClass annotatedClass, EnumNamingStrategy enumNamingStrategy)Factory method for constructing anEnumResolverwithEnumNamingStrategyapplied.static EnumResolverconstructUsingIndex(DeserializationConfig config, AnnotatedClass annotatedClass)Factory method for constructing resolver that maps from index of Enum.values() into Enum value.static EnumResolverconstructUsingMethod(DeserializationConfig config, AnnotatedClass annotatedClass, AnnotatedMember accessor)Method used when actual String serialization is indicated using @JsonValue on a method in Enum class.static EnumResolverconstructUsingToString(DeserializationConfig config, AnnotatedClass annotatedClass)Factory method for constructing resolver that maps from Enum.toString() into Enum valuejava.lang.Enum<?>findEnum(java.lang.String key)java.lang.Enum<?>getDefaultValue()java.lang.Enum<?>getEnum(int index)java.lang.Class<java.lang.Enum<?>>getEnumClass()java.util.Collection<java.lang.String>getEnumIds()java.util.List<java.lang.Enum<?>>getEnums()java.lang.Enum<?>[]getRawEnums()booleanhasAsValueAnnotation()Accessor for checking whether@JsonValueannotated accessor is used to get enum values to use for deserialization.booleanisFromIntValue()Accessor for checking if we have a special case in which value to map is from@JsonValueannotated 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 toEnum.index().intlastValidIndex()
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
_enumClass
protected final java.lang.Class<java.lang.Enum<?>> _enumClass
-
_enums
protected final java.lang.Enum<?>[] _enums
-
_enumsById
protected final java.util.HashMap<java.lang.String,java.lang.Enum<?>> _enumsById
-
_defaultValue
protected final java.lang.Enum<?> _defaultValue
-
_isIgnoreCase
protected final boolean _isIgnoreCase
Marker for case-insensitive handling- Since:
- 2.12
-
_isFromIntValue
protected final boolean _isFromIntValue
Marker for case where value may come from@JsonValueannotated 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.- Since:
- 2.13
-
_hasAsValueAnnotation
protected final boolean _hasAsValueAnnotation
Marker for case where enum values to match are from@JsonValue-annotated method.- Since:
- 2.20
-
-
Constructor Detail
-
EnumResolver
protected EnumResolver(java.lang.Class<java.lang.Enum<?>> enumClass, java.lang.Enum<?>[] enums, java.util.HashMap<java.lang.String,java.lang.Enum<?>> map, java.lang.Enum<?> defaultValue, boolean isIgnoreCase, boolean isFromIntValue, boolean hasAsValueAnnotation)- Since:
- 2.20
-
EnumResolver
@Deprecated protected EnumResolver(java.lang.Class<java.lang.Enum<?>> enumClass, java.lang.Enum<?>[] enums, java.util.HashMap<java.lang.String,java.lang.Enum<?>> map, java.lang.Enum<?> defaultValue, boolean isIgnoreCase, boolean isFromIntValue)Deprecated.Since 2.20; use variant that also takeshasAsValueAnnotationargument- Since:
- 2.12
-
-
Method Detail
-
constructFor
public static EnumResolver constructFor(DeserializationConfig config, AnnotatedClass annotatedClass)
Factory method for constructing anEnumResolverbased on the givenDeserializationConfigandAnnotatedClassof the enum to be resolved.- Parameters:
config- the deserialization configuration to useannotatedClass- the annotated class of the enum to be resolved- Returns:
- the constructed
EnumResolver - Since:
- 2.16
-
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.- Since:
- 2.16
-
constructUsingEnumNamingStrategy
public static EnumResolver constructUsingEnumNamingStrategy(DeserializationConfig config, AnnotatedClass annotatedClass, EnumNamingStrategy enumNamingStrategy)
Factory method for constructing anEnumResolverwithEnumNamingStrategyapplied.- 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.- Since:
- 2.16
-
constructLookup
public CompactStringObjectMap constructLookup()
-
_enumClass
protected static java.lang.Class<java.lang.Enum<?>> _enumClass(java.lang.Class<?> enumCls0)
-
_enumConstants
protected static java.lang.Enum<?>[] _enumConstants(java.lang.Class<?> enumCls)
-
_enumDefault
protected static java.lang.Enum<?> _enumDefault(AnnotationIntrospector intr, AnnotatedClass annotatedClass, java.lang.Enum<?>[] enums)
Internal helper method used to resolve Enum default value to use (if any).- Since:
- 2.16
- See Also:
AnnotationIntrospector.findDefaultEnumValue(AnnotatedClass, Enum[])
-
_isIntType
protected static boolean _isIntType(java.lang.Class<?> erasedType)
-
findEnum
public java.lang.Enum<?> findEnum(java.lang.String key)
-
_findEnumCaseInsensitive
protected java.lang.Enum<?> _findEnumCaseInsensitive(java.lang.String key)
-
getEnum
public java.lang.Enum<?> getEnum(int index)
-
getDefaultValue
public java.lang.Enum<?> getDefaultValue()
-
getRawEnums
public java.lang.Enum<?>[] getRawEnums()
-
getEnums
public java.util.List<java.lang.Enum<?>> getEnums()
-
getEnumIds
public java.util.Collection<java.lang.String> getEnumIds()
- Since:
- 2.7.3
-
getEnumClass
public java.lang.Class<java.lang.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@JsonValueannotated 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 toEnum.index().- Since:
- 2.13
-
hasAsValueAnnotation
public boolean hasAsValueAnnotation()
Accessor for checking whether@JsonValueannotated accessor is used to get enum values to use for deserialization.- Since:
- 2.20
-
-