Package com.github.toolarium.enumeration.configuration.util

Class EnumUtil

java.lang.Object

com.github.toolarium.enumeration.configuration.util.EnumUtil

public final class EnumUtil
extends java.lang.Object

Enum utility

Method Summary

Modifier and Type	Method	Description
<T extends java.lang.Enum<T>> EnumKeyConfiguration	getEnumKeyConfigurationAnnotationInformation(T e)	Get the EnumKeyConfiguration from an enumeration configuration
EnumKeyValueConfiguration	getEnumKeyValueConfigurationAnnotationInformation(java.lang.Enum<?> e)	Get the EnumKeyValueConfiguration from an enumeration configuration
static EnumUtil	getInstance()	Get the instance
<T extends java.lang.Enum<T>> T	mapEnum(java.lang.Class<T> enumType, java.lang.Enum<?> inputEnum)	Returns the enum constant of the specified enum type with the specified name.
<T extends java.lang.Enum<T>> T	valueOf(java.lang.Class<T> enumType, java.lang.String name)	Returns the enum constant of the specified enum type with the specified name.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static EnumUtil getInstance()

Get the instance

Returns:

the instance

getEnumKeyConfigurationAnnotationInformation

public <T extends java.lang.Enum<T>> EnumKeyConfiguration getEnumKeyConfigurationAnnotationInformation(T e)
                                                                                                throws java.lang.IllegalArgumentException

Get the EnumKeyConfiguration from an enumeration configuration

Type Parameters:

T - the generic type

Parameters:

e - the enumeration value

Returns:

the parsed content

Throws:

java.lang.IllegalArgumentException - In case the annotation could not be resolved

getEnumKeyValueConfigurationAnnotationInformation

public EnumKeyValueConfiguration getEnumKeyValueConfigurationAnnotationInformation(java.lang.Enum<?> e)
                                                                            throws java.lang.IllegalArgumentException

Get the EnumKeyValueConfiguration from an enumeration configuration

Parameters:

e - the enumeration value

Returns:

the parsed content

Throws:

java.lang.IllegalArgumentException - In case the annotation could not be resolved

valueOf

public <T extends java.lang.Enum<T>> T valueOf(java.lang.Class<T> enumType,
                                               java.lang.String name)

Returns the enum constant of the specified enum type with the specified name. The name must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Type Parameters:

T - the type

Parameters:

enumType - the Class object of the enum type from which to return a constant

name - the name of the constant to return

Returns:

the enum constant of the specified enum type with the specified name

mapEnum

public <T extends java.lang.Enum<T>> T mapEnum(java.lang.Class<T> enumType,
                                               java.lang.Enum<?> inputEnum)

Returns the enum constant of the specified enum type with the specified name. The name must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Type Parameters:

T - the type

Parameters:

enumType - the Class object of the enum type from which to return a constant

inputEnum - the input enum to map

Returns:

the enum constant of the specified enum type with the specified name