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.2

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

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.1

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

Constructors

Enum

fun Enum(name: String, ordinal: Int)

Types

Companion

object Companion

Since Kotlin 1.2

object Companion

Since Kotlin 1.0

object Companion

Since Kotlin 1.1

object Companion

Since Kotlin 1.3

Properties

name

val name: String

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

Since Kotlin 1.2

val name: String

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

Since Kotlin 1.0

val name: String

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

Since Kotlin 1.1

val name: String

Since Kotlin 1.3

ordinal

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.2

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

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.1

val ordinal: Int

Since Kotlin 1.3

Inheritors

Extensions

compareTo

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

declaringJavaClass

val <E : Enum<E>> Enum<E>.declaringJavaClass: Class<E>

Returns a Java Class instance of the enum the given constant belongs to.

Since Kotlin 1.7