kotlinpoet/com.squareup.kotlinpoet/FileSpec

FileSpec

class FileSpec : Taggable, Annotatable, TypeSpecHolder

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

Items are output in the following order:

Comment
Annotations
Package
Imports
Members

Types

class Builder : Taggable.Builder<FileSpec.Builder> , Annotatable.Builder<FileSpec.Builder> , TypeSpecHolder.Builder<FileSpec.Builder>

Companion

object Companion

Properties

annotations

open override val annotations: List<AnnotationSpec>

body

val body: CodeBlock

comment

val comment: CodeBlock

defaultImports

val defaultImports: Set<String>

isScript

val isScript: Boolean

members

val members: List<Any>

name

val name: String

packageName

val packageName: String

relativePath

val relativePath: String

The relative path of the file which would be produced by a call to writeTo. This value always uses unix-style path separators (/).

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

tag

open override fun <T : Any> tag(type: KClass<T>): T?

Returns the tag attached with type as a key, or null if no tag is attached with that key.

open override fun <T : Any> tag(type: <Error class: unknown class><T>): T?

Returns the tag attached with type as a key, or null if no tag is attached with that key.

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.

toBuilder

fun toBuilder(packageName: String = this.packageName, name: String = this.name): FileSpec.Builder

toJavaFileObject

fun toJavaFileObject(): <Error class: unknown class>

toString

open override fun toString(): String

writeTo

fun writeTo(out: <Error class: unknown class>)

fun writeTo(directory: <Error class: unknown class>): <Error class: unknown class>

Writes this to directory as UTF-8 using the standard directory structure and returns the newly output file.

fun writeTo(filer: <Error class: unknown class>)

Writes this to filer.

fun writeTo(directory: <Error class: unknown class>): <Error class: unknown class>

Writes this to directory as UTF-8 using the standard directory structure and returns the newly output path.