_templates.javolution.lang

Class Enum

java.lang.Object

_templates.javolution.lang.Enum

All Implemented Interfaces:

Serializable, Comparable

public abstract class Enum
extends Object
implements Comparable, Serializable

This class is equivalent to java.lang.Enum and is moved (refactored) to the java.lang system package for applications targetting the J2SE 5.0+ run-time.

This is a clean-room implementation of the Enum base class.

Version:

2.0, November 26, 2004

Author:

Jean-Marie Dautelle

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Enum(String name, int ordinal) Enum's base constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object that) Compares the position of two enum from the same enumeration.
boolean	equals(Object that) Indicates if two enums are equals.
Class	getDeclaringClass() Returns this enum's class.
int	hashCode() Returns the enums' hashcode.
String	name() Returns the name of this enum.
int	ordinal() Returns the position of this enum in the enumeration (starting at 0).
String	toString() Returns the String representation of this enum.
static Enum	valueOf(Class enumType, String name) Returns the enum from the specified enum's class with the specified name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Enum

protected Enum(String name,
               int ordinal)

Enum's base constructor.

Parameters:

name - the enum's name.

ordinal - the enum's position.

Method Detail

name

public final String name()

Returns the name of this enum.

Returns:

the enum's name.

ordinal

public final int ordinal()

Returns the position of this enum in the enumeration (starting at 0).

Returns:

the enum's position.

toString

public String toString()

Returns the String representation of this enum.

Overrides:

toString in class Object

Returns:

the enum's name.

equals

public final boolean equals(Object that)

Indicates if two enums are equals.

Overrides:

equals in class Object

Parameters:

that - the enum to be compared for equality.

Returns:

this == that

hashCode

public final int hashCode()

Returns the enums' hashcode.

Overrides:

hashCode in class Object

Returns:

System.identityHashCode(this)

compareTo

public final int compareTo(Object that)

Compares the position of two enum from the same enumeration.

Specified by:

compareTo in interface Comparable

Parameters:

that - the enum to be compared with.

Returns:

a negative value, zero, or a positive value as this enum is less than, equal to, or greater than the specified enum.

Throws:

ClassCastException - if both enum do not belong to the same enumeration.

getDeclaringClass

public final Class getDeclaringClass()

Returns this enum's class.

Returns:

this.getClass()

valueOf

public static Enum valueOf(Class enumType,
                           String name)

Returns the enum from the specified enum's class with the specified name.

Parameters:

enumType - the enum's declaring class.

name - the name of the enum to return.

Returns:

the corresponding enum.

Throws:

IllegalArgumentException - if the enum does not exist.