net.openhft.chronicle.core.pool

Class EnumInterner<E extends Enum<E>>

java.lang.Object

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

Type Parameters:

E - the type of the enum

public class EnumInterner<E extends Enum<E>>
extends Object

This class represents a cache for enum values to improve performance in scenarios where the same enum values are frequently looked up by name. The class is generic, so it can be used with any enum type.

Field Summary

Fields

Modifier and Type	Field and Description
static ClassLocal<EnumInterner<?>>	ENUM_INTERNER A cache for EnumInterner instances.

Constructor Summary

Constructors

Constructor and Description
EnumInterner(Class<E> eClass) Constructs a new EnumInterner with a default capacity.
EnumInterner(Class<E> eClass, int capacity) Constructs a new EnumInterner with a specified capacity.

Method Summary

Modifier and Type	Method and Description
E	intern(@NotNull CharSequence cs) Looks up an enum value by its name.

Methods inherited from class java.lang.Object

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

Field Detail

ENUM_INTERNER

public static final ClassLocal<EnumInterner<?>> ENUM_INTERNER

A cache for EnumInterner instances. Each class will have its own EnumInterner.

Constructor Detail

EnumInterner

public EnumInterner(Class<E> eClass)
             throws IllegalArgumentException

Constructs a new EnumInterner with a default capacity.

Parameters:

eClass - the enum class

Throws:

IllegalArgumentException - if an illegal argument is provided

EnumInterner

public EnumInterner(Class<E> eClass,
                    int capacity)
             throws IllegalArgumentException

Constructs a new EnumInterner with a specified capacity.

Parameters:

eClass - the enum class

capacity - the initial capacity of the EnumInterner

Throws:

IllegalArgumentException - if an illegal argument is provided

Method Detail

intern

public E intern(@NotNull
                @NotNull CharSequence cs)

Looks up an enum value by its name. If the value is not yet in the cache, it is added. If the value is already in the cache, the cached value is returned.

Parameters:

cs - the name of the enum value

Returns:

the enum value corresponding to the given name