|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.lang.enums.EnumUtils
public class EnumUtils
Utility class for accessing and manipulating Enum
s.
Enum
,
ValuedEnum
Constructor Summary | |
---|---|
EnumUtils()
Public constructor. |
Method Summary | |
---|---|
static ValuedEnum |
getEnum(Class enumClass,
int value)
Gets a ValuedEnum object by class and value. |
static Enum |
getEnum(Class enumClass,
String name)
Gets an Enum object by class and name. |
static List |
getEnumList(Class enumClass)
Gets the List of Enum objects using
the Enum class. |
static Map |
getEnumMap(Class enumClass)
Gets the Map of Enum objects by
name using the Enum class. |
static Iterator |
iterator(Class enumClass)
Gets an Iterator over the Enum objects
in an Enum class. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EnumUtils()
Method Detail |
---|
public static Enum getEnum(Class enumClass, String name)
Gets an Enum
object by class and name.
enumClass
- the class of the Enum
to getname
- the name of the Enum to get, may be null
IllegalArgumentException
- if the enum class is null
public static ValuedEnum getEnum(Class enumClass, int value)
Gets a ValuedEnum
object by class and value.
enumClass
- the class of the Enum
to getvalue
- the value of the Enum
to get
IllegalArgumentException
- if the enum class is null
public static Map getEnumMap(Class enumClass)
Gets the Map
of Enum
objects by
name using the Enum
class.
If the requested class has no enum objects an empty
Map
is returned. The Map
is unmodifiable.
enumClass
- the class of the Enum
to get
IllegalArgumentException
- if the enum class is null
IllegalArgumentException
- if the enum class is not a subclass
of Enum
public static List getEnumList(Class enumClass)
Gets the List
of Enum
objects using
the Enum
class.
The list is in the order that the objects were created (source code order).
If the requested class has no enum objects an empty
List
is returned. The List
is unmodifiable.
enumClass
- the class of the Enum to get
IllegalArgumentException
- if the enum class is null
IllegalArgumentException
- if the enum class is not a subclass
of Enum
public static Iterator iterator(Class enumClass)
Gets an Iterator
over the Enum
objects
in an Enum
class.
The iterator is in the order that the objects were created (source code order).
If the requested class has no enum objects an empty
Iterator
is returned. The Iterator
is unmodifiable.
enumClass
- the class of the Enum
to get
Iterator
of the Enum
objects
IllegalArgumentException
- if the enum class is null
IllegalArgumentException
- if the enum class is not a subclass of Enum
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |