W3cubDocs

/Kotlin

KClass

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.

Parameters

T - the type of the class.

Properties

constructors	abstract val constructors: Collection<KFunction<T>> All constructors declared in this class.
isAbstract	abstract val isAbstract: Boolean `true` if this class is `abstract`.
isCompanion	abstract val isCompanion: Boolean `true` if this class is a companion object. See the Kotlin language documentation for more information.
isData	abstract val isData: Boolean `true` if this class is a data class. See the Kotlin language documentation for more information.
isFinal	abstract val isFinal: Boolean `true` if this class is `final`.
isInner	abstract val isInner: Boolean `true` if this class is an inner class. See the Kotlin language documentation for more information.
isOpen	abstract val isOpen: Boolean `true` if this class is `open`.
isSealed	abstract val isSealed: Boolean `true` if this class is `sealed`. See the Kotlin language documentation for more information.
members	abstract val members: Collection<KCallable<*>> All functions and properties accessible in this class, including those declared in this class and all of its superclasses. Does not include constructors.
nestedClasses	abstract val nestedClasses: Collection<KClass<*>> All classes declared inside this class. This includes both inner and static nested classes.
objectInstance	abstract val objectInstance: T? The instance of the object declaration, or `null` if this class is not an object declaration.
qualifiedName	abstract val qualifiedName: String? The fully qualified dot-separated name of the class, or `null` if the class is local or it is an anonymous object literal.
simpleName	abstract val simpleName: String? 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 an anonymous object literal).
supertypes	abstract val supertypes: List<KType> The list of immediate supertypes of this class, in the order they are listed in the source code.
typeParameters	abstract val typeParameters: List<KTypeParameter> The list of type parameters of this class. This list does not include type parameters of outer classes.
visibility	abstract val visibility: KVisibility? Visibility of this class, 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

equals

abstract fun equals(other: Any?): Boolean

Returns true if this KClass instance represents the same Kotlin class as the class represented by other. On JVM this means that all of the following conditions are satisfied:

hashCode

abstract fun hashCode(): Int

Returns a hash code value for the object. The general contract of hashCode is:

isInstance

abstract fun isInstance(value: Any?): Boolean

Returns true if value is an instance of this class on a given platform.

Extension Properties

allSuperclasses	val KClass<>.allSuperclasses: Collection<KClass<>> 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.
allSupertypes	val KClass<*>.allSupertypes: Collection<KType> 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.
companionObject	val KClass<>.companionObject: KClass<>? Returns a KClass instance representing the companion object of a given class, or `null` if the class doesn't have a companion object.
companionObjectInstance	val KClass<*>.companionObjectInstance: Any? Returns an instance of the companion object of a given class, or `null` if the class doesn't have a companion object.
declaredFunctions	val KClass<>.declaredFunctions: Collection<KFunction<>> 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.
declaredMemberExtensionFunctions	val KClass<>.declaredMemberExtensionFunctions: Collection<KFunction<>> Returns extension functions declared in this class.
declaredMemberExtensionProperties	val <T : Any> KClass<T>.declaredMemberExtensionProperties: Collection<KProperty2<T, , >> Returns extension properties declared in this class.
declaredMemberFunctions	val KClass<>.declaredMemberFunctions: Collection<KFunction<>> Returns non-extension non-static functions declared in this class.
declaredMemberProperties	val <T : Any> KClass<T>.declaredMemberProperties: Collection<KProperty1<T, *>> Returns non-extension properties declared in this class.
declaredMembers	val KClass<>.declaredMembers: Collection<KCallable<>> Returns all functions and properties declared in this class. Does not include members declared in supertypes.
defaultType	val KClass<*>.defaultType: KType 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>`.
functions	val KClass<>.functions: Collection<KFunction<>> 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.
java	val <T> KClass<T>.java: Class<T> Returns a Java Class instance corresponding to the given KClass instance.
javaClass	val <T : Any> KClass<T>.javaClass: Class<KClass<T>>
javaObjectType	val <T : Any> KClass<T>.javaObjectType: Class<T> Returns a Java Class instance corresponding to the given KClass instance. In case of primitive types it returns corresponding wrapper classes.
javaPrimitiveType	val <T : Any> KClass<T>.javaPrimitiveType: Class<T>? Returns a Java Class instance representing the primitive type corresponding to the given KClass if it exists.
js	val <T : Any> KClass<T>.js: JsClass<T> Obtains a constructor reference for the given `KClass`.
jvmName	val KClass<*>.jvmName: String Returns the JVM name of the class represented by this KClass instance.
memberExtensionFunctions	val KClass<>.memberExtensionFunctions: Collection<KFunction<>> Returns extension functions declared in this class and all of its superclasses.
memberExtensionProperties	val <T : Any> KClass<T>.memberExtensionProperties: Collection<KProperty2<T, , >> Returns extension properties declared in this class and all of its superclasses.
memberFunctions	val KClass<>.memberFunctions: Collection<KFunction<>> Returns non-extension non-static functions declared in this class and all of its superclasses.
memberProperties	val <T : Any> KClass<T>.memberProperties: Collection<KProperty1<T, *>> Returns non-extension properties declared in this class and all of its superclasses.
primaryConstructor	val <T : Any> KClass<T>.primaryConstructor: KFunction<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.
starProjectedType	val KClassifier.starProjectedType: KType 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.
staticFunctions	val KClass<>.staticFunctions: Collection<KFunction<>> Returns static functions declared in this class.
staticProperties	val KClass<>.staticProperties: Collection<KProperty0<>> Returns static properties declared in this class. Only properties representing static fields of Java classes are considered static.
superclasses	val KClass<>.superclasses: List<KClass<>> 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.

Extension Functions

cast	fun <T : Any> KClass<T>.cast(value: Any?): T Casts the given value to the class represented by this KClass object. Throws an exception if the value is `null` or if it is not an instance of this class.
createInstance	fun <T : Any> KClass<T>.createInstance(): T 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.
createType	fun KClassifier.createType( arguments: List<KTypeProjection> = emptyList(), nullable: Boolean = false, annotations: List<Annotation> = emptyList() ): KType 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.
findAnnotation	fun <T : Annotation> KAnnotatedElement.findAnnotation(): T? Returns an annotation of the given type on this element.
isSubclassOf	fun KClass<>.isSubclassOf(base: KClass<>): Boolean Returns `true` if `this` class is the same or is a (possibly indirect) subclass of base, `false` otherwise.
isSuperclassOf	fun KClass<>.isSuperclassOf(derived: KClass<>): Boolean Returns `true` if `this` class is the same or is a (possibly indirect) superclass of derived, `false` otherwise.
safeCast	fun <T : Any> KClass<T>.safeCast(value: Any?): T? Casts the given value to the class represented by this KClass object. Returns `null` if the value is `null` or if it is not an instance of this class.

© 2010–2018 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html