Package com.hendraanggrian.javapoet

Types

AnnotationSpecBuilder

class AnnotationSpecBuilder

Wrapper of AnnotationSpec.Builder, providing DSL support as a replacement to Java builder.

CodeBlockBuilder

class CodeBlockBuilder : CodeBlockHandler

Wrapper of CodeBlock.Builder, providing DSL support as a replacement to Java builder.

FieldSpecBuilder

class FieldSpecBuilder

Wrapper of FieldSpec.Builder, providing DSL support as a replacement to Java builder.

JavaFileBuilder

class JavaFileBuilder : TypeSpecHandler

Wrapper of JavaFile.Builder, providing DSL support as a replacement to Java builder.

MethodSpecBuilder

class MethodSpecBuilder : CodeBlockHandler

Wrapper of MethodSpec.Builder, providing DSL support as a replacement to Java builder.

ParameterSpecBuilder

class ParameterSpecBuilder

Wrapper of ParameterSpec.Builder, providing DSL support as a replacement to Java builder.

SpecDslMarker

@DslMarker()

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class SpecDslMarker

Delimits spec builders' DSL.

TypeSpecBuilder

class TypeSpecBuilder

Wrapper of TypeSpec.Builder, providing DSL support as a replacement to Java builder.

Functions

annotationSpecOf

inline fun <T> annotationSpecOf(): AnnotationSpec

Builds new AnnotationSpec from T.

fun annotationSpecOf(type: ClassName): AnnotationSpec

Builds new AnnotationSpec from ClassName.

fun annotationSpecOf(type: Class<*>): AnnotationSpec

Builds new AnnotationSpec from Class.

fun annotationSpecOf(type: KClass<*>): AnnotationSpec

Builds new AnnotationSpec from KClass.

annotationTypeSpecOf

fun annotationTypeSpecOf(type: ClassName): TypeSpec

Builds new annotation TypeSpec from ClassName.

fun annotationTypeSpecOf(type: String): TypeSpec

Builds new annotation TypeSpec from name.

anonymousTypeSpecOf

fun anonymousTypeSpecOf(code: CodeBlock): TypeSpec

Builds new anonymous TypeSpec from CodeBlock.

fun anonymousTypeSpecOf(format: String, vararg args: Any): TypeSpec

Builds new anonymous TypeSpec from formatting.

arrayOf

inline fun TypeName.arrayOf(): ArrayTypeName

Returns an ArrayTypeName equivalent to TypeName.

inline fun Type.arrayOf(): ArrayTypeName

Returns an ArrayTypeName equivalent to Class.

inline fun KClass<*>.arrayOf(): ArrayTypeName

Returns an ArrayTypeName equivalent to KClass.

fun String.arrayOf(simpleName: String, vararg simpleNames: String): ArrayTypeName

Returns a ClassName created from the given parts and convert it to ArrayTypeName.

asAnnotationSpec

fun AnnotationMirror.asAnnotationSpec(): AnnotationSpec

Converts AnnotationMirror to AnnotationSpec.

fun Annotation.asAnnotationSpec(includeDefaultValues: Boolean = false): AnnotationSpec

Converts Annotation to AnnotationSpec.

asArrayTypeName

inline fun GenericArrayType.asArrayTypeName(): ArrayTypeName

Returns an ArrayTypeName equivalent to GenericArrayType.

inline fun ArrayType.asArrayTypeName(): ArrayTypeName

Returns an ArrayTypeName equivalent to ArrayType.

asClassName

inline fun Class<*>.asClassName(): ClassName

Returns a ClassName equivalent to Class.

inline fun TypeElement.asClassName(): ClassName

Returns a ClassName equivalent to TypeElement.

inline fun KClass<*>.asClassName(): ClassName

Returns a ClassName equivalent to KClass.

asParameterizedTypeName

inline fun ParameterizedType.asParameterizedTypeName(): ParameterizedTypeName

