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

public final Enum EnumFeature

extends Enum<EnumFeature>
implements DatatypeFeature
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.cfg.DatatypeFeature, com.fasterxml.jackson.core.util.JacksonFeature
Imports
com.fasterxml.jackson.databind.SerializationFeature
New Datatype-specific configuration options related to handling of java.lang.Enum types.
Since
2.14

Field Summary

Modifier and TypeField and Description
private final boolean
_enabledByDefault

Whether feature is enabled or disabled by default.

private final int
_mask

private static final int
FEATURE_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.

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.

Constructor Summary

AccessConstructor and Description
private
EnumFeature(boolean enabledByDefault)

Method Summary

Modifier and TypeMethod and Description
public boolean
enabledByDefault()

Implements com.fasterxml.jackson.core.util.JacksonFeature.enabledByDefault.

Accessor for checking whether this feature is enabled by default.

public boolean
enabledIn(int
Bit field that contains a set of enabled features of this type
flags)

Implements com.fasterxml.jackson.core.util.JacksonFeature.enabledIn.

Convenience method for checking whether feature is enabled in given bitmask.

public int
featureIndex()

Implements com.fasterxml.jackson.databind.cfg.DatatypeFeature.featureIndex.

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

public int
getMask()

Implements com.fasterxml.jackson.core.util.JacksonFeature.getMask.

Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.

public static EnumFeature
valueOf(String name)

public static EnumFeature[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

_enabledByDefaultback to summary
private final boolean _enabledByDefault

Whether feature is enabled or disabled by default.

_maskback to summary
private final int _mask
FEATURE_INDEXback to summary
private static final int FEATURE_INDEX
READ_ENUM_KEYS_USING_INDEXback to summary
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_LOWERCASEback to summary
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

Constructor Detail

EnumFeatureback to summary
private EnumFeature(boolean enabledByDefault)

Method Detail

enabledByDefaultback to summary
public boolean enabledByDefault()

Implements com.fasterxml.jackson.core.util.JacksonFeature.enabledByDefault.

Doc from com.fasterxml.jackson.core.util.JacksonFeature.enabledByDefault.

Accessor for checking whether this feature is enabled by default.

Returns:boolean

Whether this instance is enabled by default or not

Annotations
@Override
enabledInback to summary
public boolean enabledIn(int flags)

Implements com.fasterxml.jackson.core.util.JacksonFeature.enabledIn.

Doc from com.fasterxml.jackson.core.util.JacksonFeature.enabledIn.

Convenience method for checking whether feature is enabled in given bitmask.

Parameters
flags:int

Bit field that contains a set of enabled features of this type

Returns:boolean

True if this feature is enabled in passed bit field

Annotations
@Override
featureIndexback to summary
public int featureIndex()

Implements com.fasterxml.jackson.databind.cfg.DatatypeFeature.featureIndex.

Doc from com.fasterxml.jackson.databind.cfg.DatatypeFeature.featureIndex.

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

Annotations
@Override
getMaskback to summary
public int getMask()

Implements com.fasterxml.jackson.core.util.JacksonFeature.getMask.

Doc from com.fasterxml.jackson.core.util.JacksonFeature.getMask.

Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.

Returns:int

Bit mask of this feature

Annotations
@Override
valueOfback to summary
public static EnumFeature valueOf(String name)
valuesback to summary
public static EnumFeature[] values()