com.fasterxml.jackson.databind.util

Class EnumValues

java.lang.Object

com.fasterxml.jackson.databind.util.EnumValues

All Implemented Interfaces:

java.io.Serializable

public final class EnumValues
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static EnumValues	construct(java.lang.Class<java.lang.Enum<?>> enumClass, SerializableString[] externalValues)
static EnumValues	construct(MapperConfig<?> config, java.lang.Class<java.lang.Enum<?>> enumClass, java.util.List<java.lang.String> externalValues)
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.
static EnumValues	constructFromName(MapperConfig<?> config, AnnotatedClass annotatedClass)
static EnumValues	constructFromName(MapperConfig<?> config, java.lang.Class<java.lang.Enum<?>> enumClass) Deprecated. Since 2.16, use constructFromName(MapperConfig, AnnotatedClass) instead.
static EnumValues	constructFromToString(MapperConfig<?> config, AnnotatedClass annotatedClass)
static EnumValues	constructFromToString(MapperConfig<?> config, java.lang.Class<java.lang.Enum<?>> enumClass) Deprecated. since 2.16; use constructFromToString(MapperConfig, AnnotatedClass) instead
static EnumValues	constructUsingEnumNamingStrategy(MapperConfig<?> config, AnnotatedClass annotatedClass, EnumNamingStrategy namingStrategy) Returns String serializations of Enum name using an instance of EnumNamingStrategy.
static EnumValues	constructUsingEnumNamingStrategy(MapperConfig<?> config, java.lang.Class<java.lang.Enum<?>> enumClass, EnumNamingStrategy namingStrategy) Deprecated. Since 2.16; use constructUsingEnumNamingStrategy(MapperConfig, AnnotatedClass, EnumNamingStrategy) instead.
java.util.List<java.lang.Enum<?>>	enums() Convenience accessor for getting raw Enum instances.
java.lang.Class<java.lang.Enum<?>>	getEnumClass()
java.util.EnumMap<?,SerializableString>	internalMap() Method used for serialization and introspection by core Jackson code.
SerializableString	serializedValueFor(java.lang.Enum<?> key)
java.util.Collection<SerializableString>	values()

Methods inherited from class java.lang.Object

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

Method Detail

construct

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

constructFromName

@Deprecated
public static EnumValues constructFromName(MapperConfig<?> config,
                                                       java.lang.Class<java.lang.Enum<?>> enumClass)

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

constructFromName

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

Since:

2.16

constructFromToString

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

Since:

2.16

constructFromToString

@Deprecated
public static EnumValues constructFromToString(MapperConfig<?> config,
                                                           java.lang.Class<java.lang.Enum<?>> enumClass)

Deprecated. since 2.16; use constructFromToString(MapperConfig, AnnotatedClass) instead

constructUsingEnumNamingStrategy

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

constructUsingEnumNamingStrategy

@Deprecated
public static EnumValues constructUsingEnumNamingStrategy(MapperConfig<?> config,
                                                                      java.lang.Class<java.lang.Enum<?>> enumClass,
                                                                      EnumNamingStrategy namingStrategy)

Deprecated. Since 2.16; use constructUsingEnumNamingStrategy(MapperConfig, AnnotatedClass, EnumNamingStrategy) instead.

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.15

construct

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

Since:

2.11

construct

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

Since:

2.11

serializedValueFor

public SerializableString serializedValueFor(java.lang.Enum<?> key)

values

public java.util.Collection<SerializableString> values()

enums

public java.util.List<java.lang.Enum<?>> enums()

Convenience accessor for getting raw Enum instances.

Since:

2.6

internalMap

public java.util.EnumMap<?,SerializableString> internalMap()

Method used for serialization and introspection by core Jackson code.

getEnumClass

public java.lang.Class<java.lang.Enum<?>> getEnumClass()

Since:

2.2