Package io.permazen.core

Class EnumValueEncoding

java.lang.Object

io.permazen.encoding.AbstractEncoding<T>

io.permazen.encoding.NullSafeEncoding<EnumValue>

io.permazen.core.EnumValueEncoding

All Implemented Interfaces:

Encoding<EnumValue>, NaturalSortAware, Serializable, Comparator<EnumValue>

public class EnumValueEncoding
extends NullSafeEncoding<EnumValue>

The Encoding for EnumValue, which is the data type used by EnumField.

Each EnumValueEncoding instance has an ordered list of String identifiers; two EnumValueEncoding instances are not compatible unless they have identical identifier lists. The identifiers must be valid Java identifiers.

Note that whatever Enum type may be used to represent values at the Java layer is unimportant; only the ordered list of identifiers matters.

Null values are supported by this class.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENT_PATTERN

Fields inherited from class io.permazen.encoding.NullSafeEncoding

inner, NOT_NULL_SENTINEL, NULL_SENTINEL

Fields inherited from class io.permazen.encoding.AbstractEncoding

encodingId, typeToken

Fields inherited from interface io.permazen.encoding.Encoding

MAX_ARRAY_DIMENSIONS

Constructor Summary

Constructors

Constructor	Description
EnumValueEncoding(Class<T> enumType)	Constructor that derives the type name and identifier list from the given Enum type.
EnumValueEncoding(List<String> idents)	Primary constructor.

Method Summary

Modifier and Type	Method	Description
List<String>	getIdentifiers()	Get the identifiers associated with this instance in ordinal order.
static Map<String,EnumValue>	validateIdentifiers(List<String> idents)	Validate a list of enum identifiers and build a mapping from identifier to corresponding EnumValue.

Methods inherited from class io.permazen.encoding.NullSafeEncoding

compare, convert, equals, fromString, getInnerEncoding, hashCode, hasPrefix0x00, hasPrefix0xff, read, skip, sortsNaturally, supportsNull, toString, withEncodingId, write

Methods inherited from class io.permazen.encoding.AbstractEncoding

getDefaultValueObject, getEncodingId, getTypeToken, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface io.permazen.encoding.Encoding

decode, encode, getDefaultValue, getKeyRange, validate, validateAndWrite

Field Details

IDENT_PATTERN

public static final String IDENT_PATTERN

See Also:

• Constant Field Values

Constructor Details

EnumValueEncoding

public EnumValueEncoding(Class<T> enumType)

Constructor that derives the type name and identifier list from the given Enum type.

Type Parameters:

T - enum type

Parameters:

enumType - Java Enum type from which to derive type name and ordered identifier list

Throws:

NullPointerException - if enumType is null

EnumValueEncoding

public EnumValueEncoding(List<String> idents)

Primary constructor.

Parameters:

idents - ordered list of identifiers

Throws:

IllegalArgumentException - if name is null or invalid

IllegalArgumentException - if idents is null or contains a duplicate or invalid identifier

Method Details

getIdentifiers

public List<String> getIdentifiers()

Get the identifiers associated with this instance in ordinal order.

Returns:

unmodifiable, ordinally ordered list of identifiers

validateIdentifiers

public static Map<String,EnumValue> validateIdentifiers(List<String> idents)

Validate a list of enum identifiers and build a mapping from identifier to corresponding EnumValue. The returned mapping will iterate the EnumValues in ordinal order.

Parameters:

idents - enum identifiers

Returns:

ordinally ordered mapping from identifier to EnumValue

Throws:

IllegalArgumentException - if idents is null

IllegalArgumentException - if any identifier in idents is null, duplicate, or not a valid Java identifier