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

interface Accessor<out V>

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

interface Getter<out V> : KProperty.Accessor<V>, KFunction<V>

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

abstract val getter: KProperty.Getter<V>

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

abstract val isConst: Boolean

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

abstract val isLateinit: Boolean

true if this callable is abstract.

abstract val isAbstract: Boolean

true if this callable is final.

abstract val isFinal: Boolean

true if this callable is open.

abstract val isOpen: Boolean

true if this is a suspending function.

abstract val isSuspend: Boolean

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.

abstract val parameters: List<KParameter>

The list of type parameters of this callable.

abstract val typeParameters: List<KTypeParameter>

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

abstract val visibility: KVisibility?

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.

abstract fun call(vararg args: Any?): R

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.

abstract fun callBy(args: Map<KParameter, Any?>): R

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

val KCallable<*>.extensionReceiverParameter: KParameter?

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.

val KCallable<*>.instanceParameter: KParameter?

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

var KCallable<*>.isAccessible: Boolean

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

val KProperty<*>.javaField: Field?

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.

val KProperty<*>.javaGetter: Method?

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

val KCallable<*>.valueParameters: List<KParameter>

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.

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.callBy. Otherwise, calls the suspend function with current continuation.

suspend fun <R> KCallable<R>.callSuspendBy(
    args: Map<KParameter, Any?>
): R

Returns an annotation of the given type on this element.

fun <T : Annotation> KAnnotatedElement.findAnnotation(): T?

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

fun KCallable<*>.findParameterByName(
    name: String
): KParameter?

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

fun <T : Annotation> KAnnotatedElement.hasAnnotation(): Boolean

Represents a property declared as a var.

interface KMutableProperty<V> : KProperty<V>

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

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

interface KProperty1<T, out V> : KProperty<V>, (T) -> V

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