KCallable
interface KCallable<out R> : KAnnotatedElement
Represents a callable entity, such as a function or a property.
Parameters
R - return type of the callable.
Properties
| isAbstract | abstract val isAbstract: Boolean true if this callable is abstract.
|
| isFinal | abstract val isFinal: Boolean true if this callable is final.
|
| isOpen | abstract val isOpen: Boolean true if this callable is open.
|
| name | 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 | 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 | abstract val returnType: KType The type of values returned by this callable. |
| typeParameters | abstract val typeParameters: List<KTypeParameter> The list of type parameters of this callable. |
| visibility | abstract val visibility: KVisibility? Visibility of this callable, or null if its visibility cannot be represented in Kotlin. |
Inherited Properties
| annotations | abstract val annotations: List<Annotation> Annotations which are present on this element. |
Functions
| call | abstract fun call(vararg args: Any?): R 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 | abstract fun callBy(args: Map<KParameter, 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. |
Extension Properties
| extensionReceiverParameter | val KCallable<*>.extensionReceiverParameter: KParameter? Returns a parameter representing the extension receiver instance needed to call this callable, or null if this callable is not an extension. |
| instanceParameter | val KCallable<*>.instanceParameter: 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. |
| isAccessible | var KCallable<*>.isAccessible: Boolean Provides a way to suppress JVM access checks for a callable. |
| valueParameters | val KCallable<*>.valueParameters: List<KParameter> Returns parameters of this callable, excluding the this instance and the extension receiver parameter. |
Extension Functions
| findAnnotation | fun <T : Annotation> KAnnotatedElement.findAnnotation(): T? Returns an annotation of the given type on this element. |
| findParameterByName | fun KCallable<*>.findParameterByName(
name: String
): KParameter? Returns the parameter of this callable with the given name, or null if there's no such parameter. |
Inheritors
| KFunction | interface KFunction<out R> : KCallable<R>, Function<R> Represents a function with introspection capabilities. |
| KProperty | interface KProperty<out R> : KCallable<R> 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. |