Enum
abstract class Enum<E : Enum<E>!> : Comparable<E>, Serializable
| kotlin.Any | |
| ↳ | java.lang.Enum |
This is the common base class of all Java language enumeration types. More information about enums, including descriptions of the implicitly declared methods synthesized by the compiler, can be found in section 8.9 of The Java™ Language Specification.
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 implementations are available.
Summary
| Protected constructors | |
|---|---|
|
Sole constructor. |
|
| Public methods | |
|---|---|
| Int |
compareTo(other: E)Compares this enum with the specified object for order. |
| Boolean |
Returns true if the specified object is equal to this enum constant. |
| Class<E> |
Returns the Class object corresponding to this enum constant's enum type. |
| Int |
hashCode()Returns a hash code for this enum constant. |
| String |
name()Returns the name of this enum constant, exactly as declared in its enum declaration. |
| 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). |
| open String |
toString()Returns the name of this enum constant, as contained in the declaration. |
| open static T |
Returns the enum constant of the specified enum type with the specified name. |
| Protected methods | |
|---|---|
| Any |
clone()Throws CloneNotSupportedException. |
| Unit |
finalize()enum classes cannot have finalize methods. |
Protected constructors
<init>
protected Enum(
name: String,
ordinal: Int)
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 |
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). |
Public methods
compareTo
fun compareTo(other: E): Int
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 |
the object to be compared. |
| Return | |
|---|---|
Int |
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
if the specified object is null |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
equals
fun equals(other: Any?): Boolean
Returns true if the specified object is equal to this enum constant.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
other |
Any?: the object to be compared for equality with this object. |
| Return | |
|---|---|
Boolean |
true if the specified object is equal to this enum constant. |
getDeclaringClass
fun getDeclaringClass(): Class<E>
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 | |
|---|---|
Class<E> |
the Class object corresponding to this enum constant's enum type |
hashCode
fun hashCode(): Int
Returns a hash code for this enum constant.
| Return | |
|---|---|
Int |
a hash code for this enum constant. |
name
fun name(): String
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.
| Return | |
|---|---|
String |
the name of this enum constant |
ordinal
fun ordinal(): Int
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 | |
|---|---|
Int |
the ordinal of this enumeration constant |
toString
open fun toString(): String
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 | |
|---|---|
String |
the name of this enum constant |
valueOf
open static fun <T : Enum<T>!> valueOf(
enumType: Class<T>,
name: String
): T
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.)
Note that for a particular enum type 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 type can be obtained by calling the implicit public static T[] values() method of that type.
| Parameters | |
|---|---|
<T> |
The enum type whose constant is to be returned |
enumType |
Class<T>: the Class object of the enum type from which to return a constant |
name |
String: the name of the constant to return |
| Return | |
|---|---|
T |
the enum constant of the specified enum type with the specified name |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the specified enum type has no constant with the specified name, or the specified class object does not represent an enum type |
java.lang.NullPointerException |
if enumType or name is null |
Protected methods
clone
protected fun clone(): Any
Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status.
| Return | |
|---|---|
Any |
(never returns) |
| Exceptions | |
|---|---|
java.lang.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. |
finalize
protected fun finalize(): Unit
enum classes cannot have finalize methods.
| Exceptions | |
|---|---|
java.lang.Throwable |
the Exception raised by this method |