Package io.micronaut.sourcegen.javapoet

Class CodeBlock

java.lang.Object

io.micronaut.sourcegen.javapoet.CodeBlock

public final class CodeBlock
extends Object

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 Format. Where String.format(java.lang.String, java.lang.Object...) 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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CodeBlock.Builder

Method Summary

Modifier and Type	Method	Description
static CodeBlock.Builder	builder()
static CodeBlock	concat(CodeBlock... codeBlocks)	Concatenates codeBlocks into a single CodeBlock.
boolean	equals(Object o)
int	hashCode()
boolean	isEmpty()
static CodeBlock	join(Iterable<CodeBlock> codeBlocks, String separator)	Joins codeBlocks into a single CodeBlock, each separated by separator.
static Collector<CodeBlock,?,CodeBlock>	joining(String separator)	A Collector implementation that joins CodeBlock instances together into one separated by separator.
static Collector<CodeBlock,?,CodeBlock>	joining(String separator, String prefix, String suffix)	A Collector implementation that joins CodeBlock instances together into one separated by separator.
static CodeBlock	of(String format, Object... args)
static CodeBlock	ofWithoutFormat(String value)
CodeBlock.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

isEmpty

public boolean isEmpty()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

ofWithoutFormat

public static CodeBlock ofWithoutFormat(String value)

of

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

concat

public static CodeBlock concat(CodeBlock... codeBlocks)

Concatenates codeBlocks into a single CodeBlock.

join

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

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

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.

builder

public static CodeBlock.Builder builder()

toBuilder

public CodeBlock.Builder toBuilder()