kotlinpoet-metadata-specs/com.squareup.kotlinpoet.metadata.specs/ClassInspector

ClassInspector

A basic interface for looking up JVM information about a given Class.

Functions

containerData

Creates a new ContainerData instance for a given declarationContainer.

abstract fun containerData(declarationContainer: ImmutableKmDeclarationContainer, className: ClassName, parentClassName: ClassName?): ContainerData

declarationContainerFor

Looks up other declaration containers, such as for nested members. Note that this class would always be Kotlin, so Metadata can be relied on for this.

abstract fun declarationContainerFor(className: ClassName): ImmutableKmDeclarationContainer

enumEntry

Looks up the enum entry on a given enum given its member name.

abstract fun enumEntry(enumClassName: ClassName, memberName: String): EnumEntryData

equals

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

hashCode

open override fun hashCode(): Int

isInterface

Looks up a class and returns whether or not it is an interface. Note that this class can be Java or Kotlin, so Metadata should not be relied on for this.

abstract fun isInterface(className: ClassName): Boolean

methodExists

Looks up if a given methodSignature within className exists.

abstract fun methodExists(className: ClassName, methodSignature: JvmMethodSignature): Boolean

toString

open override fun toString(): String

Properties

supportsNonRuntimeRetainedAnnotations

Indicates if this ClassInspector supports AnnotationRetention.RUNTIME-retained annotations. This is used to indicate if manual inference of certain non-RUNTIME-retained annotations should be done, such as JvmName.

abstract val supportsNonRuntimeRetainedAnnotations: Boolean

Extensions

classFor

Looks up other classes, such as for nested members. Note that this class would always be Kotlin, so Metadata can be relied on for this.

fun ClassInspector.classFor(className: ClassName): ImmutableKmClass

containerData

Creates a new ContainerData instance for a given className.

fun ClassInspector.containerData(className: ClassName, parentClassName: ClassName?): ContainerData