Package com.fasterxml.jackson.databind.util

Class EnumResolver

java.lang.Object

com.fasterxml.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

Method Summary

Modifier and Type	Method	Description
static EnumResolver	constructFor(DeserializationConfig config, Class<?> enumCls)	Factory method for constructing resolver that maps from Enum.name() into Enum value.
static EnumResolver	constructFor(Class<Enum<?>> enumCls, AnnotationIntrospector ai)	Deprecated. Since 2.12
CompactStringObjectMap	constructLookup()
static EnumResolver	constructUnsafe(Class<?> rawEnumCls, AnnotationIntrospector ai)	Deprecated. Since 2.12
static EnumResolver	constructUnsafeUsingMethod(Class<?> rawEnumCls, AnnotatedMember accessor, AnnotationIntrospector ai)	Deprecated. Since 2.12
static EnumResolver	constructUnsafeUsingToString(Class<?> rawEnumCls, AnnotationIntrospector ai)	Deprecated. Since 2.12
static EnumResolver	constructUsingMethod(DeserializationConfig config, Class<?> enumCls, AnnotatedMember accessor)	Method used when actual String serialization is indicated using @JsonValue on a method in Enum class.
static EnumResolver	constructUsingMethod(Class<Enum<?>> enumCls, AnnotatedMember accessor, AnnotationIntrospector ai)	Deprecated. Since 2.12
static EnumResolver	constructUsingToString(DeserializationConfig config, Class<?> enumCls)	Factory method for constructing resolver that maps from Enum.toString() into Enum value
static EnumResolver	constructUsingToString(Class<Enum<?>> enumCls)	Deprecated. Since 2.8 (remove from 2.13 or later)
static EnumResolver	constructUsingToString(Class<Enum<?>> enumCls, AnnotationIntrospector ai)	Deprecated. Since 2.12
Enum<?>	findEnum(String key)
Enum<?>	getDefaultValue()
Enum<?>	getEnum(int index)
Class<Enum<?>>	getEnumClass()
Collection<String>	getEnumIds()
List<Enum<?>>	getEnums()
Enum<?>[]	getRawEnums()
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

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

Method Detail

constructFor

public static EnumResolver constructFor(DeserializationConfig config,
                                        Class<?> enumCls)

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

Since:

2.12

constructUsingToString

public static EnumResolver constructUsingToString(DeserializationConfig config,
                                                  Class<?> enumCls)

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

Since:

2.12

constructUsingMethod

public static EnumResolver constructUsingMethod(DeserializationConfig config,
                                                Class<?> enumCls,
                                                AnnotatedMember accessor)

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

Since:

2.12

constructLookup

public CompactStringObjectMap constructLookup()

constructFor

@Deprecated
public static EnumResolver constructFor(Class<Enum<?>> enumCls,
                                        AnnotationIntrospector ai)

Deprecated.

Since 2.12

constructUnsafe

@Deprecated
public static EnumResolver constructUnsafe(Class<?> rawEnumCls,
                                           AnnotationIntrospector ai)

Deprecated.

Since 2.12

constructUsingToString

@Deprecated
public static EnumResolver constructUsingToString(Class<Enum<?>> enumCls,
                                                  AnnotationIntrospector ai)

Deprecated.

Since 2.12

constructUnsafeUsingToString

@Deprecated
public static EnumResolver constructUnsafeUsingToString(Class<?> rawEnumCls,
                                                        AnnotationIntrospector ai)

Deprecated.

Since 2.12

Since:

2.8

constructUsingToString

@Deprecated
public static EnumResolver constructUsingToString(Class<Enum<?>> enumCls)

Deprecated.

Since 2.8 (remove from 2.13 or later)

constructUsingMethod

@Deprecated
public static EnumResolver constructUsingMethod(Class<Enum<?>> enumCls,
                                                AnnotatedMember accessor,
                                                AnnotationIntrospector ai)

Deprecated.

Since 2.12

constructUnsafeUsingMethod

@Deprecated
public static EnumResolver constructUnsafeUsingMethod(Class<?> rawEnumCls,
                                                      AnnotatedMember accessor,
                                                      AnnotationIntrospector ai)

Deprecated.

Since 2.12

Since:

2.9

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()

Since:

2.7.3

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().

Since:

2.13