com.squareup.javapoet

Class JavaFile.Builder

java.lang.Object

com.squareup.javapoet.JavaFile.Builder

Enclosing class:

JavaFile

public static final class JavaFile.Builder
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Set<java.lang.String>	staticImports

Method Summary

Modifier and Type	Method and Description
JavaFile.Builder	addFileComment(java.lang.String format, java.lang.Object... args)
JavaFile.Builder	addStaticImport(java.lang.Class<?> clazz, java.lang.String... names)
JavaFile.Builder	addStaticImport(ClassName className, java.lang.String... names)
JavaFile.Builder	addStaticImport(java.lang.Enum<?> constant)
JavaFile	build()
JavaFile.Builder	indent(java.lang.String indent)
JavaFile.Builder	skipJavaLangImports(boolean skipJavaLangImports) Call this to omit imports for classes in java.lang, such as java.lang.String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

staticImports

public final java.util.Set<java.lang.String> staticImports

Method Detail

addFileComment

public JavaFile.Builder addFileComment(java.lang.String format,
                                       java.lang.Object... args)

addStaticImport

public JavaFile.Builder addStaticImport(java.lang.Enum<?> constant)

addStaticImport

public JavaFile.Builder addStaticImport(java.lang.Class<?> clazz,
                                        java.lang.String... names)

addStaticImport

public JavaFile.Builder addStaticImport(ClassName className,
                                        java.lang.String... names)

skipJavaLangImports

public JavaFile.Builder skipJavaLangImports(boolean skipJavaLangImports)

Call this to omit imports for classes in java.lang, such as java.lang.String.

By default, JavaPoet explicitly imports types in java.lang to defend against naming conflicts. Suppose an (ill-advised) class is named com.example.String. When java.lang imports are skipped, generated code in com.example that references java.lang.String will get com.example.String instead.

indent

public JavaFile.Builder indent(java.lang.String indent)

build

public JavaFile build()