Returns a ParameterizedTypeName equivalent to ParameterizedType.

asParameterSpec

fun VariableElement.asParameterSpec(): ParameterSpec

Converts element to ParameterSpec.

asTypeName

inline fun Type.asTypeName(): TypeName

Returns a TypeName equivalent to Type.

inline fun TypeMirror.asTypeName(): TypeName

Returns a TypeName equivalent to TypeMirror.

inline fun KClass<*>.asTypeName(): TypeName

Returns a TypeName equivalent to KClass.

asTypeVariableName

inline fun TypeVariable<*>.asTypeVariableName(): TypeVariableName

Returns a TypeVariableName equivalent to java.lang.reflect.TypeVariable.

inline fun TypeParameterElement.asTypeVariableName(): TypeVariableName

Returns a TypeVariableName equivalent to TypeParameterElement.

inline fun TypeVariable.asTypeVariableName(): TypeVariableName

Returns a TypeVariableName equivalent to TypeVariable.

asWildcardTypeName

inline fun WildcardType.asWildcardTypeName(): TypeName

Returns a WildcardTypeName equivalent to java.lang.reflect.WildcardType.

inline fun WildcardType.asWildcardTypeName(): TypeName

Returns a WildcardTypeName equivalent to WildcardType.

buildAnnotationSpec

inline fun <T> buildAnnotationSpec(noinline configuration: AnnotationSpecBuilder.() -> Unit): AnnotationSpec

Builds new AnnotationSpec from T, by populating newly created AnnotationSpecBuilder using provided configuration.

fun buildAnnotationSpec(type: ClassName, configuration: AnnotationSpecBuilder.() -> Unit): AnnotationSpec

Builds new AnnotationSpec from ClassName, by populating newly created AnnotationSpecBuilder using provided configuration.

fun buildAnnotationSpec(type: Class<*>, configuration: AnnotationSpecBuilder.() -> Unit): AnnotationSpec

Builds new AnnotationSpec from Class, by populating newly created AnnotationSpecBuilder using provided configuration.

fun buildAnnotationSpec(type: KClass<*>, configuration: AnnotationSpecBuilder.() -> Unit): AnnotationSpec

Builds new AnnotationSpec from KClass, by populating newly created AnnotationSpecBuilder using provided configuration.

buildAnnotationTypeSpec

