Enum EnumFeature

java.lang.Object

java.lang.Enum<EnumFeature>

com.fasterxml.jackson.databind.cfg.EnumFeature

All Implemented Interfaces:

com.fasterxml.jackson.core.util.JacksonFeature, DatatypeFeature, Serializable, Comparable<EnumFeature>, java.lang.constant.Constable

public enum EnumFeature
extends Enum<EnumFeature>
implements DatatypeFeature

New Datatype-specific configuration options related to handling of Enum types.

Since:

2.14

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
READ_ENUM_KEYS_USING_INDEX	Feature that determines standard deserialization mechanism used for Enum values: if enabled, Enums are assumed to have been serialized using index of Enum;
WRITE_ENUMS_TO_LOWERCASE	Feature that determines standard serialization mechanism used for Enum values: if enabled, return value of Enum.name().toLowerCase() is used; if disabled, return value of Enum.name() is used.

Method Summary

Modifier and Type	Method	Description
boolean	enabledByDefault()
boolean	enabledIn(int flags)
int	featureIndex()	Internal index used for efficient storage and index; no user serviceable contents inside!
int	getMask()
static EnumFeature	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EnumFeature[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

READ_ENUM_KEYS_USING_INDEX

public static final EnumFeature READ_ENUM_KEYS_USING_INDEX

Feature that determines standard deserialization mechanism used for Enum values: if enabled, Enums are assumed to have been serialized using index of Enum;

Note: this feature should be symmetric to as SerializationFeature.WRITE_ENUM_KEYS_USING_INDEX.

Feature is disabled by default.

Since:

2.15

WRITE_ENUMS_TO_LOWERCASE

public static final EnumFeature WRITE_ENUMS_TO_LOWERCASE

Feature that determines standard serialization mechanism used for Enum values: if enabled, return value of Enum.name().toLowerCase() is used; if disabled, return value of Enum.name() is used.

NOTE: this feature CAN NOT be changed on per-call basis: it will have to be set on ObjectMapper before use

Feature is disabled by default.

Since:

2.15

Method Details

values

public static EnumFeature[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EnumFeature valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

enabledByDefault

public boolean enabledByDefault()

Specified by:

enabledByDefault in interface com.fasterxml.jackson.core.util.JacksonFeature

enabledIn

public boolean enabledIn(int flags)

Specified by:

enabledIn in interface com.fasterxml.jackson.core.util.JacksonFeature

getMask

public int getMask()

Specified by:

getMask in interface com.fasterxml.jackson.core.util.JacksonFeature

featureIndex

public int featureIndex()

Description copied from interface: DatatypeFeature

Internal index used for efficient storage and index; no user serviceable contents inside!

Specified by:

featureIndex in interface DatatypeFeature