Package io.datarouter.enums

Class MappedEnum<E,K>

java.lang.Object

io.datarouter.enums.MappedEnum<E,K>

Direct Known Subclasses:

CaseInsensitiveStringMappedEnum, StringMappedEnum

public class MappedEnum<E,K>
extends Object

Store enum values by an extracted and optionally transformed key. Ensure the transformed keys are unique between values. Prevent reads from accidentally returning null values. When parsing values, it's generally preferred to use fromOrThrow then fromOrDefault, while fromOrNull is discouraged.

Constructor Summary

Constructors

Constructor	Description
MappedEnum(E[] values, Function<E,K> keyExtractor)
MappedEnum(E[] values, Function<E,K> keyExtractor, Function<K,K> keyTransformer)

Method Summary

Modifier and Type	Method	Description
Optional<E>	from(K key)
E	fromOrElse(K key, E defaultValue)	Equivalent to from(key).orElse(defaultValue) but can be useful for tracking down uses in your code base.
E	fromOrNull(K key)	Equivalent to from(key).orElse(null) but can be useful for tracking down uses in your code base.
E	fromOrThrow(K key)	Equivalent to from(key).orElseThrow(..) but can be useful for tracking down uses in your code base.
Class<E>	getEnumClass()
E	getSampleValue()
Map<K,E>	getValueByKey()
MappedEnum<E,K>	requireAllExist(Collection<K> keys)
MappedEnum<E,K>	requireAllExist(K... keys)
K	toKey(E enumValue)

Methods inherited from class java.lang.Object

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

Constructor Details

MappedEnum

public MappedEnum(E[] values,
 Function<E,K> keyExtractor)

MappedEnum

public MappedEnum(E[] values,
 Function<E,K> keyExtractor,
 Function<K,K> keyTransformer)

Method Details

requireAllExist

public MappedEnum<E,K> requireAllExist(K... keys)

requireAllExist

public MappedEnum<E,K> requireAllExist(Collection<K> keys)

toKey

public K toKey(E enumValue)

from

public Optional<E> from(K key)

fromOrNull

public E fromOrNull(K key)

Equivalent to from(key).orElse(null) but can be useful for tracking down uses in your code base.

fromOrElse

public E fromOrElse(K key,
 E defaultValue)

Equivalent to from(key).orElse(defaultValue) but can be useful for tracking down uses in your code base.

fromOrThrow

public E fromOrThrow(K key)

Equivalent to from(key).orElseThrow(..) but can be useful for tracking down uses in your code base.

getSampleValue

public E getSampleValue()

getEnumClass

public Class<E> getEnumClass()

getValueByKey

public Map<K,E> getValueByKey()