kotlinpoet/com.squareup.kotlinpoet/FileSpec/Builder

Builder

class Builder : Taggable.Builder<FileSpec.Builder>

Functions

addAliasedImport

fun addAliasedImport(className: ClassName, as: String): FileSpec.Builder

fun addAliasedImport(memberName: MemberName, as: String): FileSpec.Builder

fun addAliasedImport(class: Class<*>, as: String): FileSpec.Builder

fun addAliasedImport(class: KClass<*>, as: String): FileSpec.Builder

fun addAliasedImport( className: ClassName, memberName: String, as: String): FileSpec.Builder

fun addAnnotation(annotationSpec: AnnotationSpec): FileSpec.Builder

Add an annotation to the file.

fun addAnnotation(annotation: ClassName): FileSpec.Builder

fun addAnnotation(annotation: Class<*>): FileSpec.Builder

fun addAnnotation(annotation: KClass<*>): FileSpec.Builder

fun addBodyComment(format: String, vararg args: Any): FileSpec.Builder

Adds a comment to the body of this script file in the order that it was added.

fun addCode(codeBlock: CodeBlock): FileSpec.Builder

fun addCode(format: String, vararg args: Any?): FileSpec.Builder

addDefaultPackageImport

fun addDefaultPackageImport(packageName: String): FileSpec.Builder

Adds a default import for the given packageName.

fun addFileComment(format: String, vararg args: Any): FileSpec.Builder

Adds a file-site comment. This is prefixed to the start of the file and different from addBodyComment.

fun addFunction(funSpec: FunSpec): FileSpec.Builder

fun addImport(import: Import): FileSpec.Builder

fun addImport(constant: Enum<*>): FileSpec.Builder

fun addImport(className: ClassName, vararg names: String): FileSpec.Builder

fun addImport(className: ClassName, names: Iterable<String>): FileSpec.Builder

fun addImport(class: Class<*>, vararg names: String): FileSpec.Builder

fun addImport(class: Class<*>, names: Iterable<String>): FileSpec.Builder

fun addImport(packageName: String, vararg names: String): FileSpec.Builder

fun addImport(packageName: String, names: Iterable<String>): FileSpec.Builder

fun addImport(class: KClass<*>, vararg names: String): FileSpec.Builder

fun addImport(class: KClass<*>, names: Iterable<String>): FileSpec.Builder

addKotlinDefaultImports

fun addKotlinDefaultImports(includeJvm: Boolean = true, includeJs: Boolean = true): FileSpec.Builder

Adds Kotlin's standard default package imports as described here.

fun addNamedCode(format: String, args: Map<String, *>): FileSpec.Builder

fun addProperty(propertySpec: PropertySpec): FileSpec.Builder

fun addStatement(format: String, vararg args: Any): FileSpec.Builder

fun addType(typeSpec: TypeSpec): FileSpec.Builder

fun addTypeAlias(typeAliasSpec: TypeAliasSpec): FileSpec.Builder

beginControlFlow

fun beginControlFlow(controlFlow: String, vararg args: Any): FileSpec.Builder

fun build(): FileSpec

fun clearBody(): FileSpec.Builder

fun clearComment(): FileSpec.Builder

fun clearImports(): FileSpec.Builder

fun endControlFlow(): FileSpec.Builder

fun indent(indent: String): FileSpec.Builder

nextControlFlow

fun nextControlFlow(controlFlow: String, vararg args: Any): FileSpec.Builder

open fun tag(type: Class<*>, tag: Any?): FileSpec.Builder

open fun tag(type: KClass<*>, tag: Any?): FileSpec.Builder

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

Properties

val annotations: MutableList<AnnotationSpec>

val defaultImports: MutableSet<String>

val imports: List<Import>

val isScript: Boolean

val members: MutableList<Any>

val name: String

val packageName: String

open override val tags: MutableMap<KClass<*>, Any>

Mutable map of the current tags this builder contains.

Extensions

jvmMultifileClass

fun FileSpec.Builder.jvmMultifileClass(): FileSpec.Builder

fun FileSpec.Builder.jvmName(name: String): FileSpec.Builder

inline fun <T : Any> FileSpec.Builder.tag(tag: T?): FileSpec.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.