DynamicEnumClass (OpenHFT/Chronicle Core 2.27ea0 API)

java.lang.Object
- net.openhft.chronicle.core.pool.EnumCache<E>
- - net.openhft.chronicle.core.pool.DynamicEnumClass<E>

Type Parameters:
E - the type of enum instances this class will manage. It must extend CoreDynamicEnum. Example usage:
```
            
            EnumCache<YesNo> yesNoEnumCache = EnumCache.of(YesNo.class);
            YesNo maybe = yesNoEnumCache.valueOf("Maybe"); // Dynamically creates a new enum instance with name "Maybe"
            
            
```
```
public class DynamicEnumClass<E extends CoreDynamicEnum<E>>
extends EnumCache<E>
```
Represents a dynamic enumeration class that extends the capabilities of EnumCache. The class is capable of dynamically creating and managing instances which resemble enumerations (enums) in behavior. Unlike traditional enums, which have a fixed set of instances, DynamicEnumClass can create new instances on-the-fly.
This class is thread-safe and ensures that each unique name maps to a single instance.
Instances of DynamicEnumClass have properties similar to traditional enums, like name and ordinal. The name is the string identifier of an enum instance, while the ordinal represents the position of the enum instance in the declaration order.

Field Summary

Fields
Modifier and Type Field and Description

static CoreDynamicEnum<?>[] CORE_DYNAMIC_ENUMS
- Fields inherited from class net.openhft.chronicle.core.pool.EnumCache
  type

Fields
Modifier and Type	Field and Description
`static CoreDynamicEnum<?>[]`	`CORE_DYNAMIC_ENUMS`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`E[]`	`asArray()` Returns an array containing all the enum instances managed by this cache.
`<T> Map<E,T>`	`createMap()` Creates a map where the keys are enum instances.
`Set<E>`	`createSet()` Creates a set for holding enum instances.
`E`	`forIndex(int index)` Returns an array containing the enum instances managed by this class in the order they were created.
`E`	`get(String name)` Returns the enum instance with the specified name.
`void`	`reset()` Resets the internal state of this class by clearing the stored enum instances and resetting them to the initial state.
`int`	`size()` Returns the number of enum instances currently managed by this class.
`E`	`valueOf(String name)` Returns the enum instance with the specified name.

Methods inherited from class net.openhft.chronicle.core.pool.EnumCache
of, type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CORE_DYNAMIC_ENUMS
```
public static final CoreDynamicEnum<?>[] CORE_DYNAMIC_ENUMS
```
- Method Detail
  - get
```
public E get(String name)
```
    Returns the enum instance with the specified name. The method returns null if the instance does not exist.
    
    Overrides:
    
    get in class EnumCache<E extends CoreDynamicEnum<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.
  - valueOf
```
public E valueOf(String name)
```
    Returns the enum instance with the specified name. If an instance with the specified name does not exist, this method dynamically creates a new one.
    
    Specified by:
    
    valueOf in class EnumCache<E extends CoreDynamicEnum<E>>
    
    Parameters:
    
    name - the name of the enum instance to be retrieved or created.
    
    Returns:
    
    the enum instance with the specified name.
  - size
```
public int size()
```
    Returns the number of enum instances currently managed by this class.
    
    Specified by:
    
    size in class EnumCache<E extends CoreDynamicEnum<E>>
    
    Returns:
    
    the size of enum instances.
  - forIndex
```
public E forIndex(int index)
```
    Returns an array containing the enum instances managed by this class in the order they were created.
    
    Specified by:
    
    forIndex in class EnumCache<E extends CoreDynamicEnum<E>>
    
    Parameters:
    
    index - the ordinal index of the enum instance to retrieve.
    
    Returns:
    
    an array containing the enum instances.
  - asArray
```
public E[] asArray()
```
    Description copied from class: EnumCache
    
    Returns an array containing all the enum instances managed by this cache.
    
    Specified by:
    
    asArray in class EnumCache<E extends CoreDynamicEnum<E>>
    
    Returns:
    
    an array of all enum instances.
  - createMap
```
public <T> Map<E,T> createMap()
```
    Description copied from class: EnumCache
    
    Creates a map where the keys are enum instances.
    
    Specified by:
    
    createMap in class EnumCache<E extends CoreDynamicEnum<E>>
    
    Type Parameters:
    
    T - the type of the map values.
    
    Returns:
    
    a map with enum instances as keys.
  - createSet
```
public Set<E> createSet()
```
    Description copied from class: EnumCache
    
    Creates a set for holding enum instances.
    
    Specified by:
    
    createSet in class EnumCache<E extends CoreDynamicEnum<E>>
    
    Returns:
    
    a set of enum instances.
  - reset
```
@TestOnly
public void reset()
```
    Resets the internal state of this class by clearing the stored enum instances and resetting them to the initial state. Use with caution as this will delete any dynamically created enum instances.
    This method is intended to be used for testing purposes.

Class DynamicEnumClass<E extends CoreDynamicEnum<E>>

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

CORE_DYNAMIC_ENUMS

Method Detail

get

valueOf

size

forIndex

asArray

createMap

createSet

reset