Jackson 3.0.1 · tools.jackson.databind.util.EnumResolver

Field Summary

Modifier and Type	Field and 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
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and 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 and 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 `com.fasterxml.jackson.annotation.JsonEnumDefaultValue`
private final Enum<?>	_findEnumIgnoreCase(final String key)
protected static boolean	_isIntType(Class<?> erasedType)
public static EnumResolver	Returns: the constructed `EnumResolver` constructFor(DeserializationConfig the deserialization configuration to use config, AnnotatedClass the annotated class of the enum to be resolved annotatedClass) Factory method for constructing an `EnumResolver` based on the given `DeserializationConfig` and `AnnotatedClass` of the enum to be resolved.
public CompactStringObjectMap	constructLookup()
public static EnumResolver	constructUsingEnumNamingStrategy(DeserializationConfig config, AnnotatedClass annotatedClass, EnumNamingStrategy enumNamingStrategy) Factory method for constructing an `EnumResolver` with `EnumNamingStrategy` applied.
public static EnumResolver	constructUsingIndex(DeserializationConfig config, AnnotatedClass annotatedClass) Factory method for constructing resolver that maps from index of Enum.values() into Enum value.
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.
public static EnumResolver	constructUsingToString(DeserializationConfig config, AnnotatedClass annotatedClass) Factory method for constructing resolver that maps from Enum.toString() into Enum value
public Enum<?>	findEnum(String key)
public Enum<?>	getDefaultValue()
public Enum<?>	getEnum(int index)
public Class<Enum<?>>	getEnumClass()
public Collection<String>	getEnumIds()
public List<Enum<?>>	getEnums()
public Enum<?>[]	getRawEnums()
public boolean	hasAsValueAnnotation() Accessor for checking whether `@JsonValue` annotated accessor is used to get enum values to use for deserialization.
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()`.
public int	lastValidIndex()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_defaultValue	back to summary
protected final Enum<?> _defaultValue

_enumClass	back to summary
protected final Class<Enum<?>> _enumClass

_enums	back to summary
protected final Enum<?>[] _enums

_enumsById	back to summary
protected final HashMap<String, Enum<?>> _enumsById

_hasAsValueAnnotation back to summary

_hasAsValueAnnotation	back to summary
protected final boolean _hasAsValueAnnotation Marker for case where enum values to match are from `@JsonValue`-annotated method. Since 2.20

protected final boolean _hasAsValueAnnotation

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

Since: 2.20

_isFromIntValue back to summary

_isFromIntValue	back to summary
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.

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.

_isIgnoreCase	back to summary
protected final boolean _isIgnoreCase Marker for case-insensitive handling

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

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

Method Detail

_enumClass	back to summary
protected static Class<Enum<?>> _enumClass(Class<?> cls) Annotations @SuppressWarnings:unchecked

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

_enumDefault back to summary

_enumDefault	back to summary
protected static Enum<?> _enumDefault(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enums) Internal helper method used to resolve `com.fasterxml.jackson.annotation.JsonEnumDefaultValue` Since 2.16

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

Internal helper method used to resolve com.fasterxml.jackson.annotation.JsonEnumDefaultValue

Since: 2.16

_findEnumIgnoreCase	back to summary
private final Enum<?> _findEnumIgnoreCase(final String key)

_isIntType	back to summary
protected static boolean _isIntType(Class<?> erasedType)

constructFor back to summary

constructFor	back to summary
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:DeserializationConfig the deserialization configuration to use annotatedClass:AnnotatedClass the annotated class of the enum to be resolved Returns:EnumResolver the constructed `EnumResolver`

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:DeserializationConfig: the deserialization configuration to use
annotatedClass:AnnotatedClass: the annotated class of the enum to be resolved

Returns:EnumResolver

the constructed EnumResolver

constructLookup	back to summary
public CompactStringObjectMap constructLookup()

constructUsingEnumNamingStrategy back to summary

constructUsingEnumNamingStrategy	back to summary
public static EnumResolver constructUsingEnumNamingStrategy(DeserializationConfig config, AnnotatedClass annotatedClass, EnumNamingStrategy enumNamingStrategy) Factory method for constructing an `EnumResolver` with `EnumNamingStrategy` applied. Since 2.16

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

Factory method for constructing an EnumResolver with EnumNamingStrategy applied.

Since: 2.16

constructUsingIndex	back to summary
public static EnumResolver constructUsingIndex(DeserializationConfig config, AnnotatedClass annotatedClass) Factory method for constructing resolver that maps from index of Enum.values() into Enum value.

constructUsingMethod	back to summary
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.

constructUsingToString	back to summary
public static EnumResolver constructUsingToString(DeserializationConfig config, AnnotatedClass annotatedClass) Factory method for constructing resolver that maps from Enum.toString() into Enum value Since 2.16

constructUsingToString

back to summary

public static EnumResolver constructUsingToString(DeserializationConfig config, AnnotatedClass annotatedClass)

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

Since: 2.16

findEnum	back to summary
public Enum<?> findEnum(String key)

getDefaultValue	back to summary
public Enum<?> getDefaultValue()

getEnum	back to summary
public Enum<?> getEnum(int index)

getEnumClass	back to summary
public Class<Enum<?>> getEnumClass()

getEnumIds	back to summary
public Collection<String> getEnumIds()

getEnums	back to summary
public List<Enum<?>> getEnums()

getRawEnums	back to summary
public Enum<?>[] getRawEnums()

hasAsValueAnnotation	back to summary
public boolean hasAsValueAnnotation() Accessor for checking whether `@JsonValue` annotated accessor is used to get enum values to use for deserialization.

isFromIntValue	back to summary
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()`.