com.evrythng.commons

Class EnumUtils

java.lang.Object

com.evrythng.commons.EnumUtils

public class EnumUtils
extends Object

Utility class for the enums.

Constructor Summary

Constructors

Constructor and Description
EnumUtils()

Method Summary

Modifier and Type	Method and Description
static <E> Map<String,E>	createNames(E[] values) Creates a lookup map for the enum names, intended for use with the fromString(Map, String) method.
static <E> E	fromString(Map<String,E> names, String name) Creates an enum value from a string using a lookup map (usually created by createNames(Object[]).
static <E extends Enum<E>> EnumSet<E>	setOf(E[] values) Returns an EnumSet representing the values of the array.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumUtils

public EnumUtils()

Method Detail

fromString

public static <E> E fromString(Map<String,E> names,
                               String name)

Creates an enum value from a string using a lookup map (usually created by createNames(Object[]).

Typical implementation:

 public static MyEnum fromString(String name) {
        return EnumUtils.fromString(names, name);
 }
 

Returns:

The enum value corresponding to the name. If the name is null, returns null.

Throws:

IllegalArgumentException - if the name is not null and does not match any enum value.

createNames

public static <E> Map<String,E> createNames(E[] values)

Creates a lookup map for the enum names, intended for use with the fromString(Map, String) method. It uses the Object.toString() method to build the lookup map. This is intended to be used in a static initializer.

 private static Map<String, MyEnum> names;
 static {
        names = EnumUtils.createNames(values());
 }
 

Parameters:

values - The enum values, as provided by values().

setOf

public static <E extends Enum<E>> EnumSet<E> setOf(E[] values)

Returns an EnumSet representing the values of the array.

Type Parameters:

E - The enum type.

Parameters:

values - The values. This can be null or empty.

Returns:

The EnumSet.