interface KClass<T : Any> : KClassifier
interface KClass<T : Any> : KDeclarationContainer, KAnnotatedElement, KClassifier
Represents a class and provides introspection capabilities. Instances of this class are obtainable by the ::class syntax. See the Kotlin language documentation for more information.
T - the type of the class.
All constructors declared in this class.
abstract val constructors: Collection<KFunction<T>>
true if this class is abstract.
abstract val isAbstract: Boolean
true if this class is a companion object. See the Kotlin language documentation for more information.
abstract val isCompanion: Boolean
true if this class is a data class. See the Kotlin language documentation for more information.
abstract val isData: Boolean
true if this class is final.
abstract val isFinal: Boolean
true if this class is a Kotlin functional interface.
abstract val isFun: Boolean
true if this class is an inner class. See the Kotlin language documentation for more information.
abstract val isInner: Boolean
true if this class is open.
abstract val isOpen: Boolean
true if this class is sealed. See the Kotlin language documentation for more information.
abstract val isSealed: Boolean
All functions and properties accessible in this class, including those declared in this class and all of its superclasses. Does not include constructors.
abstract val members: Collection<KCallable<*>>
All classes declared inside this class. This includes both inner and static nested classes.
abstract val nestedClasses: Collection<KClass<*>>
The instance of the object declaration, or null if this class is not an object declaration.
abstract val objectInstance: T?
The fully qualified dot-separated name of the class, or null if the class is local or a class of an anonymous object.
abstract val qualifiedName: String?
The list of the immediate subclasses if this class is a sealed class, or an empty list otherwise.
abstract val sealedSubclasses: List<KClass<out T>>
The simple name of the class as it was declared in the source code, or null if the class has no name (if, for example, it is a class of an anonymous object).
abstract val simpleName: String?
The list of immediate supertypes of this class, in the order they are listed in the source code.
abstract val supertypes: List<KType>
The list of type parameters of this class. This list does not include type parameters of outer classes.
abstract val typeParameters: List<KTypeParameter>
Visibility of this class, or null if its visibility cannot be represented in Kotlin.
abstract val visibility: KVisibility?
Annotations which are present on this element.
abstract val annotations: List<Annotation>
Returns a hash code value for the object. The general contract of hashCode is:
abstract fun hashCode(): Int
Returns true if value is an instance of this class on a given platform.
abstract fun isInstance(value: Any?): Boolean
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<*>>
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>
Returns a KClass instance representing the companion object of a given class, or null if the class doesn't have a companion object.
val KClass<*>.companionObject: KClass<*>?
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?
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<*>>
Returns extension functions declared in this class.
val KClass<*>.declaredMemberExtensionFunctions: Collection<KFunction<*>>
Returns extension properties declared in this class.
val <T : Any> KClass<T>.declaredMemberExtensionProperties: Collection<KProperty2<T, *, *>>
Returns non-extension non-static functions declared in this class.
val KClass<*>.declaredMemberFunctions: Collection<KFunction<*>>
Returns non-extension properties declared in this class.
val <T : Any> KClass<T>.declaredMemberProperties: Collection<KProperty1<T, *>>
Returns all functions and properties declared in this class. Does not include members declared in supertypes.
val KClass<*>.declaredMembers: Collection<KCallable<*>>
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>.
val KClass<*>.defaultType: KType
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<*>>
val <T : Any> KClass<T>.javaClass: Class<KClass<T>>
Obtains a constructor reference for the given KClass.
val <T : Any> KClass<T>.js: JsClass<T>
Returns the JVM name of the class represented by this KClass instance.
val KClass<*>.jvmName: String
Returns extension functions declared in this class and all of its superclasses.
val KClass<*>.memberExtensionFunctions: Collection<KFunction<*>>
Returns extension properties declared in this class and all of its superclasses.
val <T : Any> KClass<T>.memberExtensionProperties: Collection<KProperty2<T, *, *>>
Returns non-extension non-static functions declared in this class and all of its superclasses.
val KClass<*>.memberFunctions: Collection<KFunction<*>>
Returns non-extension properties declared in this class and all of its superclasses.
val <T : Any> KClass<T>.memberProperties: Collection<KProperty1<T, *>>
Returns the primary constructor of this class, or null if this class has no primary constructor. See the Kotlin language documentation for more information.
val <T : Any> KClass<T>.primaryConstructor: KFunction<T>?
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
Returns static functions declared in this class.
val KClass<*>.staticFunctions: Collection<KFunction<*>>
Returns static properties declared in this class. Only properties representing static fields of Java classes are considered static.
val KClass<*>.staticProperties: Collection<KProperty0<*>>
Immediate superclasses of this class, in the order they are listed in the source code. Includes superclasses and superinterfaces of the class, but does not include the class itself.
val KClass<*>.superclasses: List<KClass<*>>
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
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
Returns an annotation of the given type on this element.
fun <T : Annotation> KAnnotatedElement.findAnnotation(): T?
Returns true if this element is annotated with an annotation of type T.
fun <T : Annotation> KAnnotatedElement.hasAnnotation(): Boolean
Returns true if this class is the same or is a (possibly indirect) subclass of base, false otherwise.
fun KClass<*>.isSubclassOf(base: KClass<*>): Boolean
Returns true if this class is the same or is a (possibly indirect) superclass of derived, false otherwise.
fun KClass<*>.isSuperclassOf(derived: KClass<*>): Boolean
© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/