abstract class Enum<E : Enum<E>> : Comparable<E>
class Enum<T : Enum<T>> : Comparable<Enum<T>>
The common base class of all enum classes. See the Kotlin language documentation for more information on enum classes.
Enum()
The common base class of all enum classes. See the Kotlin language documentation for more information on enum classes.
<init>(name: String, ordinal: Int)
Returns the name of this enum constant, exactly as declared in its enum declaration.
val name: String
Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
val ordinal: Int
Throws an exception since enum constants cannot be cloned. This method prevents enum classes from inheriting from Cloneable
.
fun clone(): Any
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.
fun compareTo(other: Enum<T>): Int
fun compareTo(other: E): Int
Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:
fun equals(other: Any?): Boolean
Returns a hash code value for the object. The general contract of hashCode
is:
fun hashCode(): Int
Returns a string representation of the object.
open fun toString(): String
fun toString(): String
Ensures that this value is not less than the specified minimumValue.
fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T
Ensures that this value is not greater than the specified maximumValue.
fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T
Ensures that this value lies in the specified range minimumValue..maximumValue.
fun <T : Comparable<T>> T.coerceIn( minimumValue: T?, maximumValue: T? ): T
Ensures that this value lies in the specified range.
fun <T : Comparable<T>> T.coerceIn( range: ClosedFloatingPointRange<T> ): T
fun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): T
Creates a range from this Comparable value to the specified that value.
operator fun <T : Comparable<T>> T.rangeTo( that: T ): ClosedRange<T>
Contains the list of possible annotation's retentions.
enum class AnnotationRetention
Contains the list of code elements which are the possible annotation targets
enum class AnnotationTarget
Represents the character general category in the Unicode specification.
enum class CharCategory
Represents the Unicode directionality of a character. Character directionality is used to calculate the visual ordering of text.
enum class CharDirectionality
Central Processor Unit architecture.
enum class CpuArchitecture
Possible levels of a deprecation. The level specifies how the deprecated element usages are reported in code.
enum class DeprecationLevel
The list of possible time measurement units, in which a duration can be expressed.
enum class DurationUnit
typealias DurationUnit = TimeUnit
An enumeration to describe possible walk directions. There are two of them: beginning from parents, ending with children, and beginning from children, ending with parents. Both use depth-first search.
enum class FileWalkDirection
State of the future object.
enum class FutureState
Specifies how many times a function invokes its function parameter in place.
enum class InvocationKind
Represents variance applied to a type parameter on the declaration site (declaration-site variance), or to a type in a projection (use-site variance).
enum class KVariance
Visibility is an aspect of a Kotlin declaration regulating where that declaration is accessible in the source code. Visibility can be changed with one of the following modifiers: public
, protected
, internal
, private
.
enum class KVisibility
Specifies how a Lazy instance synchronizes initialization among multiple threads.
enum class LazyThreadSafetyMode
Memory model.
enum class MemoryModel
Enum that can be used to specify behaviour of the copyRecursively()
function in exceptional conditions.
enum class OnErrorAction
Operating system family.
enum class OsFamily
Provides enumeration values to use to set regular expression options.
enum class RegexOption
enum class RegexOption : FlagEnum
enum class TransferMode
© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html