Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.util

public final Class EnumValues

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
com.fasterxml.jackson.databind.introspect.AnnotatedClass, java.util.*, com.fasterxml.jackson.core.SerializableString, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.cfg.EnumFeature, .MapperConfig

Helper class used for storing String serializations of Enums, to match to/from external representations.

Field Summary

Modifier and TypeField and Description
private transient EnumMap<?, SerializableString>
private final Class<Enum<?>>
private final SerializableString[]
private final Enum<?>[]
private static final long

Constructor Summary

AccessConstructor and Description
private
EnumValues(Class<Enum<?>> enumClass, SerializableString[] textual)

Method Summary

Modifier and TypeMethod and Description
protected static Class<Enum<?>>
_enumClass(Class<?> enumCls0)

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

Helper method slightly different from EnumResolver#_enumConstants(Class), with same method name to keep calling methods more consistent.

protected static String
_findNameToUse(String explicitName, String otherName, boolean toLowerCase)

public static EnumValues
construct(SerializationConfig config, AnnotatedClass annotatedClass)

Note

do NOT call this if configuration may change, and choice between toString() and name() might change dynamically.

public static EnumValues
construct(MapperConfig<?> config, Class<Enum<?>> enumClass, List<String> externalValues)

public static EnumValues
construct(Class<Enum<?>> enumClass, SerializableString[] externalValues)

public static EnumValues
constructFromName(MapperConfig<?> config, Class<Enum<?>> enumClass)
Deprecated Since 2.16, use constructFromName(MapperConfig, AnnotatedClass) instead.

public static EnumValues
constructFromName(MapperConfig<?> config, AnnotatedClass annotatedClass)

public static EnumValues
public static EnumValues
constructFromToString(MapperConfig<?> config, Class<Enum<?>> enumClass)
Deprecated since 2.16; use constructFromToString(MapperConfig, AnnotatedClass) instead

public static EnumValues
constructUsingEnumNamingStrategy(MapperConfig<?> config, AnnotatedClass annotatedClass, EnumNamingStrategy namingStrategy)

Returns String serializations of Enum name using an instance of EnumNamingStrategy.

public static EnumValues
constructUsingEnumNamingStrategy(MapperConfig<?> config, Class<Enum<?>> enumClass, EnumNamingStrategy namingStrategy)

Returns String serializations of Enum name using an instance of EnumNamingStrategy.

public List<Enum<?>>
enums()

Convenience accessor for getting raw Enum instances.

public Class<Enum<?>>
public EnumMap<?, SerializableString>
internalMap()

Method used for serialization and introspection by core Jackson code.

public SerializableString
public Collection<SerializableString>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_asMapback to summary
private transient EnumMap<?, SerializableString> _asMap
_enumClassback to summary
private final Class<Enum<?>> _enumClass
_textualback to summary
private final SerializableString[] _textual
_valuesback to summary
private final Enum<?>[] _values
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

EnumValuesback to summary
private EnumValues(Class<Enum<?>> enumClass, SerializableString[] textual)

Method Detail

_enumClassback to summary
protected static Class<Enum<?>> _enumClass(Class<?> enumCls0)
Annotations
@SuppressWarnings:unchecked
_enumConstantsback to summary
protected static Enum<?>[] _enumConstants(Class<?> enumCls)

Helper method slightly different from EnumResolver#_enumConstants(Class), with same method name to keep calling methods more consistent.

_findNameToUseback to summary
protected static String _findNameToUse(String explicitName, String otherName, boolean toLowerCase)
constructback to summary
public static EnumValues construct(SerializationConfig config, AnnotatedClass annotatedClass)

Note

do NOT call this if configuration may change, and choice between toString() and name() might change dynamically.

Since
2.16
constructback to summary
public static EnumValues construct(MapperConfig<?> config, Class<Enum<?>> enumClass, List<String> externalValues)
Since
2.11
constructback to summary
public static EnumValues construct(Class<Enum<?>> enumClass, SerializableString[] externalValues)
Since
2.11
constructFromNameback to summary
public static EnumValues constructFromName(MapperConfig<?> config, Class<Enum<?>> enumClass)

Deprecated

Since 2.16, use constructFromName(MapperConfig, AnnotatedClass) instead.

Annotations
@Deprecated
constructFromNameback to summary
public static EnumValues constructFromName(MapperConfig<?> config, AnnotatedClass annotatedClass)
Since
2.16
constructFromToStringback to summary
public static EnumValues constructFromToString(MapperConfig<?> config, AnnotatedClass annotatedClass)
Since
2.16
constructFromToStringback to summary
public static EnumValues constructFromToString(MapperConfig<?> config, Class<Enum<?>> enumClass)

Deprecated

since 2.16; use constructFromToString(MapperConfig, AnnotatedClass) instead

Annotations
@Deprecated
constructUsingEnumNamingStrategyback to summary
public static EnumValues constructUsingEnumNamingStrategy(MapperConfig<?> config, AnnotatedClass annotatedClass, EnumNamingStrategy namingStrategy)

Returns String serializations of Enum name using an instance of EnumNamingStrategy.

The output EnumValues should contain values that are symmetric to EnumResolver#constructUsingEnumNamingStrategy(DeserializationConfig, AnnotatedClass, EnumNamingStrategy).

Since
2.16
constructUsingEnumNamingStrategyback to summary
public static EnumValues constructUsingEnumNamingStrategy(MapperConfig<?> config, Class<Enum<?>> enumClass, EnumNamingStrategy namingStrategy)

Returns String serializations of Enum name using an instance of EnumNamingStrategy. The output EnumValues should contain values that are symmetric to EnumResolver#constructUsingEnumNamingStrategy(DeserializationConfig, AnnotatedClass, EnumNamingStrategy).

Annotations
@Deprecated
Since
2.15
enumsback to summary
public List<Enum<?>> enums()

Convenience accessor for getting raw Enum instances.

Since
2.6
getEnumClassback to summary
public Class<Enum<?>> getEnumClass()
Since
2.2
internalMapback to summary
public EnumMap<?, SerializableString> internalMap()

Method used for serialization and introspection by core Jackson code.

Annotations
@SuppressWarnings:unchecked, rawtypes
serializedValueForback to summary
public SerializableString serializedValueFor(Enum<?> key)
valuesback to summary
public Collection<SerializableString> values()