|
|
FlexDoc/Javadoc 2.0
Demo Java Doc |
Class Enum<E extends Enum<E>>
java.lang.Enum<E>
Type Parameters:
E - The type of the enum subclass
All Implemented Interfaces:
public abstract class Enum<E extends Enum<E>>
This is the common base class of all Java language enumeration classes.
More information about enums, including descriptions of the
implicitly declared methods synthesized by the compiler, can be
found in section {@jls 8.9} of
The Java Language
Specification.
Enumeration classes are all serializable and receive special handling
by the serialization mechanism. The serialized representation used
for enum constants cannot be customized. Declarations of methods
and fields that would otherwise interact with serialization are
ignored, including
serialVersionUID; see the
Java
Object Serialization Specification for details.
Note that when using an enumeration type as the type of a set
or as the type of the keys in a map, specialized and efficient
set and map implementations are available.
Since:
1.5
Author:
Josh Bloch, Neal Gafter
See Also:
Nested Class Summary |
static class |
|
Constructor Summary |
protected |
Sole constructor.
|
Method Summary |
|
Throws CloneNotSupportedException.
|
final int |
Compares this enum with the specified object for order.
|
|
Returns an enum descriptor EnumDesc for this instance, if one can be
constructed, or an empty Optional if one cannot be. |
final boolean |
Returns true if the specified object is equal to this
enum constant.
|
protected final void |
enum classes cannot have finalize methods.
|
|
Returns the Class object corresponding to this enum constant's
enum type.
|
final int |
Returns a hash code for this enum constant.
|
|
Returns the name of this enum constant, exactly as declared in its
enum declaration.
|
final int |
Returns the ordinal of this enumeration constant (its position
in its enum declaration, where the initial constant is assigned
an ordinal of zero).
|
|
Returns the name of this enum constant, as contained in the
declaration.
|
|
Returns the enum constant of the specified enum class with the
specified name.
|
Methods inherited from class java.lang. Object |
|
Sole constructor. Programmers cannot invoke this constructor.
It is for use by code emitted by the compiler in response to
enum class 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).
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
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
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 class should override this
method when a more "programmer-friendly" string form exists.
Overrides:
Returns:
the name of this enum constant
public final boolean equals |
|
Returns true if the specified object is equal to this
enum constant.
Overrides:
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:
public final int hashCode |
() |
Returns a hash code for this enum constant.
Overrides:
Returns:
a hash code for this enum constant.
See Also:
Throws CloneNotSupportedException. This guarantees that enums
are never cloned, which is necessary to preserve their "singleton"
status.
Overrides:
Returns:
(never returns)
Throws:
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:
public final int compareTo |
|
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:
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.
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
Returns an enum descriptor
EnumDesc for this instance, if one can be
constructed, or an empty
Optional if one cannot be.
Specified by:
Returns:
An
Optional containing the resulting nominal descriptor,
or an empty
Optional if one cannot be constructed.
12
public static < T extends Enum< T>> T valueOf |
|
Returns the enum constant of the specified enum class with the
specified name. The name must match exactly an identifier used
to declare an enum constant in this class. (Extraneous whitespace
characters are not permitted.)
Note that for a particular enum class T, the
implicitly declared public static T valueOf(String)
method on that enum may be used instead of this method to map
from a name to the corresponding enum constant. All the
constants of an enum class can be obtained by calling the
implicit public static T[] values() method of that
class.
Type Parameters:
T - The enum class whose constant is to be returned
Parameters:
enumClass - the
Class object of the enum class from which
to return a constant
name - the name of the constant to return
Returns:
the enum constant of the specified enum class with the
specified name
Throws:
IllegalArgumentException - if the specified enum class has
no constant with the specified name, or the specified
class object does not represent an enum class
Since:
1.5
protected final void finalize |
() |
enum classes cannot have finalize methods.
Overrides:
See Also:
|
|
FlexDoc/Javadoc 2.0
Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz