{% setvar book_path %}/reference/kotlin/dokkatest/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

KotlinEnum

enum KotlinEnum : Enum

kotlin.Any
   ↳ kotlin.Enum
     ↳ dokkatest.linking.KotlinEnum

Summary

Enum Values

ON_CATASTROPHE
ON_CREATE

Public functions

KotlinEnum
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<KotlinEnum>

Returns an array containing the constants of this enum type, in the order they're declared.

Public properties

EnumEntries<KotlinEnum>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Enum Values

ON_CATASTROPHE

val KotlinEnum.ON_CATASTROPHEKotlinEnum

ON_CREATE

val KotlinEnum.ON_CREATEKotlinEnum

Public functions

valueOf

fun valueOf(value: String): KotlinEnum

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

fun values(): Array<KotlinEnum>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

Public properties

entries

val entriesEnumEntries<KotlinEnum>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.