oneapi.util

Class EnumUtil

java.lang.Object

oneapi.util.EnumUtil

All Implemented Interfaces:

Serializable

public final class EnumUtil
extends Object
implements Serializable

Contains helper methods for transforming integer values to to specific enumeration constants.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnumUtil.EnumMapper<T extends EnumUtil.IEnumIntValue> Helper class for getting enumeration constants based on integer value. Uses map for mapping enumeration constants to specified integer value which results in O(1) complexity.
static interface	EnumUtil.IEnumIntValue Enumeration which are to be handled using EnumUtil methods must implement this interface.

Constructor Summary

Constructors

Constructor and Description
EnumUtil()

Method Summary

Modifier and Type	Method and Description
static <T extends EnumUtil.IEnumIntValue> T	enumFor(Class<T> enumClass, int i) Returns enumeration constant which is associated with specified integer value. Complexity of this method is O(n).
static <T extends EnumUtil.IEnumIntValue> EnumUtil.EnumMapper<T>	enumMapper(Class<T> enumClass) Returns fast enumeration constant mapper object associated with specific enumeration. If enumeration contains lots of enumeration constants, enumFor(Class, int) can become a performance issue. To get O(1) performace EnumUtil.EnumMapper should be used which can return enumeration constant for specified value in constant time.
protected static <T extends EnumUtil.IEnumIntValue> T[]	getEnumConstants(Class<T> enumClass) Returns enumerations constants defined in specified enumeration class.
static <T extends EnumUtil.IEnumIntValue> int	valueFor(T enumValue) Returns integer value for specified enumeration element. This method is implement for convenience only - same value can be acquired directly from enumeration constant using EnumUtil.IEnumIntValue.getValue().

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumUtil

public EnumUtil()

Method Detail

valueFor

public static <T extends EnumUtil.IEnumIntValue> int valueFor(T enumValue)

Returns integer value for specified enumeration element.

This method is implement for convenience only - same value can be acquired directly from enumeration constant using EnumUtil.IEnumIntValue.getValue().

Type Parameters:

T - enumeration class which must implement EnumUtil.IEnumIntValue

Parameters:

enumValue - enumeration constant for which to get associated integer value

Returns:

integer value associated with enumeration constant

enumFor

public static <T extends EnumUtil.IEnumIntValue> T enumFor(Class<T> enumClass,
                                                           int i)
                                                    throws IllegalArgumentException

Returns enumeration constant which is associated with specified integer value.

Complexity of this method is O(n).

Type Parameters:

T - Type of enumeration

Parameters:

enumClass - enumeration class

i - value associated to enumeration constant

Returns:

first enumeration constant found which is associated with specified integer value

Throws:

IllegalArgumentException - if specified class is not enumeration class

getEnumConstants

protected static <T extends EnumUtil.IEnumIntValue> T[] getEnumConstants(Class<T> enumClass)
                                                                  throws IllegalArgumentException

Returns enumerations constants defined in specified enumeration class.

Type Parameters:

T - type of enumeration

Parameters:

enumClass - enumeration class

Returns:

enumeration constants

Throws:

IllegalArgumentException - if specified class is not enumeration class

enumMapper

public static <T extends EnumUtil.IEnumIntValue> EnumUtil.EnumMapper<T> enumMapper(Class<T> enumClass)

Returns fast enumeration constant mapper object associated with specific enumeration.

If enumeration contains lots of enumeration constants, enumFor(Class, int) can become a performance issue.
To get O(1) performace EnumUtil.EnumMapper should be used which can return enumeration constant for specified value in constant time.