Class: java.lang.Enum<E extends Enum<E>>

This is the common base class of all Java language enumeration types.
Authors:
@author Josh Bloch
@author Neal Gafter
See:
@see Class.getEnumConstants()
Since:
@since 1.5

Inheritance

Superclass tree: Implements:

Methods

  • Enumtop

    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:
    @param name - The name of this enum constant, which is the identifier used to declare it.
    @param ordinal - The ordinal of this enumeration constant (its position in the enum declaration, where the initial constant is assigned an ordinal of zero).
    Related Links:
    Google Code Search
    Stack Overflow

  • clonetop

    final protected Object clone() throws CloneNotSupportedException
    Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status.
    Return:
    @return (never returns)
    Exceptions:
    @exception 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.
    Override hierarchy:
    clone from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • compareTotop

    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.
    Parameters:
    @param o the object to be compared.
    Return:
    @return a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    Specified by:
    compareTo from Comparable<E>
    Related Links:
    Google Code Search
    Stack Overflow

  • equalstop

    public final boolean equals(Object other)
    Returns true if the specified object is equal to this enum constant.
    Parameters:
    @param other the object to be compared for equality with this object.
    Return:
    @return true if the specified object is equal to this enum constant.
    Override hierarchy:
    equals from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • finalizetop

    final protected void finalize()
    enum classes cannot have finalize methods.
    Override hierarchy:
    finalize from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • getDeclaringClasstop

    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.)
    Return:
    @return the Class object corresponding to this enum constant's enum type
    Related Links:
    Google Code Search
    Stack Overflow

  • hashCodetop

    public final int hashCode()
    Returns a hash code for this enum constant.
    Return:
    @return a hash code for this enum constant.
    Override hierarchy:
    hashCode from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • nametop

    public final String name()
    Returns the name of this enum constant, exactly as declared in its enum declaration. Most programmers should use the 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.
    Return:
    @return the name of this enum constant
    Related Links:
    Google Code Search
    Stack Overflow

  • ordinaltop

    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 java.util.EnumSet and java.util.EnumMap.
    Return:
    @return the ordinal of this enumeration constant
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    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.
    Return:
    @return the name of this enum constant
    Override hierarchy:
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • valueOftop

    public static <T extends Enum<T>> T valueOf(Class<T> 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:
    @param enumType the Class object of the enum type from which to return a constant
    @param name the name of the constant to return
    Return:
    @return the enum constant of the specified enum type with the specified name
    Exceptions:
    @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:
    @since 1.5
    Related Links:
    Google Code Search
    Stack Overflow