This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
java.lang
class Enum
- All Implemented Interfaces:
- Serializable, Comparable
- Direct Known Subclasses:
- Authenticator.RequestorType, ClientInfoStatus, Component.BaselineResizeBehavior, Desktop.Action, Diagnostic.Kind, Dialog.ModalExclusionType, Dialog.ModalityType, DropMode, ElementKind, ElementType, Formatter.BigDecimalLayoutForm, FormSubmitEvent.MethodType, GroupLayout.Alignment, JavaFileObject.Kind, JTable.PrintMode, KeyRep.Type, LayoutStyle.ComponentPlacement, MemoryType, MessageContext.Scope, Modifier, MultipleGradientPaint.ColorSpaceType, MultipleGradientPaint.CycleMethod, NestingKind, Normalizer.Form, Proxy.Type, Resource.AuthenticationType, RetentionPolicy, RoundingMode, RowFilter.ComparisonType, RowIdLifetime, RowSorterEvent.Type, Service.Mode, SortOrder, SourceVersion, SSLEngineResult.HandshakeStatus, SSLEngineResult.Status, StandardLocation, SwingWorker.StateValue, Thread.State, TimeUnit, TrayIcon.MessageType, TypeKind, XmlAccessOrder, XmlAccessType, XmlNsForm
public abstract class Enum
extends Object
implements Comparable, Serializable
This is the common base class of all Java language enumeration types.
Constructor Summary |
protected |
Sole constructor.
|
Method Summary |
protected Object |
Throws CloneNotSupportedException.
|
int |
Compares this enum with the specified object for order.
|
boolean |
Returns true if the specified object is equal to this
enum constant.
|
protected void |
enum classes cannot have finalize methods.
|
Class |
Returns the Class object corresponding to this enum constant's
enum type.
|
int |
Returns a hash code for this enum constant.
|
String |
Returns the name of this enum constant, exactly as declared in its
enum declaration.
|
int |
Returns the ordinal of this enumeration constant (its position
in its enum declaration, where the initial constant is assigned
an ordinal of zero).
|
String |
Returns the name of this enum constant, as contained in the
declaration.
|
static Enum |
Returns the enum constant of the specified enum type with the
specified name.
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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).
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
in class Object
- Returns:
- (never returns)
- Throws:
CloneNotSupportedException
compareTo
public final 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.
- Parameters:
o
equals
public final boolean equals(Object other)
-
Returns true if the specified object is equal to this
enum constant.
- Overrides:
equals
in class 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.
finalize
protected final void finalize()
-
enum classes cannot have finalize methods.
- Overrides:
finalize
in class Object
getDeclaringClass
public final Class 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 {@link Object#getClass} method for enum constants with
constant-specific class bodies.)
- Returns:
- the Class object corresponding to this enum constant's
enum type
hashCode
public final int hashCode()
-
Returns a hash code for this enum constant.
- Overrides:
hashCode
in class Object
- Returns:
- a hash code for this enum constant.
name
public final String name()
-
Returns the name of this enum constant, exactly as declared in its
enum declaration.
Most programmers should use the {@link #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 {@link java.util.EnumSet} and {@link java.util.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
in class Object
- Returns:
- the name of this enum constant
valueOf
public static Enum 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
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.