E - The type of the enum subclass
Serializable, Comparable<E>, Constable
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
8.9of
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 Specificationfor 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.
Nested Classes
Constructors
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
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.
static <T extends Enum<T>>
T
Returns the enum constant of the specified enum class with the specified name.
Sole constructor. Programmers cannot invoke this constructor. It is for use by code emitted by the compiler in response to enum class 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).
Returns the name of this enum constant, exactly as declared in its enum declaration.
Most programmers should use thetoString() 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.
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 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.
Returns true if the specified object is equal to this enum constant.
public final int hashCode()
Returns a hash code for this enum constant.
Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status.
clone in class Object
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.
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.
compareTo in interface Comparable<E extends Enum<E>>
o - the object to be compared.
()
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 an enum descriptor
EnumDesc
for this instance, if one can be constructed, or an empty
Optional
if one cannot be.
describeConstable in interface Constable
Optional containing the resulting nominal descriptor, or an empty Optional if one cannot be constructed.
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.
T - The enum class whose constant is to be returned
enumClass - the Class object of the enum class from which to return a constant
name - the name of the constant to return
IllegalArgumentException - if the specified enum class has no constant with the specified name, or the specified class object does not represent an enum class
NullPointerException - if enumClass or name is null
enum classes cannot have finalize methods.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4