True if the class is an abstract class or interface. If true, attempting to call constructors will fail. Constructors may still be present for abstract classes.

kotlin

val kotlin: KClass<T>

The class that was inspekted.

name

val name: ClassName

The qualified name of the class.

objectInstance

val objectInstance: T?

The object instance, if the class is an object.

primaryConstructor

val primaryConstructor: Constructor?

The primary constructor of this class, if it has one.

properties

val properties: List<Property>

The class's properties. Includes properties inherited from superclasses.

sealedSubclasses

val sealedSubclasses: List<Inspektion<out T>>

Any sealed (direct) subclasses of this class.

shortName

val shortName: String

The short name of this class, i.e. its own declaration name.

superclasses

val superclasses: Set<KClass<*>>

The class's superclasses, as KClasss.

supertypes

val supertypes: Set<KType>

The class's supertypes.

typeParameters

val typeParameters: List<TypeParameter>

The class's type parameters.

Functions

annotation

inline fun <T> AnnotatedElement.annotation(): T?

Get the first annotation of type T, or null if none is found.

annotations

inline fun <T> AnnotatedElement.annotations(): List<T>

Get all annotations of type T.

callFunction

inline fun callFunction(receiver: T?, name: String, argumentsBuilder: ArgumentsBuilder = {}): Any?

Call the single function named name with receiver and argumentsBuilder.

callPrimaryConstructor

inline fun callPrimaryConstructor(argumentsBuilder: ArgumentsBuilder = {}): T

Calls the primary constructor of this class with argumentsBuilder.

callSuspendFunction

inline suspend fun callSuspendFunction(receiver: T?, name: String, argumentsBuilder: ArgumentsBuilder = {}): Any?

Call the single function named name with receiver and argumentsBuilder.

cast

fun cast(value: Any): T

Casts value to this class. This is the same as using the as operator. Can be checked ahead of time with isInstance (aka is), and done safely with safeCast (aka as?).

equals

open operator override fun equals(other: Any?): Boolean

function

fun function(name: String): SimpleFunction

Gets the single function named name.

get

inline operator fun get(receiver: T?, name: String, crossinline argumentsBuilder: ArgumentsBuilder = {}): Any?

Gets the value of the single property named name with receiver and argumentsBuilder.

getProperty

inline fun getProperty(receiver: T?, name: String, crossinline argumentsBuilder: ArgumentsBuilder = {}): Any?

Gets the value of the single property named name with receiver and argumentsBuilder.

hashCode

open override fun hashCode(): Int

invoke

inline operator fun invoke(argumentsBuilder: ArgumentsBuilder = {}): T

Calls the primary constructor of this class with argumentsBuilder.

inline operator fun invoke(receiver: T?, name: String, argumentsBuilder: ArgumentsBuilder = {}): Any?

Call the single function named name with receiver and argumentsBuilder.

isInstance

fun isInstance(value: Any): Boolean

Returns true if value is an instance of this class. This is the same as using the is operator.

isSubtypeOf

fun isSubtypeOf(other: KClass<*>): Boolean

Returns true if this is a subtype of other.

property

fun property(name: String): Property

Gets the single property named name.

safeCast

fun safeCast(value: Any): T?

Attempts to cast value to this class, and returns null if it is not possible. This is the same as using the as? operator.

set

operator fun set(receiver: T?, name: String, value: Any?)

Sets the value of the single property named name to value with receiver.

operator fun set(receiver: T?, name: String, argumentsBuilder: ArgumentsBuilder)

Sets the value of the single property named name with receiver and arguments argumentsBuilder.

setProperty

inline fun setProperty(receiver: T?, name: String, crossinline argumentsBuilder: ArgumentsBuilder = {})

Sets the value of the single property named name with receiver and argumentsBuilder.

inline fun setProperty(receiver: T?, name: String, value: Any?, crossinline argumentsBuilder: ArgumentsBuilder = {})

Sets the value of the single property named name to value with receiver and argumentsBuilder additional arguments.

toString

open override fun toString(): String

fun toString(includeSubclasses: Boolean, includeDescendents: Boolean = includeSubclasses): String