Modifier and Type	Class and Description
public static class	JavaFile.Builder

Modifier and Type	Field and Description
private final Set<String>	alwaysQualify
public final CodeBlock	fileComment
private final String	indent
private static final Appendable	NULL_APPENDABLE
public final String	packageName
public final boolean	skipJavaLangImports
private final Set<String>	staticImports
public final TypeSpec	typeSpec

Access	Constructor and Description
private	JavaFile(JavaFile.Builder builder)

Method Summary

Modifier and Type	Method and Description
public static JavaFile.Builder	builder(String packageName, TypeSpec typeSpec)
private void	emit(CodeWriter codeWriter)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private void	fillAlwaysQualifiedNames(TypeSpec spec, Set<String> alwaysQualifiedNames)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public JavaFile.Builder	toBuilder()
public JavaFileObject	toJavaFileObject()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writeTo(Appendable out)
public void	writeTo(Path directory) Writes this to `directory` as UTF-8 using the standard directory structure.
public void	writeTo(Path directory, Charset charset) Writes this to `directory` with the provided `charset` using the standard directory structure.
public void	writeTo(File directory) Writes this to `directory` as UTF-8 using the standard directory structure.
public void	writeTo(Filer filer) Writes this to `filer`.
public File	writeToFile(File directory) Writes this to `directory` as UTF-8 using the standard directory structure.
public Path	writeToPath(Path directory) Writes this to `directory` as UTF-8 using the standard directory structure.
public Path	writeToPath(Path directory, Charset charset) Writes this to `directory` with the provided `charset` using the standard directory structure.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

alwaysQualify	back to summary
private final Set<String> alwaysQualify

fileComment	back to summary
public final CodeBlock fileComment

indent	back to summary
private final String indent

NULL_APPENDABLE	back to summary
private static final Appendable NULL_APPENDABLE

packageName	back to summary
public final String packageName

skipJavaLangImports	back to summary
public final boolean skipJavaLangImports

staticImports	back to summary
private final Set<String> staticImports

typeSpec	back to summary
public final TypeSpec typeSpec

Constructor Detail

JavaFile	back to summary
private JavaFile(JavaFile.Builder builder)

Method Detail

builder	back to summary
public static JavaFile.Builder builder(String packageName, TypeSpec typeSpec)

emit	back to summary
private void emit(CodeWriter codeWriter) throws IOException

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

fillAlwaysQualifiedNames	back to summary
private void fillAlwaysQualifiedNames(TypeSpec spec, Set<String> alwaysQualifiedNames)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

toBuilder	back to summary
public JavaFile.Builder toBuilder()

toJavaFileObject	back to summary
public JavaFileObject toJavaFileObject()

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

writeTo	back to summary
public void writeTo(Appendable out) throws IOException

writeTo	back to summary
public void writeTo(Path directory) throws IOException Writes this to `directory` as UTF-8 using the standard directory structure.

writeTo	back to summary
public void writeTo(Path directory, Charset charset) throws IOException Writes this to `directory` with the provided `charset` using the standard directory structure.

writeTo	back to summary
public void writeTo(File directory) throws IOException Writes this to `directory` as UTF-8 using the standard directory structure.

writeTo	back to summary
public void writeTo(Filer filer) throws IOException Writes this to `filer`.

writeToFile	back to summary
public File writeToFile(File directory) throws IOException Writes this to `directory` as UTF-8 using the standard directory structure. Returns the `File` instance to which source is actually written.

writeToPath	back to summary
public Path writeToPath(Path directory) throws IOException Writes this to `directory` as UTF-8 using the standard directory structure. Returns the `Path` instance to which source is actually written.

writeToPath	back to summary
public Path writeToPath(Path directory, Charset charset) throws IOException Writes this to `directory` with the provided `charset` using the standard directory structure. Returns the `Path` instance to which source is actually written.

com.squareup.javapoet back to summary

public final Class JavaFile.Builder

Class Inheritance

extends Object

java.lang.Object
com.squareup.javapoet.JavaFile.Builder

Field Summary

Modifier and Type	Field and Description
private final CodeBlock.Builder	fileComment
private String	indent
private final String	packageName
private boolean	skipJavaLangImports
public final Set<String>	staticImports
private final TypeSpec	typeSpec

Constructor Summary

Access	Constructor and Description
private	Builder(String packageName, TypeSpec typeSpec)

Method Summary

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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

fileComment	back to summary
private final CodeBlock.Builder fileComment

indent	back to summary
private String indent

packageName	back to summary
private final String packageName

skipJavaLangImports	back to summary
private boolean skipJavaLangImports

staticImports	back to summary
public final Set<String> staticImports

typeSpec	back to summary
private final TypeSpec typeSpec

Constructor Detail

Builder	back to summary
private Builder(String packageName, TypeSpec typeSpec)

Method Detail

addFileComment	back to summary
public JavaFile.Builder addFileComment(String format, Object... args)

addStaticImport	back to summary
public JavaFile.Builder addStaticImport(Enum<?> constant)

addStaticImport	back to summary
public JavaFile.Builder addStaticImport(Class<?> clazz, String... names)

addStaticImport	back to summary
public JavaFile.Builder addStaticImport(ClassName className, String... names)

build	back to summary
public JavaFile build()

indent	back to summary
public JavaFile.Builder indent(String indent)

skipJavaLangImports back to summary

skipJavaLangImports	back to summary
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.

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.

public final Class JavaFile

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class JavaFile.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail