uk.co.strangeskies.utility

Class Enumeration<S extends Enumeration<S>>

java.lang.Object

uk.co.strangeskies.utility.Enumeration<S>

Type Parameters:

S - Self bounding on the type of the enumeration class.

All Implemented Interfaces:

Self<S>

public class Enumeration<S extends Enumeration<S>>
extends java.lang.Object
implements Self<S>

A reimplementation of Java's Enum class, primarily for the purpose of facilitating enumerations with generics. This class should enforce most of the rules governing enum, including limiting instance creation to static initializer blocks. Unfortunately error detection of such problems is inevitably shifted to runtime rather than compile time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Enumeration(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static <T extends Enumeration> java.util.List<T>	getConstants(java.lang.Class<T> enumerationClass)
int	hashCode()
java.lang.String	name()
S	next()
static <E extends java.lang.Enum<?>> E	next(E item)
int	ordinal()
static java.lang.String	readableName(java.lang.Enum<?> enumItem)
java.lang.String	toString()
static <T extends Enumeration<?>> T	valueOf(java.lang.Class<T> enumerationClass, java.lang.String name) Effectively a reimplementation of valueOf(java.lang.Class<T>, java.lang.String) for the Enumeration class.
static <T extends java.lang.Enum<?>> T	valueOfEnum(java.lang.Class<T> enumerationClass, java.lang.String name) A reimplementation of Enum.valueOf(java.lang.Class<T>, java.lang.String) with less pointlessly restrictive generic bounds.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.co.strangeskies.utility.Self

getThis

Constructor Detail

Enumeration

protected Enumeration(java.lang.String name)

Method Detail

name

public java.lang.String name()

Returns:

The name of this enumeration item instance.

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

ordinal

public int ordinal()

Returns:

The ordinal number of this enumeration item instance.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getConstants

public static <T extends Enumeration> java.util.List<T> getConstants(java.lang.Class<T> enumerationClass)

Type Parameters:

T - The Enumeration class.

Parameters:

enumerationClass - An Enumeration class for which to retrieve all declared constants.

Returns:

A list of all enumeration item instances for the given class, in the order they were declared.

valueOf

public static <T extends Enumeration<?>> T valueOf(java.lang.Class<T> enumerationClass,
                                                   java.lang.String name)

Effectively a reimplementation of valueOf(java.lang.Class<T>, java.lang.String) for the Enumeration class.

Type Parameters:

T - The Enumeration class.

Parameters:

enumerationClass - The class of Enumeration we wish to retrieve an instance of.

name - The name of the instance to retrieve.

Returns:

The instance value with the given name.

valueOfEnum

public static <T extends java.lang.Enum<?>> T valueOfEnum(java.lang.Class<T> enumerationClass,
                                                          java.lang.String name)

A reimplementation of Enum.valueOf(java.lang.Class<T>, java.lang.String) with less pointlessly restrictive generic bounds.

Type Parameters:

T - The Enum class.

Parameters:

enumerationClass - The class of Enum we wish to retrieve an instance of.

name - The name of the instance to retrieve.

Returns:

The instance value with the given name.

readableName

public static java.lang.String readableName(java.lang.Enum<?> enumItem)

Parameters:

enumItem - an enumeration item to make readable, by substituting underscores with spaces, and properly capitalizing

Returns:

a readable version of the given enum item's name

next

public S next()

Returns:

the next enumeration item in the sequence

next

public static <E extends java.lang.Enum<?>> E next(E item)

Type Parameters:

E - the type of the given enum item

Parameters:

item - the enum item we wish to find the next in the sequence from

Returns:

the next enumeration item in the sequence