java.lang
Class Enum<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.lang.Enum<E>
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <E>

public abstract class Enum<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <E>, Serializable sample code for java.io.Serializable definition code for java.io.Serializable

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

Since:
1.5
See Also:
Serialized Form

Constructor Summary
protected Enum sample code for java.lang.Enum.Enum(java.lang.String, int) definition code for java.lang.Enum.Enum(java.lang.String, int) (String sample code for java.lang.String definition code for java.lang.String  name, int ordinal)
          Sole constructor.
 
Method Summary
protected  Object sample code for java.lang.Object definition code for java.lang.Object clone sample code for java.lang.Enum.clone() definition code for java.lang.Enum.clone() ()
          Throws CloneNotSupportedException.
 int compareTo sample code for java.lang.Enum.compareTo(E) definition code for java.lang.Enum.compareTo(E) (E o)
          Compares this enum with the specified object for order.
 boolean equals sample code for java.lang.Enum.equals(java.lang.Object) definition code for java.lang.Enum.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  other)
          Returns true if the specified object is equal to this enum constant.
 Class sample code for java.lang.Class definition code for java.lang.Class <E> getDeclaringClass sample code for java.lang.Enum.getDeclaringClass() definition code for java.lang.Enum.getDeclaringClass() ()
          Returns the Class object corresponding to this enum constant's enum type.
 int hashCode sample code for java.lang.Enum.hashCode() definition code for java.lang.Enum.hashCode() ()
          Returns a hash code for this enum constant.
 String sample code for java.lang.String definition code for java.lang.String name sample code for java.lang.Enum.name() definition code for java.lang.Enum.name() ()
          Returns the name of this enum constant, exactly as declared in its enum declaration.
 int ordinal sample code for java.lang.Enum.ordinal() definition code for java.lang.Enum.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 sample code for java.lang.String definition code for java.lang.String toString sample code for java.lang.Enum.toString() definition code for java.lang.Enum.toString() ()
          Returns the name of this enum constant, as contained in the declaration.
static
<T extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <T>>
T
valueOf sample code for java.lang.Enum.valueOf(java.lang.Class, java.lang.String) definition code for java.lang.Enum.valueOf(java.lang.Class, java.lang.String) (Class sample code for java.lang.Class definition code for java.lang.Class <T> enumType, String sample code for java.lang.String definition code for java.lang.String  name)
          Returns the enum constant of the specified enum type with the specified name.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

Enum sample code for java.lang.Enum(java.lang.String, int) definition code for java.lang.Enum(java.lang.String, int)

protected Enum(String sample code for java.lang.String definition code for java.lang.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 sample code for java.lang.Enum.name() definition code for java.lang.Enum.name()

public final String sample code for java.lang.String definition code for java.lang.String  name()
Returns the name of this enum constant, exactly as declared in its enum declaration. Most programmers should use the toString() sample code for java.lang.Enum.toString() definition code for java.lang.Enum.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 sample code for java.lang.Enum.ordinal() definition code for java.lang.Enum.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 sample code for java.util.EnumSet definition code for java.util.EnumSet and EnumMap sample code for java.util.EnumMap definition code for java.util.EnumMap .

Returns:
the ordinal of this enumeration constant

toString sample code for java.lang.Enum.toString() definition code for java.lang.Enum.toString()

public String sample code for java.lang.String definition code for java.lang.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 sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the name of this enum constant

equals sample code for java.lang.Enum.equals(java.lang.Object) definition code for java.lang.Enum.equals(java.lang.Object)

public final boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  other)
Returns true if the specified object is equal to this enum constant.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
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() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for java.lang.Enum.hashCode() definition code for java.lang.Enum.hashCode()

public final int hashCode()
Returns a hash code for this enum constant.

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a hash code for this enum constant.
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

clone sample code for java.lang.Enum.clone() definition code for java.lang.Enum.clone()

protected final Object sample code for java.lang.Object definition code for java.lang.Object  clone()
                      throws CloneNotSupportedException sample code for java.lang.CloneNotSupportedException definition code for java.lang.CloneNotSupportedException 
Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status.

Overrides:
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
(never returns)
Throws:
CloneNotSupportedException sample code for java.lang.CloneNotSupportedException definition code for java.lang.CloneNotSupportedException - 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 sample code for java.lang.Cloneable definition code for java.lang.Cloneable

compareTo sample code for java.lang.Enum.compareTo(E) definition code for java.lang.Enum.compareTo(E)

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 sample code for java.lang.Comparable.compareTo(T) definition code for java.lang.Comparable.compareTo(T) in interface Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
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 sample code for java.lang.Enum.getDeclaringClass() definition code for java.lang.Enum.getDeclaringClass()

public final Class sample code for java.lang.Class definition code for java.lang.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() sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() method for enum constants with constant-specific class bodies.)

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

valueOf sample code for java.lang.Enum.<T extends java.lang.Enum<T>>valueOf(java.lang.Class<T>, java.lang.String) definition code for java.lang.Enum.<T extends java.lang.Enum<T>>valueOf(java.lang.Class<T>, java.lang.String)

public static <T extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <T>> T valueOf(Class sample code for java.lang.Class definition code for java.lang.Class <T> enumType,
                                            String sample code for java.lang.String definition code for java.lang.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the specified enum type has no constant with the specified name, or the specified class object does not represent an enum type
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if enumType or name is null
Since:
1.5