net.openhft.chronicle.core.pool

Class EnumCache<E>

java.lang.Object

net.openhft.chronicle.core.pool.EnumCache<E>

Type Parameters:

E - the type of enum instances this cache will manage. Example usage:

            
            EnumCache<MyEnum> myEnumCache = EnumCache.of(MyEnum.class);
            MyEnum someValue = myEnumCache.valueOf("SOME_VALUE");
            
            

Direct Known Subclasses:

DynamicEnumClass, StaticEnumClass

public abstract class EnumCache<E>
extends Object

Abstract base class for caching and efficient access to enum-like instances. This class supports both traditional static enums, and dynamic enums which allow the creation of enum instances at runtime.

Usage of this class provides efficient access to enum instances via name or index, and also provides convenience methods for creating maps and sets that use enum instances as keys or elements.

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<E>	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnumCache(Class<E> type) Constructs an EnumCache for the specified enum type.

Method Summary

Modifier and Type	Method and Description
abstract E[]	asArray() Returns an array containing all the enum instances managed by this cache.
abstract <T> Map<E,T>	createMap() Creates a map where the keys are enum instances.
abstract Set<E>	createSet() Creates a set for holding enum instances.
abstract E	forIndex(int index) Retrieves the enum instance at the given ordinal index.
E	get(String name) Returns the enum instance with the specified name.
static <E> EnumCache<E>	of(Class<E> eClass) Retrieves an EnumCache instance for the specified enum class.
abstract int	size() Returns the total number of enum instances managed by this cache.
Class<?>	type() Returns the class of the enum type this cache is managing.
abstract E	valueOf(String name) Returns the enum instance with the specified name.

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final Class<E> type

Constructor Detail

EnumCache

protected EnumCache(Class<E> type)

Constructs an EnumCache for the specified enum type.

Parameters:

type - the class of the enum this cache will manage.

Method Detail

of

public static <E> EnumCache<E> of(Class<E> eClass)

Retrieves an EnumCache instance for the specified enum class.

Type Parameters:

E - the type of the enum.

Parameters:

eClass - the class of the enum.

Returns:

an EnumCache instance for the specified enum class.

get

public E get(String name)

Returns the enum instance with the specified name.

Parameters:

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

Returns:

the enum instance with the specified name.

valueOf

public abstract E valueOf(String name)

Returns the enum instance with the specified name.

Parameters:

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

Returns:

the enum instance with the specified name.

size

public abstract int size()

Returns the total number of enum instances managed by this cache.

Returns:

the number of enum instances.

type

public Class<?> type()

Returns the class of the enum type this cache is managing.

Returns:

the enum class.

forIndex

public abstract E forIndex(int index)

Retrieves the enum instance at the given ordinal index.

Parameters:

index - the ordinal index of the enum instance to retrieve.

Returns:

the enum instance at the given index.

asArray

public abstract E[] asArray()

Returns an array containing all the enum instances managed by this cache.

Returns:

an array of all enum instances.

createMap

public abstract <T> Map<E,T> createMap()

Creates a map where the keys are enum instances.

Type Parameters:

T - the type of the map values.

Returns:

a map with enum instances as keys.

createSet

public abstract Set<E> createSet()

Creates a set for holding enum instances.

Returns:

a set of enum instances.