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. Code blocks are not necessarily well-formed Kotlin code, and are not validated. This class assumes kotlinc will check correctness later!

DelicateKotlinPoetApi

annotation class DelicateKotlinPoetApi(message: String)

Marks declarations in the KotlinPoet API that are delicate — they have limited use-case and shall be used with care in general code. Any use of a delicate declaration has to be carefully reviewed to make sure it is properly used and does not create problems like lossy Java -> Kotlin type parsing. Carefully read documentation and message of any declaration marked as DelicateKotlinPoetApi.

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. To use, first create an instance and allocate all of the names that you need. Typically this is a mix of user-supplied names and constants:

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. This class identifies simple types like Int and String, nullable types like Int?, composite types like Array<String> and Set<String>, and unassignable types like Unit.

TypeSpec

class TypeSpec : Taggable, OriginatingElementsHolder

A generated class, interface, or enum declaration.

TypeVariableName

class TypeVariableName : TypeName

WildcardTypeName

class WildcardTypeName : TypeName

Functions

asClassName

@DelicateKotlinPoetApi(message = "Java reflection APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

@JvmName(name = "get")

fun Class<*>.asClassName(): ClassName

@JvmName(name = "get")

fun KClass<*>.asClassName(): ClassName

@DelicateKotlinPoetApi(message = "Element APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

@JvmName(name = "get")

fun TypeElement.asClassName(): ClassName

Returns the class name for element.

asParameterizedTypeName

@DelicateKotlinPoetApi(message = "Java reflection APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

@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.

@DelicateKotlinPoetApi(message = "Mirror APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

@JvmName(name = "get")

fun TypeMirror.asTypeName(): TypeName

Returns a TypeName equivalent to this TypeMirror.

@JvmName(name = "get")

fun KClass<*>.asTypeName(): ClassName

Returns a TypeName equivalent to this KClass.

fun KType.asTypeName(): TypeName

Returns a TypeName equivalent to the given Kotlin KType using reflection, maybe using kotlin-reflect if required.

asTypeVariableName

@DelicateKotlinPoetApi(message = "Element APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

@JvmName(name = "get")

fun TypeParameterElement.asTypeVariableName(): TypeVariableName

Returns type variable equivalent to element.

@DelicateKotlinPoetApi(message = "Java reflection APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

@JvmName(name = "get")

fun TypeVariable.asTypeVariableName(): TypeVariableName

Returns type variable equivalent to mirror.

fun KTypeParameter.asTypeVariableName(): TypeVariableName

asWildcardTypeName

@DelicateKotlinPoetApi(message = "Java reflection APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

@JvmName(name = "get")

fun WildcardType.asWildcardTypeName(): TypeName

@DelicateKotlinPoetApi(message = "Mirror APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

@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

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

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

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

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

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

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

Attaches tag to the request using T as a key. Tags can be read from a request using Taggable.tag. Use null to remove any existing tag assigned for T.

typeNameOf

@ExperimentalStdlibApi

inline fun <T> typeNameOf(): TypeName

Returns a TypeName equivalent of the reified type parameter T using reflection, maybe using kotlin-reflect if required.

withIndent

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

Calls CodeBlock.Builder.indent then executes the provided builderAction on the CodeBlock.Builder and then executes CodeBlock.Builder.unindent before returning the original CodeBlock.Builder.

Properties

ANNOTATION