net.openhft.chronicle.core.pool

Class StaticEnumClass<E extends Enum<E>>

java.lang.Object

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

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

Type Parameters:

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

            
            EnumCache<Ecn> ecnEnumCache = EnumCache.of(Ecn.class);
            Ecn rfx = ecnEnumCache.get("RFX");
            
            

public class StaticEnumClass<E extends Enum<E>>
extends EnumCache<E>

Represents a static enumeration class that extends the capabilities of EnumCache. This class is designed to work with traditional Java enum types, enabling efficient access and operations on the enum instances.

Unlike its counterpart DynamicEnumClass, this class does not support dynamic creation of enum instances. The enum instances are fixed at compile time as per standard Java enum behavior.

Field Summary

Fields inherited from class net.openhft.chronicle.core.pool.EnumCache

type

Method Summary

Modifier and Type	Method and Description
E[]	asArray() Returns an array containing the enum instances managed by this class in the order they were declared in the original enum class.
<T> Map<E,T>	createMap() Creates a map with enum instances as keys.
Set<E>	createSet() Creates a set for holding enum instances.
E	forIndex(int index) Retrieves the enum instance at the given ordinal index.
int	size() Returns the total number of enum instances managed by this class, which corresponds to the count of enum constants in the original enum class.
E	valueOf(String name) Returns the enum instance with the specified name.

Methods inherited from class net.openhft.chronicle.core.pool.EnumCache

get, of, type

Methods inherited from class java.lang.Object

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

Method Detail

valueOf

public E valueOf(String name)

Returns the enum instance with the specified name. The method returns null if the name is null or empty, or if the instance does not exist.

Specified by:

valueOf in class EnumCache<E extends Enum<E>>

Parameters:

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

Returns:

the enum instance with the specified name, or null if not present.

size

public int size()

Returns the total number of enum instances managed by this class, which corresponds to the count of enum constants in the original enum class.

Specified by:

size in class EnumCache<E extends Enum<E>>

Returns:

the number of enum instances.

forIndex

public E forIndex(int index)

Retrieves the enum instance at the given ordinal index.

Specified by:

forIndex in class EnumCache<E extends Enum<E>>

Parameters:

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

Returns:

the enum instance at the given index.

Throws:

ArrayIndexOutOfBoundsException - if the index is out of range.

asArray

public E[] asArray()

Returns an array containing the enum instances managed by this class in the order they were declared in the original enum class.

Specified by:

asArray in class EnumCache<E extends Enum<E>>

Returns:

an array containing the enum instances.

createMap

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

Creates a map with enum instances as keys.

Specified by:

createMap in class EnumCache<E extends Enum<E>>

Type Parameters:

T - the type of the map values.

Returns:

a map where the keys are enum instances.

createSet

public Set<E> createSet()

Creates a set for holding enum instances.

Specified by:

createSet in class EnumCache<E extends Enum<E>>

Returns:

a set for holding enum instances.