Package kotlin.reflect.full
Extensions for Kotlin reflection provided by kotlin-reflect
library.
Exceptions
IllegalCallableAccessException
An exception that is thrown when call
is invoked on a callable or get
or set
is invoked on a property
and that callable is not accessible (in JVM terms) from the calling method.
class IllegalCallableAccessException : Exception
IllegalPropertyDelegateAccessException
An exception that is thrown when getDelegate
is invoked on a KProperty object that was not made accessible
with isAccessible.
class IllegalPropertyDelegateAccessException : Exception
NoSuchPropertyException
An exception that is thrown when the code tries to introspect a property of a class or a package and that class or the package no longer has that property.
class NoSuchPropertyException : Exception
Properties
allSuperclasses
All superclasses of this class, including indirect ones, in no particular order. Includes superclasses and superinterfaces of the class, but does not include the class itself. The returned collection does not contain more than one instance of any given class.
val KClass<*>.allSuperclasses: Collection<KClass<*>>
allSupertypes
All supertypes of this class, including indirect ones, in no particular order. There is not more than one type in the returned collection that has any given classifier.
val KClass<*>.allSupertypes: Collection<KType>
companionObjectInstance
Returns an instance of the companion object of a given class,
or null
if the class doesn't have a companion object.
val KClass<*>.companionObjectInstance: Any?
declaredFunctions
Returns all functions declared in this class. If this is a Java class, it includes all non-static methods (both extensions and non-extensions) declared in the class and the superclasses, as well as static methods declared in the class.
val KClass<*>.declaredFunctions: Collection<KFunction<*>>
declaredMemberExtensionFunctions
Returns extension functions declared in this class.
val KClass<*>.declaredMemberExtensionFunctions: Collection<KFunction<*>>
declaredMemberExtensionProperties
Returns extension properties declared in this class.
val <T : Any> KClass<T>.declaredMemberExtensionProperties: Collection<KProperty2<T, *, *>>
declaredMemberFunctions
Returns non-extension non-static functions declared in this class.
val KClass<*>.declaredMemberFunctions: Collection<KFunction<*>>
declaredMemberProperties
Returns non-extension properties declared in this class.
val <T : Any> KClass<T>.declaredMemberProperties: Collection<KProperty1<T, *>>
declaredMembers
Returns all functions and properties declared in this class. Does not include members declared in supertypes.
val KClass<*>.declaredMembers: Collection<KCallable<*>>
defaultType
Returns a type corresponding to the given class with type parameters of that class substituted as the corresponding arguments.
For example, for class MyMap<K, V>
defaultType would return the type MyMap<K, V>
.
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?
functions
Returns all functions declared in this class, including all non-static methods declared in the class and the superclasses, as well as static methods declared in the class.
val KClass<*>.functions: Collection<KFunction<*>>
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?
memberExtensionFunctions
Returns extension functions declared in this class and all of its superclasses.
val KClass<*>.memberExtensionFunctions: Collection<KFunction<*>>
memberExtensionProperties
Returns extension properties declared in this class and all of its superclasses.
val <T : Any> KClass<T>.memberExtensionProperties: Collection<KProperty2<T, *, *>>
memberFunctions
Returns non-extension non-static functions declared in this class and all of its superclasses.
val KClass<*>.memberFunctions: Collection<KFunction<*>>
memberProperties
Returns non-extension properties declared in this class and all of its superclasses.
val <T : Any> KClass<T>.memberProperties: Collection<KProperty1<T, *>>
primaryConstructor
Returns the primary constructor of this class, or null
if this class has no primary constructor.
See the Kotlin language documentation
for more information.
starProjectedType
Creates an instance of KType with the given classifier, substituting all its type parameters with star projections. The resulting type is not marked as nullable and does not have any annotations.
val KClassifier.starProjectedType: KType
staticFunctions
Returns static functions declared in this class.
val KClass<*>.staticFunctions: Collection<KFunction<*>>
staticProperties
Returns static properties declared in this class. Only properties representing static fields of Java classes are considered static.
val KClass<*>.staticProperties: Collection<KProperty0<*>>
valueParameters
Returns parameters of this callable, excluding the this
instance and the extension receiver parameter.
val KCallable<*>.valueParameters: List<KParameter>
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
createInstance
Creates a new instance of the class, calling a constructor which either has no parameters or all parameters of which are optional (see KParameter.isOptional). If there are no or many such constructors, an exception is thrown.
fun <T : Any> KClass<T>.createInstance(): T
createType
Creates a KType instance with the given classifier, type arguments, nullability and annotations. If the number of passed type arguments is not equal to the total number of type parameters of a classifier, an exception is thrown. If any of the arguments does not satisfy the bounds of the corresponding type parameter, an exception is thrown.
fun KClassifier.createType(
arguments: List<KTypeProjection> = emptyList(),
nullable: Boolean = false,
annotations: List<Annotation> = emptyList()
): KType
findAnnotation
Returns an annotation of the given type on this element.
fun <T : Annotation> KAnnotatedElement.findAnnotation(): 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?
getExtensionDelegate
Returns the instance of a delegated extension property, or null
if this property is not delegated.
Throws an exception if this is not an extension property.
fun KProperty1<*, *>.getExtensionDelegate(): Any?
Returns the instance of a delegated member extension property, or null
if this property is not delegated.
Throws an exception if this is not an extension property.
fun <D> KProperty2<D, *, *>.getExtensionDelegate(
receiver: D
): Any?
hasAnnotation
Returns true if this element is annotated with an annotation of type T.
fun <T : Annotation> KAnnotatedElement.hasAnnotation(): Boolean