Enum (Java 2 Platform SE 5.0) (original) (raw)

java.lang

Class Enum<E extends Enum>

java.lang.Object extended by java.lang.Enum

All Implemented Interfaces:

Serializable, Comparable

public abstract class Enum<E extends Enum>

extends Object

implements Comparable, Serializable

This is the common base class of all Java language enumeration types.

Since:

1.5

See Also:

Serialized Form

Constructor Summary
protected	[Enum](../../java/lang/Enum.html#Enum%28java.lang.String, int%29)(String name, int ordinal) Sole constructor.

Method Summary
protected Object	clone() Throws CloneNotSupportedException.
int	compareTo(E o) Compares this enum with the specified object for order.
boolean	equals(Object other) Returns true if the specified object is equal to this enum constant.
Class<E>	getDeclaringClass() Returns the Class object corresponding to this enum constant's enum type.
int	hashCode() Returns a hash code for this enum constant.
String	name() Returns the name of this enum constant, exactly as declared in its enum declaration.
int	ordinal() Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
String	toString() Returns the name of this enum constant, as contained in the declaration.
static <T extends Enum> T	[valueOf](../../java/lang/Enum.html#valueOf%28java.lang.Class, java.lang.String%29)(Class enumType,String name) Returns the enum constant of the specified enum type with the specified name.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

Enum

protected Enum(String name, int ordinal)

Sole constructor. Programmers cannot invoke this constructor. It is for use by code emitted by the compiler in response to enum type declarations.

Parameters:

name - - The name of this enum constant, which is the identifier used to declare it.

ordinal - - The ordinal of this enumeration constant (its position in the enum declaration, where the initial constant is assigned an ordinal of zero).

Method Detail

name

public final String name()

Returns the name of this enum constant, exactly as declared in its enum declaration.Most programmers should use the toString() method in preference to this one, as the toString method may return a more user-friendly name. This method is designed primarily for use in specialized situations where correctness depends on getting the exact name, which will not vary from release to release.

Returns:

the name of this enum constant

ordinal

public final int ordinal()

Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero). Most programmers will have no use for this method. It is designed for use by sophisticated enum-based data structures, such as EnumSet and EnumMap.

Returns:

the ordinal of this enumeration constant

toString

public String toString()

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum type should override this method when a more "programmer-friendly" string form exists.

Overrides:

[toString](../../java/lang/Object.html#toString%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

the name of this enum constant

equals

public final boolean equals(Object other)

Returns true if the specified object is equal to this enum constant.

Overrides:

[equals](../../java/lang/Object.html#equals%28java.lang.Object%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Parameters:

other - the object to be compared for equality with this object.

Returns:

true if the specified object is equal to this enum constant.

See Also:

Object.hashCode(), Hashtable

hashCode

public final int hashCode()

Returns a hash code for this enum constant.

Overrides:

[hashCode](../../java/lang/Object.html#hashCode%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a hash code for this enum constant.

clone

protected final Object clone() throws CloneNotSupportedException

Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status.

Overrides:

[clone](../../java/lang/Object.html#clone%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

(never returns)

Throws:

[CloneNotSupportedException](../../java/lang/CloneNotSupportedException.html "class in java.lang") - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

See Also:

Cloneable

compareTo

public final int compareTo(E o)

Compares this enum with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Enum constants are only comparable to other enum constants of the same enum type. The natural order implemented by this method is the order in which the constants are declared.

Specified by:

[compareTo](../../java/lang/Comparable.html#compareTo%28T%29) in interface [Comparable](../../java/lang/Comparable.html "interface in java.lang")<[E](../../java/lang/Enum.html "type parameter in Enum") extends [Enum](../../java/lang/Enum.html "class in java.lang")<[E](../../java/lang/Enum.html "type parameter in Enum")>>

Parameters:

o - the Object to be compared.

Returns:

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

getDeclaringClass

public final Class<E> getDeclaringClass()

Returns the Class object corresponding to this enum constant's enum type. Two enum constants e1 and e2 are of the same enum type if and only if e1.getDeclaringClass() == e2.getDeclaringClass(). (The value returned by this method may differ from the one returned by the Object.getClass() method for enum constants with constant-specific class bodies.)

Returns:

the Class object corresponding to this enum constant's enum type

valueOf

public static <T extends Enum> T valueOf(Class enumType, String name)

Returns the enum constant of the specified enum type with the specified name. The name must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

enumType - the Class object of the enum type from which to return a constant

name - the name of the constant to return

Returns:

the enum constant of the specified enum type with the specified name

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if the specified enum type has no constant with the specified name, or the specified class object does not represent an enum type

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if enumType or name is null

Since:

1.5

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.