W3cubDocs

/Kotlin

AnnotationRetention

enum class AnnotationRetention

Contains the list of possible annotation's retentions.

Determines how an annotation is stored in binary output.

Enum Values

SOURCE

Annotation isn't stored in binary output

BINARY

Annotation is stored in binary output, but invisible for reflection

RUNTIME

Annotation is stored in binary output and visible for reflection (default retention)

Inherited Properties

name

val name: String

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

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

Inherited Functions

clone

fun clone(): Any

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

compareTo

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.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:

hashCode

fun hashCode(): Int

Returns a hash code value for the object. The general contract of hashCode is:

toString

open fun toString(): String

Returns a string representation of the object.

© 2010–2018 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-retention/index.html