kotlinpoet/com.squareup.kotlinpoet/TypeSpec

TypeSpec

class TypeSpec : Taggable, OriginatingElementsHolder, ContextReceivable, Annotatable, Documentable

A generated class, interface, or enum declaration.

Types

class Builder : Taggable.Builder<TypeSpec.Builder> , OriginatingElementsHolder.Builder<TypeSpec.Builder> , ContextReceivable.Builder<TypeSpec.Builder> , Annotatable.Builder<TypeSpec.Builder> , Documentable.Builder<TypeSpec.Builder>

object Companion

enum Kind : Enum<TypeSpec.Kind>

Functions

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

open override fun hashCode(): Int

open override fun <T : Any> tag(type: Class<T>): T?

Returns the tag attached with type as a key, or null if no tag is attached with that key.

open override fun <T : Any> tag(type: KClass<T>): T?

Returns the tag attached with type as a key, or null if no tag is attached with that key.

inline fun <T : Any> Taggable.tag(): T?

Returns the tag attached with T as a key, or null if no tag is attached with that key.

fun toBuilder(kind: TypeSpec.Kind = this.kind, name: String? = this.name): TypeSpec.Builder

open override fun toString(): String

Properties

open override val annotations: List<AnnotationSpec>

contextReceiverTypes

open override val contextReceiverTypes: List<TypeName>

The originating elements of this type.

val enumConstants: Map<String, TypeSpec>

val funSpecs: List<FunSpec>

initializerBlock

val initializerBlock: CodeBlock

initializerIndex

val initializerIndex: Int

val isAnnotation: Boolean

isAnonymousClass

val isAnonymousClass: Boolean

val isCompanion: Boolean

val isEnum: Boolean

isFunctionalInterface

val isFunctionalInterface: Boolean

open override val kdoc: CodeBlock

val kind: TypeSpec.Kind

val modifiers: Set<KModifier>

val name: String?

originatingElements

open override val originatingElements: List<Element>

The originating elements of this type.

primaryConstructor

val primaryConstructor: FunSpec?

val propertySpecs: List<PropertySpec>

val superclass: TypeName

superclassConstructorParameters

val superclassConstructorParameters: List<CodeBlock>

superinterfaces

val superinterfaces: Map<TypeName, CodeBlock?>

Map of superinterfaces - entries with a null value represent a regular superinterface (with no delegation), while non-null CodeBlock values represent delegates for the corresponding TypeSpec interface (key) value

open override val tags: Map<KClass<*>, Any>

Returns all tags.

val typeSpecs: List<TypeSpec>

val typeVariables: List<TypeVariableName>