Package com.squareup.kotlinpoet

Types

AnnotationSpec

class AnnotationSpec : Taggable

A generated annotation on a declaration.

ClassName

class ClassName : TypeName, Comparable<ClassName>

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

CodeBlock

class CodeBlock

A fragment of a .kt file, potentially containing declarations, statements, and documentation.

Dynamic

object Dynamic : TypeName

FileSpec

class FileSpec : Taggable

A Kotlin file containing top level objects like classes, objects, functions, properties, and type aliases.

FunSpec

class FunSpec : Taggable, OriginatingElementsHolder

A generated function declaration.

Import

data class Import : Comparable<Import>

KModifier

enum KModifier : Enum<KModifier>

KOperator

enum KOperator : Enum<KOperator>

LambdaTypeName

class LambdaTypeName : TypeName

MemberName

data class MemberName

Represents the name of a member (such as a function or a property).

NameAllocator

class NameAllocator

Assigns Kotlin identifier names to avoid collisions, keywords, and invalid characters.

OriginatingElementsHolder

interface OriginatingElementsHolder

A type that can have originating elements.

ParameterizedTypeName

class ParameterizedTypeName : TypeName

ParameterSpec

class ParameterSpec : Taggable

A generated parameter declaration.

PropertySpec

class PropertySpec : Taggable, OriginatingElementsHolder

A generated property declaration.

Taggable

interface Taggable

A type that can be tagged with extra metadata of the user's choice.

TypeAliasSpec

class TypeAliasSpec : Taggable

A generated typealias declaration

TypeName

sealed class TypeName : Taggable

Any type in Kotlin's type system.

TypeSpec

class TypeSpec : Taggable, OriginatingElementsHolder

A generated class, interface, or enum declaration.

TypeVariableName

class TypeVariableName : TypeName

WildcardTypeName

class WildcardTypeName : TypeName

Functions

asClassName

@JvmName(name = "get")

fun Class<*>.asClassName(): ClassName

@JvmName(name = "get")

fun KClass<*>.asClassName(): ClassName

asParameterizedTypeName

@JvmName(name = "get")

fun ParameterizedType.asParameterizedTypeName(): ParameterizedTypeName

Returns a parameterized type equivalent to type.

asTypeName

@JvmName(name = "get")

fun Type.asTypeName(): TypeName

Returns a TypeName equivalent to this Type.

@JvmName(name = "get")

fun KClass<*>.asTypeName(): ClassName

Returns a TypeName equivalent to this KClass.

fun KType.asTypeName(): TypeName

Returns a class name equivalent to given Kotlin KType.

asTypeVariableName

@JvmName(name = "get")

fun TypeParameterElement.asTypeVariableName(): TypeVariableName

Returns type variable equivalent to element.

@JvmName(name = "get")

fun TypeVariable.asTypeVariableName(): TypeVariableName

Returns type variable equivalent to mirror.

fun KTypeParameter.asTypeVariableName(): TypeVariableName

asWildcardTypeName

@JvmName(name = "get")

fun WildcardType.asWildcardTypeName(): TypeName

buildCodeBlock

inline fun buildCodeBlock(builderAction: CodeBlock.Builder.() -> Unit): CodeBlock

Builds new CodeBlock by populating newly created CodeBlock.Builder using provided builderAction and then converting it to CodeBlock.

joinToCode

@JvmOverloads()

fun Collection<CodeBlock>.joinToCode(separator: CharSequence = ", ", prefix: CharSequence = "", suffix: CharSequence = ""): CodeBlock

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.

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