|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.lang3.EnumUtils
public class EnumUtils
Utility library to provide helper methods for Java enums.
#ThreadSafe#
Constructor Summary | |
---|---|
EnumUtils()
This constructor is public to permit tools that require a JavaBean instance to operate. |
Method Summary | ||
---|---|---|
static
|
getEnum(Class<E> enumClass,
String enumName)
Gets the enum for the class, returning null if not found. |
|
static
|
getEnumList(Class<E> enumClass)
Gets the List of enums . |
|
static
|
getEnumMap(Class<E> enumClass)
Gets the Map of enums by name. |
|
static
|
isValidEnum(Class<E> enumClass,
String enumName)
Checks if the specified name is a valid enum for the 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 <E extends Enum<E>> Map<String,E> getEnumMap(Class<E> enumClass)
Map
of enums
by name.
This method is useful when you need a map of enums by name.
enumClass
- the class of the enum
to get, not null
public static <E extends Enum<E>> List<E> getEnumList(Class<E> enumClass)
List
of enums
.
This method is useful when you need a list of enums rather than an array.
enumClass
- the class of the enum
to get, not null
public static <E extends Enum<E>> boolean isValidEnum(Class<E> enumClass, String enumName)
enum
for the class.
This method differs from Enum.valueOf(java.lang.Class
in that checks if the name is
a valid enum without needing to catch the exception.
enumClass
- the class of the enum
to get, not nullenumName
- the enum name
public static <E extends Enum<E>> E getEnum(Class<E> enumClass, String enumName)
enum
for the class, returning null
if not found.
This method differs from Enum.valueOf(java.lang.Class
in that it does not throw an exception
for an invalid enum name.
enumClass
- the class of the enum
to get, not nullenumName
- the enum name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |