compiler-utils/com.squareup.anvil.compiler.internal.reference/ClassReference

ClassReference

sealed class ClassReference : Comparable<ClassReference> , AnnotatedReference

Used to create a common type between KtClassOrObject class references and ClassDescriptor references, to streamline parsing.

See also

toClassReference

Inheritors

Types

class Descriptor(val clazz: ClassDescriptor, val classId: ClassId, val module: AnvilModuleDescriptor) : ClassReference

class Psi(val clazz: KtClassOrObject, val classId: ClassId, val module: AnvilModuleDescriptor) : ClassReference

Properties

abstract val annotations: List<AnnotationReference>

abstract val classId: ClassId

abstract val constructors: List<MemberFunctionReference>

containingFileAsJavaFile

abstract val containingFileAsJavaFile: File

abstract val fqName: FqName

abstract val functions: List<MemberFunctionReference>

abstract val module: AnvilModuleDescriptor

val packageFqName: FqName

abstract val properties: List<MemberPropertyReference>

val shortName: String

abstract val typeParameters: List<TypeParameterReference>

Functions

allSuperTypeClassReferences

fun ClassReference.allSuperTypeClassReferences(includeSelf: Boolean = false): Sequence<ClassReference>

This will return all super types as ClassReference, whether they're parsed as KtClassOrObject or ClassDescriptor. This will include generated code, assuming it has already been generated. The returned sequence will be distinct by FqName, and Psi types are preferred over Descriptors.

fun ClassReference.asClassName(): ClassName

fun ClassReference.asTypeName(): TypeName

companionObjects

open fun companionObjects(): List<ClassReference>

open operator override fun compareTo(other: ClassReference): Int

directSuperTypeReferences

abstract fun directSuperTypeReferences(): List<TypeReference>

Returns only the super types (excluding Any) and implemented interfaces declared directly by this class.

fun enclosingClass(): ClassReference?

enclosingClassesWithSelf

abstract fun enclosingClassesWithSelf(): List<ClassReference>

Returns all outer classes including this class. Imagine the inner class Outer.Middle.Inner, then the returned list would contain [Outer, Middle, Inner] in that order.

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

generateClassName

fun ClassReference.generateClassName(separator: String = "_", suffix: String = ""): ClassId

open override fun hashCode(): Int

open fun innerClasses(): List<ClassReference>

abstract fun isAbstract(): Boolean

isAnnotatedWith

open fun isAnnotatedWith(fqName: FqName): Boolean

isAnnotationClass

abstract fun isAnnotationClass(): Boolean

abstract fun isCompanion(): Boolean

abstract fun isGenericClass(): Boolean

abstract fun isInterface(): Boolean

abstract fun isObject(): Boolean

open override fun toString(): String

abstract fun visibility(): Visibility