DeclaredTypeName

class DeclaredTypeName : TypeName, Comparable<DeclaredTypeName>

A fully-qualified type name for top-level and member types.

Constructors

DeclaredTypeName

fun DeclaredTypeName(moduleName: String, simpleName: String, vararg simpleNames: String)

Returns a type name created from the given parts.

Types

Companion

object Companion

Functions

compareTo

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

enclosingTypeName

fun enclosingTypeName(): DeclaredTypeName?

Returns the enclosing type, like Map for Map.Entry.

equals

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

hashCode

open override fun hashCode(): Int

makeNonOptional

open fun makeNonOptional(): TypeName

makeOptional

open fun makeOptional(): ParameterizedTypeName

nestedType

fun nestedType(name: String): DeclaredTypeName

Returns a new DeclaredTypeName instance for the specified name as nested inside this type.

peerType

fun peerType(name: String): DeclaredTypeName

Returns a type that shares the same enclosing package or type.

topLevelTypeName

fun topLevelTypeName(): DeclaredTypeName

Returns the top type in this nesting group.

toString

open override fun toString(): String

unwrapOptional

open fun unwrapOptional(): TypeName

wrapOptional

open fun wrapOptional(): ParameterizedTypeName

Properties

canonicalName

val canonicalName: String

compoundName

val compoundName: String

moduleName

val moduleName: String

Module name, like "Swift" for Array.Iterator.

name

open val name: String

optional

open val optional: Boolean = false

simpleName

val simpleName: String

Simple name of this type, like "Iterator" for Swift.Array.Iterator.

simpleNames

val simpleNames: List<String>

Extensions

parameterizedBy

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