kotlinpoet/com.squareup.kotlinpoet

Package-level declarations

Types

Annotatable

interface Annotatable

A spec or type which can be annotated.

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!

ContextReceivable

interface ContextReceivable

A KotlinPoet spec type that can have a context receiver.

DelicateKotlinPoetApi

annotation class DelicateKotlinPoetApi(val 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.

Documentable

interface Documentable

A spec which contains documentation.

Dynamic

object Dynamic : TypeName

ExperimentalKotlinPoetApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalKotlinPoetApi

Indicates that a given API is experimental and subject to change.

FileSpec

class FileSpec : Taggable, Annotatable, TypeSpecHolder, MemberSpecHolder

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

FunSpec

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

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

MemberSpecHolder

interface MemberSpecHolder

A spec which can contain PropertySpecs and FunSpecs.

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

ParameterizedTypeName

class ParameterizedTypeName : TypeName

ParameterSpec

class ParameterSpec : Taggable, Annotatable, Documentable

A generated parameter declaration.

PropertySpec

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

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, Annotatable, Documentable

A generated typealias declaration

TypeName

sealed class TypeName : Taggable, Annotatable

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, ContextReceivable, Annotatable, Documentable, TypeSpecHolder, MemberSpecHolder

A generated class, interface, or enum declaration.

TypeSpecHolder

interface TypeSpecHolder

A spec which can contain other TypeSpec

TypeVariableName

class TypeVariableName : TypeName

WildcardTypeName

class WildcardTypeName : TypeName

Properties

ANNOTATION

val ANNOTATION: ClassName

ANY

val ANY: ClassName

ARRAY

val ARRAY: ClassName

BOOLEAN

val BOOLEAN: ClassName

BOOLEAN_ARRAY

val BOOLEAN_ARRAY: ClassName

BYTE

val BYTE: ClassName

BYTE_ARRAY

val BYTE_ARRAY: ClassName

CHAR

val CHAR: ClassName

CHAR_ARRAY

val CHAR_ARRAY: ClassName

CHAR_SEQUENCE

val CHAR_SEQUENCE: ClassName

COLLECTION

val COLLECTION: ClassName

COMPARABLE

val COMPARABLE: ClassName

DOUBLE

val DOUBLE: ClassName

DOUBLE_ARRAY

val DOUBLE_ARRAY: ClassName

DYNAMIC

val DYNAMIC: Dynamic

Dynamic is a singleton object type, so this is a shorthand for it in Java.

ENUM

val ENUM: ClassName

FLOAT

val FLOAT: ClassName

FLOAT_ARRAY

val FLOAT_ARRAY: ClassName

INT

val INT: ClassName

INT_ARRAY

val INT_ARRAY: ClassName

ITERABLE

val ITERABLE: ClassName

LIST

val LIST: ClassName

LONG

val LONG: ClassName

LONG_ARRAY

val LONG_ARRAY: ClassName

MAP

val MAP: ClassName

MAP_ENTRY

val MAP_ENTRY: ClassName

MUTABLE_COLLECTION

val MUTABLE_COLLECTION: ClassName

MUTABLE_ITERABLE

val MUTABLE_ITERABLE: ClassName

MUTABLE_LIST

val MUTABLE_LIST: ClassName

MUTABLE_MAP

val MUTABLE_MAP: ClassName

MUTABLE_MAP_ENTRY

val MUTABLE_MAP_ENTRY: ClassName

MUTABLE_SET

val MUTABLE_SET: ClassName

NOTHING

val NOTHING: ClassName

NUMBER

val NUMBER: ClassName

SET

val SET: ClassName

SHORT

val SHORT: ClassName

SHORT_ARRAY

val SHORT_ARRAY: ClassName

STAR

val STAR: WildcardTypeName

The wildcard type * which is shorthand for out Any?.

STRING

val STRING: ClassName

THROWABLE

val THROWABLE: ClassName

U_BYTE

val U_BYTE: ClassName

U_BYTE_ARRAY

val U_BYTE_ARRAY: ClassName

U_INT

val U_INT: ClassName

U_INT_ARRAY

val U_INT_ARRAY: ClassName

U_LONG

val U_LONG: ClassName

U_LONG_ARRAY

val U_LONG_ARRAY: ClassName

U_SHORT

val U_SHORT: ClassName

U_SHORT_ARRAY

val U_SHORT_ARRAY: ClassName

UNIT

val UNIT: ClassName

Functions

asClassName

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

fun <Error class: unknown class><out <Error class: unknown class>>.asClassName(): ClassName

fun KClass<*>.asClassName(): ClassName

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

fun <Error class: unknown class>.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.")

fun <Error class: unknown class>.asParameterizedTypeName(): ParameterizedTypeName

Returns a parameterized type equivalent to type.

asTypeName

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

fun <Error class: unknown class>.asTypeName(): TypeName

Returns a TypeName equivalent to this TypeMirror.

fun <Error class: unknown class>.asTypeName(): TypeName

Returns a TypeName equivalent to this Type.

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.")

fun <Error class: unknown class>.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.")

fun <Error class: unknown class>.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.")

fun <Error class: unknown class>.asWildcardTypeName(): TypeName

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

fun <Error class: unknown class>.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

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

Join each CodeBlock in this into a single CodeBlock using separator with an optional prefix and suffix.

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

Apply transform to each element in this, then join into a single CodeBlock using separator with an optional prefix and suffix.

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

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.