KProperty

expect interface KProperty<out V> : KCallable<V> (source)

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

See the Kotlin language documentation for more information.

Since Kotlin

1.2
actual interface KProperty<out V> : KCallable<V> (source)

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

See the Kotlin language documentation for more information.

Since Kotlin

1.0
actual interface KProperty<out V> : KCallable<V> (source)

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

See the Kotlin language documentation for more information.

Since Kotlin

1.1
actual interface KProperty<out V> : KCallable<V> (source)

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

See the Kotlin language documentation for more information.

Since Kotlin

1.3

Parameters

V

the type of the property value.

V

the type of the property value.

V

the type of the property value.

V

the type of the property value.

Types

Link copied to clipboard
interface Accessor<out V>

Represents a property accessor, which is a get or set method declared alongside the property. See the Kotlin language documentation for more information.

Since Kotlin 1.0
Link copied to clipboard
interface Getter<out V> : KProperty.Accessor<V> , KFunction<V>

Getter of the property is a get method declared alongside the property.

Since Kotlin 1.0

Functions

Link copied to clipboard
abstract fun call(vararg args: Any?): V

Calls this callable with the specified list of arguments and returns the result. Throws an exception if the number of specified arguments is not equal to the size of parameters, or if their types do not match the types of the parameters.

Since Kotlin 1.0
Link copied to clipboard
abstract fun callBy(args: Map<KParameter, Any?>): V

Calls this callable with the specified mapping of parameters to arguments and returns the result. If a parameter is not found in the mapping and is not optional (as per KParameter.isOptional), or its type does not match the type of the provided value, an exception is thrown.

Since Kotlin 1.0

Properties

Link copied to clipboard
abstract val annotations: List<Annotation>

Annotations which are present on this element.

Since Kotlin 1.0
Link copied to clipboard
abstract val getter: KProperty.Getter<V>

The getter of this property, used to obtain the value of the property.

Since Kotlin 1.0
Link copied to clipboard
abstract val isAbstract: Boolean

true if this callable is abstract.

Since Kotlin 1.1
Link copied to clipboard
abstract val isConst: Boolean

true if this property is const. See the Kotlin language documentation for more information.

Since Kotlin 1.1
Link copied to clipboard
abstract val isFinal: Boolean

true if this callable is final.

Since Kotlin 1.1
Link copied to clipboard
abstract val isLateinit: Boolean

true if this property is lateinit. See the Kotlin language documentation for more information.

Since Kotlin 1.1
Link copied to clipboard
abstract val isOpen: Boolean

true if this callable is open.

Since Kotlin 1.1
Link copied to clipboard
abstract val isSuspend: Boolean

true if this is a suspending function.

Since Kotlin 1.3
Link copied to clipboard
expect abstract val name: String

The name of this callable as it was declared in the source code. If the callable has no name, a special invented name is created. Nameless callables include:

Since Kotlin 1.2
actual abstract val name: String

The name of this callable as it was declared in the source code. If the callable has no name, a special invented name is created. Nameless callables include:

Since Kotlin 1.0
actual abstract val name: String

The name of this callable as it was declared in the source code. If the callable has no name, a special invented name is created. Nameless callables include:

Since Kotlin 1.1
actual abstract val name: String

The name of this callable as it was declared in the source code. If the callable has no name, a special invented name is created. Nameless callables include:

Since Kotlin 1.3
Link copied to clipboard
abstract val parameters: List<KParameter>

Parameters required to make a call to this callable. If this callable requires a this instance or an extension receiver parameter, they come first in the list in that order.

Since Kotlin 1.0
Link copied to clipboard
abstract val returnType: KType

The type of values returned by this callable.

Since Kotlin 1.0
abstract val returnType: KType

The type of values returned by this callable.

Since Kotlin 1.3
Link copied to clipboard

The list of type parameters of this callable.

Since Kotlin 1.1
Link copied to clipboard
abstract val visibility: KVisibility?

Visibility of this callable, or null if its visibility cannot be represented in Kotlin.

Since Kotlin 1.1

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Extensions

Link copied to clipboard
suspend fun <R> KCallable<R>.callSuspend(vararg args: Any?): R

Calls a callable in the current suspend context. If the callable is not a suspend function, behaves as KCallable.call. Otherwise, calls the suspend function with current continuation.

Since Kotlin 1.3
Link copied to clipboard
suspend fun <R> KCallable<R>.callSuspendBy(args: Map<KParameter, Any?>): R

Calls a callable in the current suspend context. If the callable is not a suspend function, behaves as KCallable.callBy. Otherwise, calls the suspend function with current continuation.

Since Kotlin 1.3
Link copied to clipboard

Returns a parameter representing the extension receiver instance needed to call this callable, or null if this callable is not an extension.

Since Kotlin 1.1
Link copied to clipboard

Returns an annotation of the given type on this element.

Since Kotlin 1.1
Link copied to clipboard

Returns all annotations of the given type on this element, including individually applied annotations as well as repeated annotations.

Since Kotlin 1.7
Link copied to clipboard

Returns the parameter of this callable with the given name, or null if there's no such parameter.

Since Kotlin 1.1
Link copied to clipboard

Returns true if this element is annotated with an annotation of type T.

Since Kotlin 1.4
Link copied to clipboard

Returns a parameter representing the this instance needed to call this callable, or null if this callable is not a member of a class and thus doesn't take such parameter.

Since Kotlin 1.1
Link copied to clipboard

Provides a way to suppress JVM access checks for a callable.

Since Kotlin 1.0
Link copied to clipboard

Returns a Java Field instance corresponding to the backing field of the given property, or null if the property has no backing field.

Since Kotlin 1.0
Link copied to clipboard

Returns a Java Method instance corresponding to the getter of the given property, or null if the property has no getter, for example in case of a simple private val in a class.

Since Kotlin 1.0
Link copied to clipboard

Returns parameters of this callable, excluding the this instance and the extension receiver parameter.

Since Kotlin 1.1