A fragment of a .java file, potentially containing declarations, statements, and documentation. Code blocks are not necessarily well-formed Java code, and are not validated. This class assumes javac will check correctness later!

Code blocks support placeholders like java.text.Format. Where String#format uses percent % to reference target values, this class uses dollar sign $ and has its own set of permitted placeholders:

$L emits a literal value with no escaping. Arguments for literals may be strings, primitives, type declarations, annotations and even other code blocks.
$N emits a name, using name collision avoidance where necessary. Arguments for names may be strings (actually any character sequence), parameters, fields, methods, and types.
$S escapes the value as a string, wraps it with double quotes, and emits that. For example, 6" sandwich is emitted "6\" sandwich".
$T emits a type reference. Types will be imported if possible. Arguments for types may be classes, ,* type mirrors, and elements.
$$ emits a dollar sign.
$W emits a space or a newline, depending on its position on the line. This prefers to wrap lines before 100 columns.
$Z acts as a zero-width space. This prefers to wrap lines before 100 columns.
$> increases the indentation level.
$< decreases the indentation level.
$[ begins a statement. For multiline statements, every line after the first line is double-indented.
$] ends a statement.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	CodeBlock.Builder
private static class	CodeBlock.CodeBlockJoiner

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

Method Summary

Modifier and Type	Method and Description
public static CodeBlock.Builder	builder()
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.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmpty()
public static CodeBlock	join(Iterable<CodeBlock> codeBlocks, String separator) Joins `codeBlocks` into a single `CodeBlock`, each separated by `separator`.
public static Collector<CodeBlock, ?, CodeBlock>	joining(String separator) A `Collector` implementation that joins `CodeBlock` instances together into one separated by `separator`.
public static Collector<CodeBlock, ?, CodeBlock>	joining(String separator, String prefix, String suffix) A `Collector` implementation that joins `CodeBlock` instances together into one separated by `separator`.
public static CodeBlock	of(String format, Object... args)
public CodeBlock.Builder	toBuilder()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

args	back to summary
pack-priv final List<Object> args

formatParts	back to summary
pack-priv final List<String> formatParts A heterogeneous list containing string literals and value placeholders.

LOWERCASE	back to summary
private static final Pattern LOWERCASE

NAMED_ARGUMENT	back to summary
private static final Pattern NAMED_ARGUMENT

Constructor Detail

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

Method Detail

builder	back to summary
public static CodeBlock.Builder builder()

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

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 this 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 this 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

isEmpty	back to summary
public boolean isEmpty()

join	back to summary
public static CodeBlock join(Iterable<CodeBlock> codeBlocks, String separator) Joins `codeBlocks` into a single `CodeBlock`, each separated by `separator`. For example, joining `String s`, `Object o` and `int i` using `", "` would produce `String s, Object o, int i`.

joining	back to summary
public static Collector<CodeBlock, ?, CodeBlock> joining(String separator) A `Collector` implementation that joins `CodeBlock` instances together into one separated by `separator`. For example, joining `String s`, `Object o` and `int i` using `", "` would produce `String s, Object o, int i`.

joining	back to summary
public static Collector<CodeBlock, ?, CodeBlock> joining(String separator, String prefix, String suffix) A `Collector` implementation that joins `CodeBlock` instances together into one separated by `separator`. For example, joining `String s`, `Object o` and `int i` using `", "` would produce `String s, Object o, int i`.

of	back to summary
public static CodeBlock of(String format, Object... args)

toBuilder	back to summary
public CodeBlock.Builder toBuilder()

toString back to summary

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. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.springframework.javapoet back to summary

public final Class CodeBlock.Builder

Class Inheritance

extends Object

java.lang.Object
org.springframework.javapoet.CodeBlock.Builder

Field Summary

