kotlinpoet/com.squareup.kotlinpoet/ClassName

ClassName

class ClassName : TypeName, Comparable<ClassName>

A fully-qualified class name for top-level and member classes.

Constructors

constructor(packageName: String, vararg simpleNames: String)

Returns a class name created from the given parts. For example, calling this with package name "java.util" and simple names "Map", "Entry" yields Map.Entry.

constructor(packageName: String, simpleNames: List<String>)

Returns a class name created from the given parts. For example, calling this with package name "java.util" and simple names "Map", "Entry" yields Map.Entry.

Types

Companion

object Companion

Properties

annotations

open override val annotations: List<AnnotationSpec>

canonicalName

val canonicalName: String

Fully qualified name using . as a separator, like kotlin.collections.Map.Entry.

isAnnotated

val isAnnotated: Boolean

isNullable

val isNullable: Boolean

packageName

val packageName: String

Package name, like "kotlin.collections" for Map.Entry.

simpleName

val simpleName: String

Simple name of this class, like "Entry" for Map.Entry.

simpleNames

val simpleNames: List<String>

The enclosing classes, outermost first, followed by the simple name. This is ["Map", "Entry"] for Map.Entry.

Functions

compareTo

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

Orders by the fully-qualified name. Nested types are ordered immediately after their enclosing type. For example, the following types are ordered by this method:

constructorReference

fun constructorReference(): CodeBlock

Callable reference to the constructor of this class. Emits the enclosing class if one exists, followed by the reference operator ::, followed by either simpleName or the fully-qualified name if this is a top-level class.

copy

open override fun copy(nullable: Boolean, annotations: List<AnnotationSpec>, tags: Map<KClass<*>, Any>): ClassName

fun copy(nullable: Boolean = this.isNullable, annotations: List<AnnotationSpec> = this.annotations.toList()): TypeName

enclosingClassName

fun enclosingClassName(): ClassName?

Returns the enclosing class, like Map for Map.Entry. Returns null if this class is not nested in another class.

equals

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

hashCode

open override fun hashCode(): Int

jvmSuppressWildcards

fun TypeName.jvmSuppressWildcards(suppress: Boolean = true): TypeName

jvmWildcard

fun TypeName.jvmWildcard(): TypeName

member

@JvmStatic

inline fun ClassName.member(simpleName: String): MemberName

nestedClass

fun nestedClass(name: String): ClassName

Returns a new ClassName instance for the specified name as nested inside this class.

parameterizedBy

@JvmStatic

@JvmName(name = "get")

fun ClassName.parameterizedBy(vararg typeArguments: TypeName): ParameterizedTypeName

@JvmStatic

@JvmName(name = "get")

fun ClassName.parameterizedBy(typeArguments: List<TypeName>): ParameterizedTypeName

Returns a parameterized type, applying typeArguments to this.

peerClass

fun peerClass(name: String): ClassName

Returns a class that shares the same enclosing package or class. If this class is enclosed by another class, this is equivalent to enclosingClassName().nestedClass(name). Otherwise it is equivalent to get(packageName(), name).

plusParameter

@JvmStatic

@JvmName(name = "get")

fun ClassName.plusParameter(typeArgument: TypeName): ParameterizedTypeName

Returns a parameterized type, applying typeArgument to this.

reflectionName

fun reflectionName(): String

Fully qualified name using . to separate package from the top level class name, and $ to separate nested classes, like kotlin.collections.Map$Entry.

tag

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.

tag

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.

topLevelClassName

fun topLevelClassName(): ClassName

Returns the top class in this nesting group. Equivalent to chained calls to ClassName.enclosingClassName until the result's enclosing class is null.

toString

open override fun toString(): String