| Methods |
| final protected Object |
clone() throws CloneNotSupportedException Details
Throws CloneNotSupportedException. This guarantees that enums
are never cloned, which is necessary to preserve their "singleton"
status.
|
| final public int |
compareTo(Enum 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.
|
| final public boolean |
equals(Object other) Details
Returns true if the specified object is equal to this
enum constant.
| other | the object to be compared for equality with this object. |
| return | true if the specified object is equal to this
enum constant. |
|
| final protected void |
finalize() enum classes cannot have finalize methods.
|
| final public int |
hashCode() Details
Returns a hash code for this enum constant.
| return | a hash code for this enum constant. |
|
| final public String |
name() Details
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.
| return | the name of this enum constant |
|
| final public int |
ordinal() Details
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 java.util.EnumSet and java.util.EnumMap.
| return | the ordinal of this enumeration constant |
|
| public String |
toString() Details
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.
| return | the name of this enum constant |
|
| public static Enum<T> |
valueOf(Class enumType, String name) Details
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.)
| enumType | the Class object of the enum type from which
to return a constant |
| name | the name of the constant to return |
| return | the enum constant of the specified enum type with the
specified name |
| Throws | IllegalArgumentException: if the specified enum type has
no constant with the specified name, or the specified
class object does not represent an enum type |
| Throws | NullPointerException: if enumType or name
is null |
| since | 1.5 |
|