Modifier and Type	Field and Description
pack-priv final List<Object>	args
pack-priv final List<String>	formatParts

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public CodeBlock.Builder	add(String format, Object... args) Add code with positional or relative arguments.
public CodeBlock.Builder	add(CodeBlock codeBlock)
private void	addArgument(String format, char c, Object arg)
public CodeBlock.Builder	addNamed(String format, Map<String, ?> arguments) Adds code using named arguments.
public CodeBlock.Builder	addStatement(String format, Object... args)
public CodeBlock.Builder	addStatement(CodeBlock codeBlock)
private Object	argToLiteral(Object o)
private String	argToName(Object o)
private String	argToString(Object o)
private TypeName	argToType(Object o)
public CodeBlock.Builder	beginControlFlow(String the control flow construct and its code, such as "if (foo == 5)". Shouldn't contain braces or newline characters. controlFlow, Object... args)
public CodeBlock	build()
public CodeBlock.Builder	clear()
public CodeBlock.Builder	endControlFlow()
public CodeBlock.Builder	endControlFlow(String the optional control flow construct and its code, such as "while(foo == 20)". Only used for "do/while" control flows. controlFlow, Object... args)
public CodeBlock.Builder	indent()
public boolean	isEmpty()
private boolean	isNoArgPlaceholder(char c)
public CodeBlock.Builder	nextControlFlow(String the control flow construct and its code, such as "else if (foo == 10)". Shouldn't contain braces or newline characters. controlFlow, Object... args)
public CodeBlock.Builder	unindent()

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

Field Detail

args	back to summary
pack-priv final List<Object> args

formatParts	back to summary
pack-priv final List<String> formatParts

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

add	back to summary
public CodeBlock.Builder add(String format, Object... args) Add code with positional or relative arguments. Relative arguments map 1:1 with the placeholders in the format string. Positional arguments use an index after the placeholder to identify which argument index to use. For example, for a literal to reference the 3rd argument: "$3L" (1 based index) Mixing relative and positional arguments in a call to add is invalid and will result in an error.

add

back to summary

public CodeBlock.Builder add(String format, Object... args)

Add code with positional or relative arguments.

Relative arguments map 1:1 with the placeholders in the format string.

Positional arguments use an index after the placeholder to identify which argument index to use. For example, for a literal to reference the 3rd argument: "$3L" (1 based index)

Mixing relative and positional arguments in a call to add is invalid and will result in an error.

add	back to summary
public CodeBlock.Builder add(CodeBlock codeBlock)

addArgument	back to summary
private void addArgument(String format, char c, Object arg)

addNamed back to summary

addNamed	back to summary
public CodeBlock.Builder addNamed(String format, Map<String, ?> arguments) Adds code using named arguments. Named arguments specify their name after the '$' followed by : and the corresponding type character. Argument names consist of characters in `a-z, A-Z, 0-9, and _` and must start with a lowercase character. For example, to refer to the type `java.lang.Integer` with the argument name `clazz` use a format string containing `$clazz:T` and include the key `clazz` with value `java.lang.Integer.class` in the argument map.

public CodeBlock.Builder addNamed(String format, Map<String, ?> arguments)

Adds code using named arguments.

Named arguments specify their name after the '$' followed by : and the corresponding type character. Argument names consist of characters in a-z, A-Z, 0-9, and _ and must start with a lowercase character.

For example, to refer to the type java.lang.Integer with the argument name clazz use a format string containing $clazz:T and include the key clazz with value java.lang.Integer.class in the argument map.

addStatement	back to summary
public CodeBlock.Builder addStatement(String format, Object... args)

addStatement	back to summary
public CodeBlock.Builder addStatement(CodeBlock codeBlock)

argToLiteral	back to summary
private Object argToLiteral(Object o)

argToName	back to summary
private String argToName(Object o)

argToString	back to summary
private String argToString(Object o)

argToType	back to summary
private TypeName argToType(Object o)

beginControlFlow	back to summary
public CodeBlock.Builder beginControlFlow(String controlFlow, Object... args) Parameters controlFlow:String the control flow construct and its code, such as "if (foo == 5)". Shouldn't contain braces or newline characters.

build	back to summary
public CodeBlock build()

clear	back to summary
public CodeBlock.Builder clear()

endControlFlow	back to summary
public CodeBlock.Builder endControlFlow()

endControlFlow	back to summary
public CodeBlock.Builder endControlFlow(String controlFlow, Object... args) Parameters controlFlow:String the optional control flow construct and its code, such as "while(foo == 20)". Only used for "do/while" control flows.

indent	back to summary
public CodeBlock.Builder indent()

isEmpty	back to summary
public boolean isEmpty()

isNoArgPlaceholder	back to summary
private boolean isNoArgPlaceholder(char c)

nextControlFlow	back to summary
public CodeBlock.Builder nextControlFlow(String controlFlow, Object... args) Parameters controlFlow:String the control flow construct and its code, such as "else if (foo == 10)". Shouldn't contain braces or newline characters.

unindent	back to summary
public CodeBlock.Builder unindent()

Modifier and Type	Method and Description
pack-priv CodeBlock.CodeBlockJoiner	add(CodeBlock codeBlock)
pack-priv CodeBlock	join()
pack-priv CodeBlock.CodeBlockJoiner	merge(CodeBlock.CodeBlockJoiner other)

Modifier and Type	Field and Description
private final CodeBlock.Builder	builder
private final String	delimiter
private boolean	first

public final Class CodeBlock

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class CodeBlock.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CodeBlock.CodeBlockJoiner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail