Package 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 Description private CodeBlock.Builder
fileComment
private java.lang.String
indent
private java.lang.String
packageName
private boolean
skipJavaLangImports
private java.util.Set<java.lang.String>
staticImports
private TypeSpec
typeSpec
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JavaFile.Builder
addFileComment(java.lang.String format, java.lang.Object... args)
JavaFile.Builder
addStaticImport(ClassName className, java.lang.String... names)
JavaFile.Builder
addStaticImport(java.lang.Class<?> clazz, 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 injava.lang
, such asjava.lang.String
.
-
-
-
Field Detail
-
packageName
private final java.lang.String packageName
-
typeSpec
private final TypeSpec typeSpec
-
fileComment
private final CodeBlock.Builder fileComment
-
staticImports
private final java.util.Set<java.lang.String> staticImports
-
skipJavaLangImports
private boolean skipJavaLangImports
-
indent
private java.lang.String indent
-
-
Constructor Detail
-
Builder
private Builder(java.lang.String packageName, TypeSpec typeSpec)
-
-
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 injava.lang
, such asjava.lang.String
.By default, JavaPoet explicitly imports types in
java.lang
to defend against naming conflicts. Suppose an (ill-advised) class is namedcom.example.String
. Whenjava.lang
imports are skipped, generated code incom.example
that referencesjava.lang.String
will getcom.example.String
instead.
-
indent
public JavaFile.Builder indent(java.lang.String indent)
-
build
public JavaFile build()
-
-