KMutableProperty
interface KMutableProperty<V> : KProperty<V>
(Common source) (JVM source) (JS source) (Native source)
Represents a property declared as a var
.
Types
Setter
Setter of the property is a set
method declared alongside the property.
interface Setter<V> : KProperty.Accessor<V>, KFunction<Unit>
Properties
setter
The setter of this mutable property, used to change the value of the property.
abstract val setter: KMutableProperty.Setter<V>
Inherited Properties
getter
The getter of this property, used to obtain the value of the property.
abstract val getter: KProperty.Getter<V>
isConst
true
if this property is const
.
See the Kotlin language documentation
for more information.
abstract val isConst: Boolean
isLateinit
true
if this property is lateinit
.
See the Kotlin language documentation
for more information.
abstract val isLateinit: Boolean
Extension Properties
extensionReceiverParameter
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?
instanceParameter
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?
isAccessible
Provides a way to suppress JVM access checks for a callable.
var KCallable<*>.isAccessible: Boolean
javaSetter
Returns a Java Method instance corresponding to the setter of the given mutable property,
or null
if the property has no setter, for example in case of a simple private var
in a class.
val KMutableProperty<*>.javaSetter: Method?
valueParameters
Returns parameters of this callable, excluding the this
instance and the extension receiver parameter.
val KCallable<*>.valueParameters: List<KParameter>
Extension Functions
callSuspend
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
callSuspendBy
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
findAnnotation
Returns an annotation of the given type on this element.
fun <T : Annotation> KAnnotatedElement.findAnnotation(): T?
findAnnotations
Returns all annotations of the given type on this element, including individually applied annotations as well as repeated annotations.
fun <T : Annotation> KAnnotatedElement.findAnnotations(): List<T>
fun <T : Annotation> KAnnotatedElement.findAnnotations(
klass: KClass<T>
): List<T>
findParameterByName
Returns the parameter of this callable with the given name, or null
if there's no such parameter.
fun KCallable<*>.findParameterByName(
name: String
): KParameter?
hasAnnotation
Returns true if this element is annotated with an annotation of type T.
fun <T : Annotation> KAnnotatedElement.hasAnnotation(): Boolean
Inheritors
KMutableProperty0
Represents a var
-property without any kind of receiver.
interface KMutableProperty0<V> :
KProperty0<V>,
KMutableProperty<V>
KMutableProperty1
Represents a var
-property, operations on which take one receiver as a parameter.
interface KMutableProperty1<T, V> :
KProperty1<T, V>,
KMutableProperty<V>
KMutableProperty2
Represents a var
-property, operations on which take two receivers as parameters.
interface KMutableProperty2<D, E, V> :
KProperty2<D, E, V>,
KMutableProperty<V>