KProperty

expect interface KProperty<out V> : KCallable<V>

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.

actual interface KProperty<out V> : KCallable<V>

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.

actual interface KProperty<out V> : KCallable<V>

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.

actual interface KProperty<out V> : KCallable<V>

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.

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

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

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

Functions

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

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

Properties

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

Annotations which are present on this element.

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

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

isAbstract
Link copied to clipboard
abstract val isAbstract: Boolean

true if this callable is abstract.

isConst
Link copied to clipboard
abstract val isConst: Boolean

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

isFinal
Link copied to clipboard
abstract val isFinal: Boolean

true if this callable is final.

isLateinit
Link copied to clipboard
abstract val isLateinit: Boolean

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

isOpen
Link copied to clipboard
abstract val isOpen: Boolean

true if this callable is open.

isSuspend
Link copied to clipboard
abstract val isSuspend: Boolean

true if this is a suspending function.

name
Link copied to clipboard
expect abstract val name: String
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:

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:

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:

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

returnType
Link copied to clipboard
abstract val returnType: KType

The type of values returned by this callable.

returnType
Link copied to clipboard
abstract val returnType: KType

The type of values returned by this callable.

typeParameters
Link copied to clipboard
abstract val typeParameters: List<KTypeParameter>

The list of type parameters of this callable.

visibility
Link copied to clipboard
abstract val visibility: KVisibility?

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

Inheritors

KMutableProperty
Link copied to clipboard
KProperty0
Link copied to clipboard
KProperty1
Link copied to clipboard
KProperty2
Link copied to clipboard

Extensions

javaField
Link copied to clipboard
val KProperty<*>.javaField: Field?

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

javaGetter
Link copied to clipboard
val KProperty<*>.javaGetter: Method?

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.