Spec-Zone.ru › Kotlin 1.8

KClass

kotlin-stdlib / kotlin.reflect / KClass
Требования к платформе и версии: JS (1.1)
interface KClass<T : Any> : KClassifier
Требования к платформе и версии: JVM (1.0), Native (1.3)
interface KClass<T : Any> : 
    KDeclarationContainer, 
    KAnnotatedElement, 
    KClassifier

Представляет класс и предоставляет возможности интроспекции. Экземпляры этого класса можно получить с помощью синтаксиса ::class. Дополнительную информацию см. в документации по языку Kotlin.

Параметры

T - тип класса.

Свойства

Требования к платформе и версии: JVM (1.0)

конструкторы

Все конструкторы, объявленные в этом классе.

abstract val constructors: Collection<KFunction<T>>
Требования к платформе и версии: JVM (1.1)

isAbstract

Возвращает значение true, если этот класс abstract.

abstract val isAbstract: Boolean
Требования к платформе и версии: JVM (1.1)

isCompanion

Возвращает значение true, если этот класс является компаньоном. Дополнительную информацию см. в документации по языку Kotlin.

abstract val isCompanion: Boolean
Требования к платформе и версии: JVM (1.1)

isData

Возвращает значение true, если этот класс является классом данных. Дополнительную информацию см. в документации по языку Kotlin.

abstract val isData: Boolean
Требования к платформе и версии: JVM (1.1)

isFinal

Возвращает значение true, если этот класс final.

abstract val isFinal: Boolean
Требования к платформе и версии: JVM (1.4)

isFun

Возвращает значение true, если этот класс является функциональным интерфейсом Kotlin.

abstract val isFun: Boolean
Требования к платформе и версии: JVM (1.1)

isInner

Возвращает значение true, если этот класс является внутренним классом. Дополнительную информацию см. в документации по языку Kotlin.

abstract val isInner: Boolean
Требования к платформе и версии: JVM (1.1)

isOpen

Возвращает значение true, если этот класс open.

abstract val isOpen: Boolean
Требования к платформе и версии: JVM (1.1)

isSealed

Возвращает значение true, если этот класс sealed Дополнительную информацию см. в документации по языку Kotlin.

abstract val isSealed: Boolean
Требования к платформе и версии: JVM (1.5)

isValue

Возвращает значение true, если этот класс является классом-значением.

abstract val isValue: Boolean
Требования к платформе и версии: JVM (1.0)

members

Все функции и свойства, доступные в этом классе, включая те, которые объявлены в этом классе и во всех его суперклассах. Конструкторы не включаются.

abstract val members: Collection<KCallable<*>>
Требования к платформе и версии: JVM (1.0)

вложенныеКлассы

Все классы, объявленные внутри этого класса. Это включает как внутренние, так и статические вложенные классы.

abstract val nestedClasses: Collection<KClass<*>>
Требования к платформе и версии: JVM (1.0)

objectInstance

Экземпляр объявления объекта, или null если этот класс не является объявлением объекта.

abstract val objectInstance: T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

qualifiedName

Полное имя класса с разделителями точек, или null если класс локальный или класс анонимного объекта.

abstract val qualifiedName: String?
Требования к платформе и версии: JVM (1.3)

sealedSubclasses

Список непосредственных подклассов, если этот класс является запечатанным, или пустой список в противном случае.

abstract val sealedSubclasses: List<KClass<out T>>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

simpleName

Простое имя класса, как оно было объявлено в исходном коде, или null если у класса нет имени (например, если это класс анонимного объекта).

abstract val simpleName: String?
Требования к платформе и версии: JVM (1.1)

supertypes

Список непосредственных супертипов этого класса в порядке их перечисления в исходном коде.

abstract val supertypes: List<KType>
Требования к платформе и версии: JVM (1.1)

typeParameters

Список параметров типа этого класса. Этот список не включает параметры типа внешних классов.

abstract val typeParameters: List<KTypeParameter>
Требования к платформе и версии: JVM (1.1)

visibility

Видимость этого класса, или null если его видимость не может быть представлена на Kotlin.

abstract val visibility: KVisibility?

Наследованные свойства

Требования к платформе и версии: JVM (1.0)

annotations

Аннотации, присутствующие на этом элементе.

abstract val annotations: List<Annotation>

Функции

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

equals

Возвращает true если этот экземпляр KClass представляет тот же класс Kotlin, что и класс, представленный other. В JVM это означает, что выполняются все следующие условия:

abstract fun equals(other: Any?): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

hashCode

Возвращает значение хэш-кода для объекта. Общий контракт hashCode:

abstract fun hashCode(): Int
Требования к платформе и версии: JVM (1.1), JS (1.1), Native (1.1)

isInstance

Возвращает true если value является экземпляром этого класса на данной платформе.

abstract fun isInstance(value: Any?): Boolean

Расширяющие свойства

Требования к платформе и версии: JVM (1.1)

allSuperclasses

