Modifier and Type	Class and Description
public static class	Enum.EnumDesc< the type of the enum constant E extends Enum<E>> A nominal descriptor for an `enum` constant.

Modifier and Type	Field and Description
private int	hash The hash code of this enumeration constant.
private final String	name The name of this enum constant, as declared in the enum declaration.
private final int	ordinal The ordinal of this enumeration constant (its position in the enum declaration, where the initial constant is assigned an ordinal of zero).

Access	Constructor and Description
protected	Enum(String The name of this enum constant, which is the identifier used to declare it. name, int The ordinal of this enumeration constant (its position in the enum declaration, where the initial constant is assigned an ordinal of zero). ordinal) Sole constructor.

Method Summary

Modifier and Type	Method and Description
protected final Object	Returns: (never returns) clone() Overrides java.lang.Object.clone. Throws CloneNotSupportedException.
public final int	compareTo(E the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this enum with the specified object for order.
public final Optional<Enum.EnumDesc<E>>	Returns: An `Optional` containing the resulting nominal descriptor, or an empty `Optional` if one cannot be constructed. describeConstable() Implements java.lang.constant.Constable.describeConstable. Returns an enum descriptor `EnumDesc` for this instance, if one can be constructed, or an empty `Optional` if one cannot be.
public final boolean	Returns: true if the specified object is equal to this enum constant. equals(Object the object to be compared for equality with this object. other) Overrides java.lang.Object.equals. Returns true if the specified object is equal to this enum constant.
protected final void	finalize() Overrides java.lang.Object.finalize. Deprecated for removal since 18. Finalization has been deprecated for removal. See `java.lang.Object#finalize` for background information and details about migration options. enum classes cannot have finalize methods.
public final Class<E>	Returns: the Class object corresponding to this enum constant's enum type getDeclaringClass() Returns the Class object corresponding to this enum constant's enum type.
public final int	Returns: a hash code for this enum constant. hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this enum constant.
public final String	Returns: the name of this enum constant name() Returns the name of this enum constant, exactly as declared in its enum declaration.
public final int	Returns: the ordinal of this enumeration constant ordinal() Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
private void	readObject(ObjectInputStream in) prevent default deserialization
private void	readObjectNoData()
public String	Returns: the name of this enum constant toString() Overrides java.lang.Object.toString. Returns the name of this enum constant, as contained in the declaration.
public static < The enum class whose constant is to be returned T extends Enum<T>> T	Returns: the enum constant of the specified enum class with the specified name valueOf(Class<T> the `Class` object of the enum class from which to return a constant enumClass, String the name of the constant to return name) Returns the enum constant of the specified enum class with the specified name.

Inherited from java.lang.Object:: getClass notify notifyAll wait wait wait

Field Detail

hash	back to summary
private int hash The hash code of this enumeration constant. Annotations @Stable

name	back to summary
private final String name The name of this enum constant, as declared in the enum declaration. Most programmers should use the `toString` method rather than accessing this field.

ordinal	back to summary
private final int ordinal The ordinal of this enumeration constant (its position in the enum declaration, where the initial constant is assigned an ordinal of zero). Most programmers will have no use for this field. It is designed for use by sophisticated enum-based data structures, such as `java.util.EnumSet` and `java.util.EnumMap`.

Constructor Detail

Enum	back to summary
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 class declarations. Parameters name:String The name of this enum constant, which is the identifier used to declare it. ordinal:int The ordinal of this enumeration constant (its position in the enum declaration, where the initial constant is assigned an ordinal of zero).

Enum

back to summary

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 class declarations.

Parameters

name:String: The name of this enum constant, which is the identifier used to declare it.
ordinal:int: The ordinal of this enumeration constant (its position in the enum declaration, where the initial constant is assigned an ordinal of zero).

Method Detail

clone back to summary

clone	back to summary
protected final Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status. Returns:Object (never returns) Exceptions CloneNotSupportedException: Doc from java.lang.Object.clone. 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.

protected final Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status.

Returns:Object

(never returns)

Exceptions

CloneNotSupportedException:

Doc from java.lang.Object.clone.

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.

compareTo	back to summary
public final int compareTo(E o) Implements java.lang.Comparable.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. Parameters o:E Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

compareTo

back to summary

public final int compareTo(E o)

Implements java.lang.Comparable.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.

Parameters

o:E

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

describeConstable back to summary

describeConstable	back to summary
public final Optional<Enum.EnumDesc<E>> describeConstable() Implements java.lang.constant.Constable.describeConstable. Returns an enum descriptor `EnumDesc` for this instance, if one can be constructed, or an empty `Optional` if one cannot be. Returns:Optional<Enum.EnumDesc<E>> An `Optional` containing the resulting nominal descriptor, or an empty `Optional` if one cannot be constructed. Annotations @Override Since 12

public final Optional<Enum.EnumDesc<E>> describeConstable()

Implements java.lang.constant.Constable.describeConstable.

Returns an enum descriptor EnumDesc for this instance, if one can be constructed, or an empty Optional if one cannot be.

Returns:Optional<Enum.EnumDesc<E>>

An Optional containing the resulting nominal descriptor, or an empty Optional if one cannot be constructed.

Annotations

@Override

Since

equals	back to summary
public final boolean equals(Object other) Overrides java.lang.Object.equals. Returns true if the specified object is equal to this enum constant. Parameters other:Object the object to be compared for equality with this object. Returns:boolean true if the specified object is equal to this enum constant.

equals

back to summary

public final boolean equals(Object other)

Overrides java.lang.Object.equals.

Returns true if the specified object is equal to this enum constant.

Parameters

other:Object: the object to be compared for equality with this object.

Returns:boolean

true if the specified object is equal to this enum constant.

finalize back to summary

finalize	back to summary
protected final void finalize() Overrides java.lang.Object.finalize. Deprecated for removal since 18. Finalization has been deprecated for removal. See `java.lang.Object#finalize` for background information and details about migration options. enum classes cannot have finalize methods. Annotations @Deprecated since:18 forRemoval:true @SuppressWarnings:removal

protected final void finalize()

Overrides java.lang.Object.finalize.

Deprecated

for removal since 18.

Finalization has been deprecated for removal. See java.lang.Object#finalize for background information and details about migration options.

enum classes cannot have finalize methods.

Annotations

@Deprecated
since:18
forRemoval:true
@SuppressWarnings:removal

getDeclaringClass back to summary

getDeclaringClass	back to summary
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:Class<E> the Class object corresponding to this enum constant's enum type Annotations @SuppressWarnings:unchecked

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:Class<E>

the Class object corresponding to this enum constant's enum type

Annotations

@SuppressWarnings:unchecked

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this enum constant. Returns:int a hash code for this enum constant.

hashCode

back to summary

public final int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code for this enum constant.

Returns:int: a hash code for this enum constant.

name back to summary

name	back to summary
public final String name() 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:String the name of this enum constant

public final String name()

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:String: the name of this enum constant

ordinal back to summary

ordinal	back to summary
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`. Returns:int the ordinal of this enumeration 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 java.util.EnumSet and java.util.EnumMap.

Returns:int: the ordinal of this enumeration constant

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException prevent default deserialization Annotations @Serial

readObject

back to summary

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

prevent default deserialization

Annotations

@Serial

readObjectNoData	back to summary
private void readObjectNoData() throws ObjectStreamException Annotations @Serial

toString	back to summary
public String toString() Overrides java.lang.Object.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 class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant

toString

back to summary

public String toString()

Overrides java.lang.Object.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 class should override this method when a more "programmer-friendly" string form exists.

Returns:String: the name of this enum constant

valueOf back to summary

valueOf	back to summary
public static <T extends Enum<T>> T valueOf(Class<T> enumClass, String name) 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. Parameters <T> The enum class whose constant is to be returned enumClass:Class<T> the `Class` object of the enum class from which to return a constant name:String the name of the constant to return Returns:T the enum constant of the specified enum class with the specified name Exceptions 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 Since 1.5

public static <T extends Enum<T>> T valueOf(Class<T> enumClass, String name)

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.

Parameters

<T>: The enum class whose constant is to be returned
enumClass:Class<T>: the Class object of the enum class from which to return a constant
name:String: the name of the constant to return

Returns:T

the enum constant of the specified enum class with the specified name

Exceptions

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

Since

1.5

java.lang back to summary

public final Class Enum.EnumDesc<E extends Enum<E>>

Class Inheritance

extends DynamicConstantDesc<E extends Enum<E>>

Type Parameters

<E>: the type of the enum constant

A nominal descriptor for an enum constant.

Since: 12

Constructor Summary

Access	Constructor and Description
private	EnumDesc(ClassDesc a `ClassDesc` describing the `enum` class constantClass, String the unqualified name of the enum constant constantName) Constructs a nominal descriptor for the specified `enum` class and name.

Method Summary

Modifier and Type	Method and Description
public static < the type of the enum constant E extends Enum<E>> Enum.EnumDesc<E>	Returns: the nominal descriptor of(ClassDesc a `ClassDesc` describing the `enum` class enumClass, String the unqualified name of the enum constant constantName) Returns a nominal descriptor for the specified `enum` class and name
public E	resolveConstantDesc(MethodHandles.Lookup The `MethodHandles.Lookup` to provide name resolution and access control context lookup) Overrides java.lang.constant.DynamicConstantDesc.resolveConstantDesc. Implements java.lang.constant.ConstantDesc.resolveConstantDesc. Resolves this descriptor reflectively, emulating the resolution behavior of JVMS 5.4.3 and the access control behavior of JVMS 5.4.4.
public String	toString() Overrides java.lang.constant.DynamicConstantDesc.toString. Returns a compact textual description of this constant description, including the bootstrap method, the constant name and type, and the static bootstrap arguments.

Inherited from java.lang.constant.DynamicConstantDesc:: bootstrapArgs bootstrapArgsList bootstrapMethod constantName constantType equals hashCode of of ofCanonical ofNamed

Constructor Detail

EnumDesc back to summary

EnumDesc	back to summary
private EnumDesc(ClassDesc constantClass, String constantName) Constructs a nominal descriptor for the specified `enum` class and name. Parameters constantClass:ClassDesc a `ClassDesc` describing the `enum` class constantName:String the unqualified name of the enum constant Exceptions NullPointerException: if any argument is null Java Virtual Machine Specification 4.2.2 Unqualified Names

private EnumDesc(ClassDesc constantClass, String constantName)

Constructs a nominal descriptor for the specified enum class and name.

Parameters

constantClass:ClassDesc: a ClassDesc describing the enum class
constantName:String: the unqualified name of the enum constant

Exceptions

NullPointerException:: if any argument is null

Java Virtual Machine Specification

4.2.2 Unqualified Names

Method Detail

of back to summary

of	back to summary
public static <E extends Enum<E>> Enum.EnumDesc<E> of(ClassDesc enumClass, String constantName) Returns a nominal descriptor for the specified `enum` class and name Parameters <E> the type of the enum constant enumClass:ClassDesc a `ClassDesc` describing the `enum` class constantName:String the unqualified name of the enum constant Returns:Enum.EnumDesc<E> the nominal descriptor Exceptions NullPointerException: if any argument is null Since 12 Java Virtual Machine Specification 4.2.2 Unqualified Names

public static <E extends Enum<E>> Enum.EnumDesc<E> of(ClassDesc enumClass, String constantName)

Returns a nominal descriptor for the specified enum class and name

Parameters

<E>: the type of the enum constant
enumClass:ClassDesc: a ClassDesc describing the enum class
constantName:String: the unqualified name of the enum constant

Returns:Enum.EnumDesc<E>

the nominal descriptor

Exceptions

NullPointerException:: if any argument is null

Since

Java Virtual Machine Specification

4.2.2 Unqualified Names

resolveConstantDesc back to summary

resolveConstantDesc	back to summary
public E resolveConstantDesc(MethodHandles.Lookup lookup) throws ReflectiveOperationException Overrides java.lang.constant.DynamicConstantDesc.resolveConstantDesc. Implements java.lang.constant.ConstantDesc.resolveConstantDesc. Doc from java.lang.constant.ConstantDesc.resolveConstantDesc. Resolves this descriptor reflectively, emulating the resolution behavior of JVMS 5.4.3 and the access control behavior of JVMS 5.4.4. The resolution and access control context is provided by the `MethodHandles.Lookup` parameter. No caching of the resulting value is performed. Parameters lookup:MethodHandles.Lookup The `MethodHandles.Lookup` to provide name resolution and access control context Returns:E the resolved constant value Annotations @Override @SuppressWarnings:unchecked Exceptions ReflectiveOperationException: if a class, method, or field could not be reflectively resolved in the course of resolution

public E resolveConstantDesc(MethodHandles.Lookup lookup) throws ReflectiveOperationException

Overrides java.lang.constant.DynamicConstantDesc.resolveConstantDesc.

Implements java.lang.constant.ConstantDesc.resolveConstantDesc.

Doc from java.lang.constant.ConstantDesc.resolveConstantDesc.

Resolves this descriptor reflectively, emulating the resolution behavior of JVMS 5.4.3 and the access control behavior of JVMS 5.4.4. The resolution and access control context is provided by the MethodHandles.Lookup parameter. No caching of the resulting value is performed.

Parameters

lookup:MethodHandles.Lookup: The MethodHandles.Lookup to provide name resolution and access control context

Returns:E

the resolved constant value

Annotations

@Override
@SuppressWarnings:unchecked

Exceptions

ReflectiveOperationException:: if a class, method, or field could not be reflectively resolved in the course of resolution

toString	back to summary
public String toString() Overrides java.lang.constant.DynamicConstantDesc.toString. Doc from java.lang.constant.DynamicConstantDesc.toString. Returns a compact textual description of this constant description, including the bootstrap method, the constant name and type, and the static bootstrap arguments. Returns:String A compact textual description of this call site descriptor Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.constant.DynamicConstantDesc.toString.

Doc from java.lang.constant.DynamicConstantDesc.toString.

Returns a compact textual description of this constant description, including the bootstrap method, the constant name and type, and the static bootstrap arguments.

Returns:String

A compact textual description of this call site descriptor

Annotations

@Override

public abstract Class Enum<E extends Enum<E>>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Enum.EnumDesc<E extends Enum<E>>

Constructor Summary

Method Summary

Constructor Detail

Method Detail