fun buildAnnotationTypeSpec(type: ClassName, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new annotation TypeSpec from ClassName, by populating newly created TypeSpecBuilder using provided configuration.

fun buildAnnotationTypeSpec(type: String, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new annotation TypeSpec from name, by populating newly created TypeSpecBuilder using provided configuration.

buildAnonymousTypeSpec

fun buildAnonymousTypeSpec(code: CodeBlock, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new anonymous TypeSpec from CodeBlock, by populating newly created TypeSpecBuilder using provided configuration.

fun buildAnonymousTypeSpec(format: String, vararg args: Any, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new anonymous TypeSpec from formatting, by populating newly created TypeSpecBuilder using provided configuration.

buildClassTypeSpec

fun buildClassTypeSpec(type: ClassName, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new class TypeSpec from ClassName, by populating newly created TypeSpecBuilder using provided configuration.

fun buildClassTypeSpec(type: String, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new class TypeSpec from name, by populating newly created TypeSpecBuilder using provided configuration.

buildCodeBlock

fun buildCodeBlock(configuration: CodeBlockBuilder.() -> Unit): CodeBlock

Builds new CodeBlock, by populating newly created CodeBlockBuilder using provided configuration.

buildConstructorMethodSpec

fun buildConstructorMethodSpec(configuration: MethodSpecBuilder.() -> Unit): MethodSpec

Builds new constructor MethodSpec, by populating newly created MethodSpecBuilder using provided configuration.

buildEnumTypeSpec

fun buildEnumTypeSpec(type: ClassName, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new enum TypeSpec from ClassName, by populating newly created TypeSpecBuilder using provided configuration.

fun buildEnumTypeSpec(type: String, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new enum TypeSpec from name, by populating newly created TypeSpecBuilder using provided configuration.

buildFieldSpec

inline fun <T> buildFieldSpec(name: String, vararg modifiers: Modifier, noinline configuration: FieldSpecBuilder.() -> Unit): FieldSpec

Builds new FieldSpec from T supplying its name and modifiers, by populating newly created FieldSpecBuilder using provided configuration.

fun buildFieldSpec(type: TypeName, name: String, vararg modifiers: Modifier, configuration: FieldSpecBuilder.() -> Unit): FieldSpec

Builds new FieldSpec from TypeName supplying its name and modifiers, by populating newly created FieldSpecBuilder using provided configuration.

fun buildFieldSpec(type: Type, name: String, vararg modifiers: Modifier, configuration: FieldSpecBuilder.() -> Unit): FieldSpec

Builds new FieldSpec from Type supplying its name and modifiers, by populating newly created FieldSpecBuilder using provided configuration.

fun buildFieldSpec(type: KClass<*>, name: String, vararg modifiers: Modifier, configuration: FieldSpecBuilder.() -> Unit): FieldSpec

Builds new FieldSpec from KClass supplying its name and modifiers, by populating newly created FieldSpecBuilder using provided configuration.

buildInterfaceTypeSpec

fun buildInterfaceTypeSpec(type: ClassName, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new interface TypeSpec from ClassName, by populating newly created TypeSpecBuilder using provided configuration.

fun buildInterfaceTypeSpec(type: String, configuration: TypeSpecBuilder.() -> Unit): TypeSpec

Builds new interface TypeSpec from name, by populating newly created TypeSpecBuilder using provided configuration.

buildJavaFile

fun buildJavaFile(packageName: String, configuration: JavaFileBuilder.() -> Unit): JavaFile

Builds new JavaFile, by populating newly created JavaFileBuilder using provided configuration.

buildMethodSpec

fun buildMethodSpec(name: String, configuration: MethodSpecBuilder.() -> Unit): MethodSpec

Builds new MethodSpec with name, by populating newly created MethodSpecBuilder using provided configuration.

buildParameterSpec

inline fun <T> buildParameterSpec(name: String, vararg modifiers: Modifier, noinline configuration: ParameterSpecBuilder.() -> Unit): ParameterSpec

Builds new ParameterSpec from T, by populating newly created ParameterSpecBuilder using provided configuration.

fun buildParameterSpec(type: TypeName, name: String, vararg modifiers: Modifier, configuration: ParameterSpecBuilder.() -> Unit): ParameterSpec

Builds new ParameterSpec from TypeName, by populating newly created ParameterSpecBuilder using provided configuration.

fun buildParameterSpec(type: Type, name: String, vararg modifiers: Modifier, configuration: ParameterSpecBuilder.() -> Unit): ParameterSpec

Builds new ParameterSpec from Type, by populating newly created ParameterSpecBuilder using provided configuration.

fun buildParameterSpec(type: KClass<*>, name: String, vararg modifiers: Modifier, configuration: ParameterSpecBuilder.() -> Unit): ParameterSpec

Builds new ParameterSpec from KClass, by populating newly created ParameterSpecBuilder using provided configuration.

classOf

inline fun String.classOf(simpleName: String, vararg simpleNames: String): ClassName

Returns a ClassName created from the given parts.

classTypeSpecOf

fun classTypeSpecOf(type: ClassName): TypeSpec

Builds new class TypeSpec from ClassName.

fun classTypeSpecOf(type: String): TypeSpec

Builds new class TypeSpec with name.

codeBlockOf

fun codeBlockOf(format: String, vararg args: Any): CodeBlock

Converts string to CodeBlock using formatted args.

edit

fun AnnotationSpec.Builder.edit(configuration: AnnotationSpecBuilder.() -> Unit): AnnotationSpec.Builder

Modify existing AnnotationSpec.Builder using provided configuration.

fun CodeBlock.Builder.edit(configuration: CodeBlockBuilder.() -> Unit): CodeBlock.Builder

Modify existing CodeBlock.Builder using provided configuration.

fun FieldSpec.Builder.edit(configuration: FieldSpecBuilder.() -> Unit): FieldSpec.Builder

Modify existing FieldSpec.Builder using provided configuration.

fun MethodSpec.Builder.edit(configuration: MethodSpecBuilder.() -> Unit): MethodSpec.Builder

Modify existing MethodSpec.Builder using provided configuration.

fun ParameterSpec.Builder.edit(configuration: ParameterSpecBuilder.() -> Unit): ParameterSpec.Builder

Modify existing ParameterSpec.Builder using provided configuration.

fun TypeSpec.Builder.edit(configuration: TypeSpecBuilder.() -> Unit): TypeSpec.Builder

Modify existing TypeSpec.Builder using provided configuration.

emptyConstructorMethodSpec

fun emptyConstructorMethodSpec(): MethodSpec

Builds new constructor MethodSpec.

enumTypeSpecOf

fun enumTypeSpecOf(type: ClassName): TypeSpec

Builds new enum TypeSpec from ClassName.

fun enumTypeSpecOf(type: String): TypeSpec

Builds new enum TypeSpec from name.

fieldSpecOf

inline fun <T> fieldSpecOf(name: String, vararg modifiers: Modifier): FieldSpec

Builds new FieldSpec from T supplying its name and modifiers.

fun fieldSpecOf(type: TypeName, name: String, vararg modifiers: Modifier): FieldSpec

Builds new FieldSpec from TypeName supplying its name and modifiers.

fun fieldSpecOf(type: Type, name: String, vararg modifiers: Modifier): FieldSpec

Builds new FieldSpec from Type supplying its name and modifiers.

fun fieldSpecOf(type: KClass<*>, name: String, vararg modifiers: Modifier): FieldSpec

Builds new FieldSpec from KClass supplying its name and modifiers.

interfaceTypeSpecOf

fun interfaceTypeSpecOf(type: ClassName): TypeSpec

Builds new interface TypeSpec from ClassName.

fun interfaceTypeSpecOf(type: String): TypeSpec

Builds new interface TypeSpec from name.

join

fun Iterable<CodeBlock>.join(separator: String): CodeBlock

Joins code blocks into a single CodeBlock, each separated by separator.

methodSpecOf

fun methodSpecOf(name: String): MethodSpec

Builds new MethodSpec with name.

parameterizedBy

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

Returns a ParameterizedTypeName applying TypeName arguments to ClassName.

fun ClassName.parameterizedBy(vararg typeArguments: Type = emptyArray()): ParameterizedTypeName

Returns a ParameterizedTypeName applying Type arguments to ClassName.

fun ClassName.parameterizedBy(vararg typeArguments: KClass<*> = emptyArray()): ParameterizedTypeName

Returns a ParameterizedTypeName applying KClass arguments to ClassName.

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

Returns a ParameterizedTypeName applying TypeName argument list to ClassName.

fun Class<*>.parameterizedBy(vararg typeArguments: TypeName = emptyArray()): ParameterizedTypeName

Returns a ParameterizedTypeName applying TypeName arguments to Class.

inline fun Class<*>.parameterizedBy(vararg typeArguments: Type): ParameterizedTypeName

Returns a ParameterizedTypeName applying Type arguments to Class.

fun Class<*>.parameterizedBy(vararg typeArguments: KClass<*> = emptyArray()): ParameterizedTypeName

Returns a ParameterizedTypeName applying KClass arguments to Class.

fun Class<*>.parameterizedBy(typeArguments: Collection<Type>): ParameterizedTypeName

Returns a ParameterizedTypeName applying Type argument list to Class.

fun KClass<*>.parameterizedBy(vararg typeArguments: TypeName = emptyArray()): ParameterizedTypeName

Returns a ParameterizedTypeName applying TypeName arguments to KClass.

fun KClass<*>.parameterizedBy(vararg typeArguments: Type = emptyArray()): ParameterizedTypeName

Returns a ParameterizedTypeName applying Type arguments to KClass.

inline fun KClass<*>.parameterizedBy(vararg typeArguments: KClass<*>): ParameterizedTypeName

Returns a ParameterizedTypeName applying KClass arguments to KClass.

fun KClass<*>.parameterizedBy(typeArguments: Collection<KClass<*>>): ParameterizedTypeName

Returns a ParameterizedTypeName applying KClass argument list to KClass.

parameterSpecOf

inline fun <T> parameterSpecOf(name: String, vararg modifiers: Modifier): ParameterSpec

Builds new ParameterSpec from T.

fun parameterSpecOf(type: TypeName, name: String, vararg modifiers: Modifier): ParameterSpec

Builds new ParameterSpec from TypeName.

fun parameterSpecOf(type: Type, name: String, vararg modifiers: Modifier): ParameterSpec

Builds new ParameterSpec from Type.

fun parameterSpecOf(type: KClass<*>, name: String, vararg modifiers: Modifier): ParameterSpec

Builds new ParameterSpec from KClass.

typeNameOf

inline fun <T> typeNameOf(): TypeName

Returns a TypeName equivalent to T.

typeVarBy

inline fun String.typeVarBy(vararg bounds: TypeName): TypeVariableName

Returns a TypeVariableName with TypeName bounds.

inline fun String.typeVarBy(vararg bounds: Type): TypeVariableName

Returns a TypeVariableName with Type bounds.

inline fun String.typeVarBy(vararg bounds: KClass<*>): TypeVariableName

Returns a TypeVariableName with KClass bounds.

typeVarOf

inline fun String.typeVarOf(): TypeVariableName

Returns a TypeVariableName without bounds.

wildcardSubtypeOf

inline fun TypeName.wildcardSubtypeOf(): WildcardTypeName

Returns a WildcardTypeName that represents an unknown type that extends TypeName.

inline fun Type.wildcardSubtypeOf(): WildcardTypeName

Returns a WildcardTypeName that represents an unknown type that extends Type.

inline fun KClass<*>.wildcardSubtypeOf(): WildcardTypeName

Returns a WildcardTypeName that represents an unknown type that extends KClass.

wildcardSupertypeOf

inline fun TypeName.wildcardSupertypeOf(): WildcardTypeName

Returns a WildcardTypeName that represents an unknown supertype of TypeName.

inline fun Type.wildcardSupertypeOf(): WildcardTypeName

Returns a WildcardTypeName that represents an unknown supertype of Type.

inline fun KClass<*>.wildcardSupertypeOf(): WildcardTypeName

Returns a WildcardTypeName that represents an unknown supertype of KClass.

Properties

ABSTRACT

val ABSTRACT: Modifier

BOOLEAN

val BOOLEAN: TypeName

BYTE

val BYTE: TypeName

CHAR

val CHAR: TypeName

DEFAULT

val DEFAULT: Modifier

DOUBLE

val DOUBLE: TypeName

FINAL

val FINAL: Modifier

FLOAT

val FLOAT: TypeName

INT

val INT: TypeName

LONG

val LONG: TypeName

NATIVE

val NATIVE: Modifier

OBJECT

val OBJECT: TypeName

PRIVATE

val PRIVATE: Modifier

PROTECTED

val PROTECTED: Modifier

PUBLIC

val PUBLIC: Modifier

SHORT

val SHORT: TypeName

STATIC

val STATIC: Modifier

STRICTFP

val STRICTFP: Modifier

SYNCHRONIZED

val SYNCHRONIZED: Modifier

TRANSIENT

val TRANSIENT: Modifier

VOID

val VOID: TypeName

VOLATILE

val VOLATILE: Modifier