kotlin-stdlib/kotlin/Enum

Enum

abstract class Enum<E : Enum<E>>(name: String, ordinal: Int) : Comparable<E> (source)

The common base class of all enum classes. See the Kotlin language documentation for more information on enum classes.

Since Kotlin

1.0

Inheritors

abstract class Enum<E : Enum<E>>(val name: String, val ordinal: Int) : Comparable<E> (source)

The common base class of all enum classes. See the Kotlin language documentation for more information on enum classes.

Since Kotlin

1.3

Inheritors

DeprecationLevel

AnnotationTarget

AnnotationRetention

CpuArchitecture

Constructors

constructor(name: String, ordinal: Int)

constructor(name: String, ordinal: Int)

Types

object Companion

Since Kotlin 1.0

object Companion

Since Kotlin 1.3

Properties

val name: String

Returns the name of this enum constant, exactly as declared in its enum declaration.

Since Kotlin 1.0

val name: String

Since Kotlin 1.3

val 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).

Since Kotlin 1.0

val ordinal: Int

Since Kotlin 1.3

Functions

protected fun clone(): Any

Throws an exception since enum constants cannot be cloned. This method prevents enum classes from inheriting from Cloneable.

Since Kotlin 1.0

operator override fun compareTo(other: E): Int

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.

Since Kotlin 1.0

operator override fun compareTo(other: E): Int

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.

Since Kotlin 1.3

infix inline fun <T> Comparable<T>.compareTo(other: T): Int

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.

Since Kotlin 1.6

operator override fun equals(other: Any?): Boolean

Since Kotlin 1.0

operator override fun equals(other: Any?): Boolean

Since Kotlin 1.3

override fun hashCode(): Int

Since Kotlin 1.0

override fun hashCode(): Int

Since Kotlin 1.3

open override fun toString(): String

Since Kotlin 1.0

open override fun toString(): String

Since Kotlin 1.3

Thanks for your feedback!

Was this page helpful?