Все суперклассы этого класса, включая косвенные, в произвольном порядке. Включает суперклассы и суперинтерфейсы класса, но не включает сам класс. Возвращаемая коллекция не содержит более одного экземпляра любого данного класса.

val KClass<*>.allSuperclasses: Collection<KClass<*>>
Требования к платформе и версии: JVM (1.1)

allSupertypes

Все супертипы этого класса, включая косвенные, в произвольном порядке. В возвращаемой коллекции не более одного типа с любым заданным классификатором.

val KClass<*>.allSupertypes: Collection<KType>
Требования к платформе и версии: JVM (1.1)

companionObject

Возвращает экземпляр KClass, представляющий объект-компаньон данного класса, или null если класс не имеет объекта-компаньона.

val KClass<*>.companionObject: KClass<*>?
Требования к платформе и версии: JVM (1.1)

companionObjectInstance

Возвращает экземпляр объекта-компаньона данного класса, или null если класс не имеет объекта-компаньона.

val KClass<*>.companionObjectInstance: Any?
Требования к платформе и версии: JVM (1.1)

declaredFunctions

Возвращает все функции, объявленные в этом классе. Если это класс Java, он включает все нестатические методы (как расширения, так и не расширения), объявленные в классе и суперклассах, а также статические методы, объявленные в классе.

val KClass<*>.declaredFunctions: Collection<KFunction<*>>
Требования к платформе и версии: JVM (1.1)

declaredMemberExtensionFunctions

Возвращает функции-расширения, объявленные в этом классе.

val KClass<*>.declaredMemberExtensionFunctions: Collection<KFunction<*>>
Требования к платформе и версии: JVM (1.1)

declaredMemberExtensionProperties

Возвращает свойства-расширения, объявленные в этом классе.

val <T : Any> KClass<T>.declaredMemberExtensionProperties: Collection<KProperty2<T, *, *>>
Требования к платформе и версии: JVM (1.1)

declaredMemberFunctions

Возвращает функции, не являющиеся расширениями и не являющиеся статическими, объявленные в этом классе.

val KClass<*>.declaredMemberFunctions: Collection<KFunction<*>>
Требования к платформе и версии: JVM (1.1)

declaredMemberProperties

Возвращает свойства, не являющиеся расширениями, объявленные в этом классе.

val <T : Any> KClass<T>.declaredMemberProperties: Collection<KProperty1<T, *>>
Требования к платформе и версии: JVM (1.1)

declaredMembers

Возвращает все функции и свойства, объявленные в этом классе. Не включает члены, объявленные в супертипах.

val KClass<*>.declaredMembers: Collection<KCallable<*>>
Требования к платформе и версии: JVM (1.1)

defaultType

Возвращает тип, соответствующий данному классу, с параметрами типа этого класса, подставленными в качестве соответствующих аргументов. Например, для класса MyMap<K, V> defaultType вернет тип MyMap<K, V>.

val KClass<*>.defaultType: KType
Требования к платформе и версии: JVM (1.1)

functions

Возвращает все функции, объявленные в этом классе, включая все нестатические методы, объявленные в классе и суперклассах, а также статические методы, объявленные в классе.

val KClass<*>.functions: Collection<KFunction<*>>
Требования к платформе и версии: JVM (1.0)

java

Возвращает экземпляр класса Java Class, соответствующий данному экземпляру KClass.

val <T> KClass<T>.java: Class<T>
Требования к платформе и версии: JVM (1.0)

javaClass

val <T : Any> KClass<T>.javaClass: Class<KClass<T>>
Требования к платформе и версии: JVM (1.0)

javaObjectType

Возвращает экземпляр класса Java Class, соответствующий данному экземпляру KClass. В случае примитивных типов возвращает соответствующие классы-обёртки.

val <T : Any> KClass<T>.javaObjectType: Class<T>
Требования к платформе и версии: JVM (1.0)

javaPrimitiveType

Возвращает экземпляр класса Java Class, представляющий примитивный тип, соответствующий данному KClass, если он существует.

val <T : Any> KClass<T>.javaPrimitiveType: Class<T>?
Требования к платформе и версии: JS (1.1)

js

Получает ссылку на конструктор для данного KClass.

val <T : Any> KClass<T>.js: JsClass<T>
Требования к платформе и версии: JVM (1.0)

jvmName

Возвращает имя JVM класса, представленного этим экземпляром KClass.

val KClass<*>.jvmName: String
Требования к платформе и версии: JVM (1.1)

memberExtensionFunctions

Возвращает функции-расширения, объявленные в этом классе и всех его суперклассах.

val KClass<*>.memberExtensionFunctions: Collection<KFunction<*>>
Требования к платформе и версии: JVM (1.1)

memberExtensionProperties

Возвращает свойства-расширения, объявленные в этом классе и всех его суперклассах.

val <T : Any> KClass<T>.memberExtensionProperties: Collection<KProperty2<T, *, *>>
Требования к платформе и версии: JVM (1.1)

memberFunctions

Возвращает функции, не являющиеся расширениями и не являющиеся статическими, объявленные в этом классе и всех его суперклассах.

val KClass<*>.memberFunctions: Collection<KFunction<*>>
Требования к платформе и версии: JVM (1.1)

memberProperties

Возвращает свойства, не являющиеся расширениями, объявленные в этом классе и всех его суперклассах.

val <T : Any> KClass<T>.memberProperties: Collection<KProperty1<T, *>>
Требования к платформе и версии: JVM (1.1)

primaryConstructor

Возвращает первичный конструктор этого класса или null если у этого класса нет первичного конструктора. Подробнее см. в документации по языку Kotlin.

val <T : Any> KClass<T>.primaryConstructor: KFunction<T>?
Требования к платформе и версии: JVM (1.1)

starProjectedType

Создаёт экземпляр KType с заданным классификатором, подставляя все его параметры типа с проекциями звёздочкой. Результирующий тип не помечен как nullable и не имеет аннотаций.

val KClassifier.starProjectedType: KType
Требования к платформе и версии: JVM (1.1)

staticFunctions

Возвращает статические функции, объявленные в этом классе.

val KClass<*>.staticFunctions: Collection<KFunction<*>>
Требования к платформе и версии: JVM (1.1)

staticProperties

Возвращает статические свойства, объявленные в этом классе. Статическими считаются только свойства, представляющие статические поля Java-классов.

val KClass<*>.staticProperties: Collection<KProperty0<*>>
Требования к платформе и версии: JVM (1.1)

superclasses

Непосредственные суперклассы этого класса в порядке их перечисления в исходном коде. Включает суперклассы и суперинтерфейсы класса, но не включает сам класс.

val KClass<*>.superclasses: List<KClass<*>>

Функции расширения

Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

cast

Преобразует заданное значение value к классу, представленному этим объектом KClass. Бросает исключение, если значение равно null или если оно не является экземпляром этого класса.

fun <T : Any> KClass<T>.cast(value: Any?): T
Требования к платформе и версии: JVM (1.1)

cast

Преобразует заданное значение к классу, представленному этим объектом KClass. Бросает исключение, если значение равно null или если оно не является экземпляром этого класса.

fun <T : Any> KClass<T>.cast(value: Any?): T
Требования к платформе и версии: JVM (1.1)

createInstance

Создаёт новый экземпляр класса, вызывая конструктор, у которого нет параметров или все параметры которого являются необязательными (см. KParameter.isOptional). Если таких конструкторов нет или несколько, выбрасывается исключение.

fun <T : Any> KClass<T>.createInstance(): T
Требования к платформе и версии: JVM (1.1)

createType

Создаёт экземпляр KType с заданным классификатором, аргументами типа, nullable и аннотациями. Если количество переданных аргументов типа не равно общему количеству параметров типа классификатора, выбрасывается исключение. Если какой-либо из аргументов не удовлетворяет ограничениям соответствующего параметра типа, выбрасывается исключение.

fun KClassifier.createType(
    arguments: List<KTypeProjection> = emptyList(), 
    nullable: Boolean = false, 
    annotations: List<Annotation> = emptyList()
): KType
Требования к платформе и версии: JVM (1.1)

findAnnotation

Возвращает аннотацию заданного типа на этом элементе.

fun <T : Annotation> KAnnotatedElement.findAnnotation(): T?
Требования к платформе и версии: JVM (1.7)

findAnnotations

Возвращает все аннотации заданного типа на этом элементе, включая применённые индивидуально аннотации и повторяющиеся аннотации.

fun <T : Annotation> KAnnotatedElement.findAnnotations(): List<T>
fun <T : Annotation> KAnnotatedElement.findAnnotations(
    klass: KClass<T>
): List<T>
Требования к платформе и версии: JVM (1.4)

hasAnnotation

Возвращает true, если этот элемент снабжён аннотацией типа T.

fun <T : Annotation> KAnnotatedElement.hasAnnotation(): Boolean
Требования к платформе и версии: JVM (1.1)

isSubclassOf

Возвращает true если this класс идентичен или является (возможно, косвенным) подклассом base, false в противном случае.

fun KClass<*>.isSubclassOf(base: KClass<*>): Boolean
Требования к платформе и версии: JVM (1.1)

isSuperclassOf

Возвращает true если this класс идентичен или является (возможно, косвенным) суперклассом derived, false в противном случае.

fun KClass<*>.isSuperclassOf(derived: KClass<*>): Boolean
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

safeCast

Преобразует заданное значение к классу, представленному этим объектом KClass. Возвращает null если значение равно null или если оно не является экземпляром этого класса.

fun <T : Any> KClass<T>.safeCast(value: Any?): T?
Требования к платформе и версии: JVM (1.1)

safeCast

Преобразует заданное значение к классу, представленному этим объектом KClass. Возвращает null если значение равно null или если оно не является экземпляром этого класса.

fun <T : Any> KClass<T>.safeCast(value: Any?): T?

© 2010–2023 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/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API