Package kotlin.reflect

Runtime API for Kotlin reflection

Types

JVM
Native
1.0

KAnnotatedElement

Represents an annotated element and allows to obtain its annotations. See the Kotlin language documentation for more information.

interface KAnnotatedElement

KCallable

Represents a callable entity, such as a function or a property.

Common
JS
1.0
interface KCallable<out R>
JVM
Native
1.0
interface KCallable<out R> : KAnnotatedElement

KClass

Represents a class and provides introspection capabilities. Instances of this class are obtainable by the ::class syntax. See the Kotlin language documentation for more information.

Common
JS
1.0
interface KClass<T : Any> : KClassifier
JVM
Native
1.0
interface KClass<T : Any> : 
    KDeclarationContainer,
    KAnnotatedElement,
    KClassifier
Common
JVM
JS
Native
1.1

KClassifier

A classifier is either a class or a type parameter.

interface KClassifier
JVM
Native
1.0

KDeclarationContainer

Represents an entity which may contain declarations of any other entities, such as a class or a package.

interface KDeclarationContainer
Common
JVM
JS
Native
1.0

KFunction

Represents a function with introspection capabilities.

interface KFunction<out R> : KCallable<R>, Function<R>
Common
JVM
JS
Native
1.0

KMutableProperty

Represents a property declared as a var.

interface KMutableProperty<V> : KProperty<V>
Common
JVM
JS
Native
1.0

KMutableProperty0

Represents a var-property without any kind of receiver.

interface KMutableProperty0<V> : 
    KProperty0<V>,
    KMutableProperty<V>
Common
JVM
JS
Native
1.0

KMutableProperty1

Represents a var-property, operations on which take one receiver as a parameter.

interface KMutableProperty1<T, V> : 
    KProperty1<T, V>,
    KMutableProperty<V>
Common
JVM
JS
Native
1.0

KMutableProperty2

Represents a var-property, operations on which take two receivers as parameters.

interface KMutableProperty2<D, E, V> : 
    KProperty2<D, E, V>,
    KMutableProperty<V>
JVM
1.0

KParameter

Represents a parameter passed to a function or a property getter/setter, including this and extension receiver parameters.

interface KParameter : KAnnotatedElement
Common
JVM
JS
Native
1.0

KProperty

Represents a property, such as a named val or var declaration. Instances of this class are obtainable by the :: operator.

interface KProperty<out V> : KCallable<V>
Common
JVM
JS
Native
1.0

KProperty0

Represents a property without any kind of receiver. Such property is either originally declared in a receiverless context such as a package, or has the receiver bound to it.

interface KProperty0<out V> : KProperty<V>, () -> V
Common
JVM
JS
Native
1.0

KProperty1

Represents a property, operations on which take one receiver as a parameter.

interface KProperty1<T, out V> : KProperty<V>, (T) -> V
Common
JVM
JS
Native
1.0

KProperty2

Represents a property, operations on which take two receivers as parameters, such as an extension property declared in a class.

interface KProperty2<D, E, out V> : KProperty<V>, (D, E) -> V

KType

Represents a type. Type is usually either a class with optional type arguments, or a type parameter of some declaration, plus nullability.

Common
JS
Native
1.0
interface KType
JVM
1.0
interface KType : KAnnotatedElement
Common
JVM
JS
Native
1.1

KTypeParameter

Represents a declaration of a type parameter of a class or a callable. See the Kotlin language documentation for more information.

interface KTypeParameter : KClassifier
Common
JVM
JS
Native
1.1

KTypeProjection

Represents a type projection. Type projection is usually the argument to another type in a type usage. For example, in the type Array<out Number>, out Number is the covariant projection of the type represented by the class Number.

data class KTypeProjection
Common
JVM
JS
Native
1.1

KVariance

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
JVM
1.1

KVisibility

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

Annotations

JS
Native
1.1

AssociatedObjectKey

Makes the annotated annotation class an associated object key.

annotation class AssociatedObjectKey
JS
Native
1.1

ExperimentalAssociatedObjects

The experimental marker for associated objects API.

annotation class ExperimentalAssociatedObjects

Properties

JVM
1.4

javaType

Returns a Java Type instance corresponding to the given Kotlin type.

val KType.javaType: Type

Functions

Common
JVM
JS
Native
1.4

cast

Casts the given value to the class represented by this KClass object. Throws an exception if the value is null or if it is not an instance of this class.

fun <T : Any> KClass<T>.cast(value: Any?): T
JS
Native
1.1

findAssociatedObject

If T is an @AssociatedObjectKey-annotated annotation class and this class is annotated with @T (S::class), returns object S.

fun <T : Annotation> KClass<*>.findAssociatedObject(): Any?
Common
JVM
JS
Native
1.4

safeCast

Casts the given value to the class represented by this KClass object. Returns null if the value is null or if it is not an instance of this class.

fun <T : Any> KClass<T>.safeCast(value: Any?): T?
Common
JVM
JS
Native
1.3

typeOf

Returns a runtime representation of the given reified type T as an instance of KType.

fun <T> typeOf(): KType