public abstract class java.lang
Enum<E>


Show All Login
Java SE 6
  
Implements: Comparable, Serializable
Extended by: Authenticator.RequestorType, CardTerminals.State, ClientInfoStatus, Component.BaselineResizeBehavior, DataSetSyncStatus, Desktop.Action, Diagnostic.Kind, Dialog.ModalExclusionType, Dialog.ModalityType, DropMode, ElementKind, ElementType, Formatter.BigDecimalLayoutForm, FormSubmitEvent.MethodType, GeneratedKeys, 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, SOAPBinding.ParameterStyle, SOAPBinding.Style, SOAPBinding.Use, SortOrder, SourceVersion, StandardLocation, SwingWorker.StateValue, Thread.State, TimeUnit, TrayIcon.MessageType, TypeKind, WebParam.Mode, XmlAccessOrder, XmlAccessType, XmlNsForm
Details
This is the common base class of all Java language enumeration types.
version1.15, 01/27/06
since1.5

Constructors
protected Enum(String name, int ordinal) Details
Sole constructor. Programmers cannot invoke this constructor. It is for use by code emitted by the compiler in response to enum type declarations.
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).

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.
return(never returns)
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.
otherthe object to be compared for equality with this object.
returntrue 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.
returna 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.
returnthe 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.
returnthe 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.
returnthe 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.)
enumTypethe Class object of the enum type from which to return a constant
namethe name of the constant to return
returnthe enum constant of the specified enum type with the specified name
ThrowsIllegalArgumentException: if the specified enum type has no constant with the specified name, or the specified class object does not represent an enum type
ThrowsNullPointerException: if enumType or name is null
since1.5

Properties
final public Class getDeclaringClass() Details
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.)
returnthe Class object corresponding to this enum constant's enum type