Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class CodeBlockImpl.BuilderImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.CodeBlockImpl.BuilderImpl

All Implemented Interfaces:

CodeBlock.Builder

Enclosing class:

CodeBlockImpl

@ClassVersion(sourceVersion="$Id: CodeBlockImpl.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public static final class CodeBlockImpl.BuilderImpl
extends Object
implements CodeBlock.Builder

The implementation of CodeBlock.Builder as the builder for a new CodeBlockImpl instance.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: CodeBlockImpl.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.CodeBlockImpl.BuilderImpl"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Collection<Object>	m_Args	The arguments.
private final JavaComposer	m_Composer	The reference to the factory.
private final List<String>	m_FormatParts	The format Strings.
private final Collection<String>	m_StaticImports	The static imports.

Constructor Summary

Constructors

Constructor	Description
BuilderImpl(JavaComposer composer)	Creates a new BuilderImpl instance.
BuilderImpl(JavaComposer composer, List<String> formatParts, List<Object> args)	Creates a new BuilderImpl instance.

Method Summary

Modifier and Type	Method	Description
final CodeBlockImpl.BuilderImpl	add(String format, Object... args)	Adds code with positional or relative arguments.
final CodeBlockImpl.BuilderImpl	add(CodeBlock codeBlock)	Adds a CodeBlock instance.
private final void	addArgument(String format, char placeholder, Object arg)	Adds the placeholder's argument.
private final void	addDebug()	Adds debug output.
final CodeBlockImpl.BuilderImpl	addNamed(String format, Map<String,?> args)	Adds code using named arguments.
final CodeBlockImpl.BuilderImpl	addStatement(String format, Object... args)	Adds a statement.
final CodeBlockImpl.BuilderImpl	addStaticImport(Class<?> clazz, String... names)	Adds a static import.
final CodeBlockImpl.BuilderImpl	addStaticImport(Enum<?> constant)	Adds a static import for the given enum value.
final CodeBlockImpl.BuilderImpl	addStaticImport(ClassName className, String... names)	Adds a static import.
final CodeBlockImpl.BuilderImpl	addWithoutDebugInfo(String format, Object... args)	Adds code with positional or relative arguments, without prepending any debug output.
final CodeBlockImpl.BuilderImpl	addWithoutDebugInfo(CodeBlock codeBlock)	Adds a CodeBlock instance without prepending any debug output.
final List<Object>	args()	Returns the arguments.
private static final Object	argToLiteral(Object o)	Returns the given object literally.
private static final Object	argToName(Object o)	Translates the given object to a name.
private static final Object	argToString(Object o)	Translates the given object to a String.
private static final TypeNameImpl	argToType(Object o)	Translates the given object to a type.
final CodeBlockImpl.BuilderImpl	beginControlFlow(String controlFlow, Object... args)	Starts a control flow construct.
final CodeBlockImpl	build()	Creates the CodeBlock from the added components.
final CodeBlockImpl.BuilderImpl	endControlFlow()	Ends a control flow construct that was previously begun with a call to CodeBlock.Builder.beginControlFlow(String, Object...).
final CodeBlockImpl.BuilderImpl	endControlFlow(String controlFlow, Object... args)	Ends a control flow construct that was previously started with a call to CodeBlock.Builder.beginControlFlow(String,Object...) or CodeBlock.Builder.beginControlFlow(String,Object...).
final List<String>	formatParts()	Returns the format parts.
final CodeBlockImpl.BuilderImpl	indent()	Adds an indentation level to the code block.
final boolean	isEmpty()	Checks whether the code block to build would be empty.
private static final boolean	isNoArgPlaceholder(char placeholder)	Checks whether the given placeholder character would expect an argument.
final CodeBlockImpl.BuilderImpl	nextControlFlow(String controlFlow, Object... args)	Adds another control flow construct to an already existing one.
final CodeBlockImpl.BuilderImpl	unindent()	Removes an indentation level from the code block.

Methods inherited from class java.lang.Object

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

Field Details

m_Args

private final Collection<Object> m_Args

The arguments.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_FormatParts

private final List<String> m_FormatParts

The format Strings.

m_StaticImports

private final Collection<String> m_StaticImports

The static imports.

Constructor Details

BuilderImpl

public BuilderImpl(JavaComposer composer)

Creates a new BuilderImpl instance.

Parameters:

composer - The reference to the factory that created this builder instance.

BuilderImpl

public BuilderImpl(JavaComposer composer,
 List<String> formatParts,
 List<Object> args)

Creates a new BuilderImpl instance.

Parameters:

composer - The reference to the factory that created this builder instance.

formatParts - The format parts.

args - The arguments.

Method Details

add

public final CodeBlockImpl.BuilderImpl add(CodeBlock codeBlock)

Adds a CodeBlock instance.

Specified by:

add in interface CodeBlock.Builder

Parameters:

codeBlock - The code block.

Returns:

This Builder instance.

add

@API(status=INTERNAL,
     since="0.2.0")
public final CodeBlockImpl.BuilderImpl add(String format,
 Object... args)

Adds 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 3^rd argument, use "$3L" (1 based index).

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

Specified by:

add in interface CodeBlock.Builder

Parameters:

format - The format; may be empty.

args - The arguments.

Returns:

This Builder instance.

addArgument

private final void addArgument(String format,
 char placeholder,
 Object arg)

Adds the placeholder's argument.

Parameters:

format - The format.

placeholder - The placeholder character.

arg - The argument.

addDebug

private final void addDebug()

Adds debug output.

addNamed

@API(status=INTERNAL,
     since="0.2.0")
public final CodeBlockImpl.BuilderImpl addNamed(String format,
 Map<String,?> args)

Adds code using named arguments.

Named arguments specify their name after the '$' followed by a colon ":" 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 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.

Specified by:

addNamed in interface CodeBlock.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addStatement

@API(status=STABLE,
     since="0.2.0")
public final CodeBlockImpl.BuilderImpl addStatement(String format,
 Object... args)

Adds a statement.

Do not use this method when the resulting code should be used as a field initializer. Use CodeBlock.Builder.add(String, Object...) instead.

Specified by:

addStatement in interface CodeBlock.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

See Also:

• FieldSpec.Builder.initializer(CodeBlock)

addStaticImport

@API(status=STABLE,
     since="0.2.0")
public final CodeBlockImpl.BuilderImpl addStaticImport(Class<?> clazz,
 String... names)

Adds a static import.

Specified by:

addStaticImport in interface CodeBlock.Builder

Parameters:

clazz - The class.

names - The names of the elements from the given class that are to be imported.

Returns:

This Builder instance.

addStaticImport

@API(status=STABLE,
     since="0.2.0")
public final CodeBlockImpl.BuilderImpl addStaticImport(ClassName className,
 String... names)

Adds a static import.

Specified by:

addStaticImport in interface CodeBlock.Builder

Parameters:

className - The class.

names - The names of the elements from the given class that are to be imported.

Returns:

This Builder instance.

addStaticImport

@API(status=STABLE,
     since="0.2.0")
public final CodeBlockImpl.BuilderImpl addStaticImport(Enum<?> constant)

Adds a static import for the given enum value.

Specified by:

addStaticImport in interface CodeBlock.Builder

Parameters:

constant - The enum value.

Returns:

This Builder instance.

addWithoutDebugInfo

public final CodeBlockImpl.BuilderImpl addWithoutDebugInfo(CodeBlock codeBlock)

Adds a CodeBlock instance without prepending any debug output.

Parameters:

codeBlock - The code block.

Returns:

This Builder instance.

addWithoutDebugInfo

@API(status=INTERNAL,
     since="0.2.0")
public final CodeBlockImpl.BuilderImpl addWithoutDebugInfo(String format,
 Object... args)

Adds code with positional or relative arguments, without prepending any debug output.

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 3^rd argument, use "$3L" (1 based index).

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

Parameters:

format - The format; may be empty.

args - The arguments.

Returns:

This Builder instance.

args

public final List<Object> args()

Returns the arguments.

Returns:

The arguments.

argToLiteral

private static final Object argToLiteral(Object o)

Returns the given object literally.

Parameters:

o - The object.

Returns:

The literal.

argToName

private static final Object argToName(Object o)

Translates the given object to a name.

Parameters:

o - The object.

Returns:

The name.

argToString

private static final Object argToString(Object o)

Translates the given object to a String.

Parameters:

o - The object.

Returns:

The resulting String, or Util.NULL_REFERENCE if the object is null.

argToType

private static final TypeNameImpl argToType(Object o)

Translates the given object to a type.

Parameters:

o - The object.

Returns:

The resulting type.

beginControlFlow

@API(status=INTERNAL,
     since="0.0.5")
public final CodeBlockImpl.BuilderImpl beginControlFlow(String controlFlow,
 Object... args)

Starts a control flow construct.

Specified by:

beginControlFlow in interface CodeBlock.Builder

Parameters:

controlFlow -

The control flow construct and its code, such as if (foo == 5).

Shouldn't contain braces or newline characters.

args - The arguments.

Returns:

This Builder instance.

See Also:

• CodeBlock.Builder.endControlFlow()
• CodeBlock.Builder.endControlFlow(String, Object...)
• CodeBlock.Builder.nextControlFlow(String, Object...)

build

public final CodeBlockImpl build()

Creates the CodeBlock from the added components.

Specified by:

build in interface CodeBlock.Builder

Returns:

The new CodeBlock instance.

endControlFlow

public final CodeBlockImpl.BuilderImpl endControlFlow()

Ends a control flow construct that was previously begun with a call to CodeBlock.Builder.beginControlFlow(String, Object...).

Specified by:

endControlFlow in interface CodeBlock.Builder

Returns:

This Builder instance.

endControlFlow

@API(status=INTERNAL,
     since="0.0.5")
public final CodeBlockImpl.BuilderImpl endControlFlow(String controlFlow,
 Object... args)

Ends a control flow construct that was previously started with a call to CodeBlock.Builder.beginControlFlow(String,Object...) or CodeBlock.Builder.beginControlFlow(String,Object...).

This form is only used for do/while control flows.

Specified by:

endControlFlow in interface CodeBlock.Builder

Parameters:

controlFlow - The optional control flow construct and its code, such as while(foo == 20).

args - The arguments.

Returns:

This Builder instance.

formatParts

public final List<String> formatParts()

Returns the format parts.

Returns:

The format parts.

indent

public final CodeBlockImpl.BuilderImpl indent()

Adds an indentation level to the code block.

Specified by:

indent in interface CodeBlock.Builder

Returns:

This Builder instance.

isEmpty

public final boolean isEmpty()

Checks whether the code block to build would be empty.

Specified by:

isEmpty in interface CodeBlock.Builder

Returns:

true if the code block would be empty, false otherwise.

isNoArgPlaceholder

private static final boolean isNoArgPlaceholder(char placeholder)

Checks whether the given placeholder character would expect an argument.

Parameters:

placeholder - The placeholder character.

Returns:

true if there is no argument expected, false otherwise.

nextControlFlow

@API(status=INTERNAL,
     since="0.0.5")
public final CodeBlockImpl.BuilderImpl nextControlFlow(String controlFlow,
 Object... args)

Adds another control flow construct to an already existing one.

Specified by:

nextControlFlow in interface CodeBlock.Builder

Parameters:

controlFlow -

The control flow construct and its code, such as else if (foo == 10).

Shouldn't contain braces or newline characters.

args - The arguments.

Returns:

This Builder instance.

unindent

public final CodeBlockImpl.BuilderImpl unindent()

Removes an indentation level from the code block.

Specified by:

unindent in interface CodeBlock.Builder

Returns:

This Builder instance.