Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class CodeBlockImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.CodeBlockImpl

All Implemented Interfaces:

CodeBlock

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

The implementation of CodeBlock for a fragment of a *.java file.

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"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CodeBlockImpl.BuilderImpl	The implementation of CodeBlock.Builder as the builder for a new CodeBlockImpl instance.
private static final class	CodeBlockImpl.CodeBlockJoiner	A helper class that supports to join code blocks.

Nested classes/interfaces inherited from interface org.tquadrat.foundation.javacomposer.CodeBlock

CodeBlock.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	LOWERCASE	The regular expression that is used to determine whether a parameter name starts with a lowercase character.
private final List<Object>	m_Args	The arguments.
private final Lazy<String>	m_CachedString	Lazily initialised return value of toString() for this code block.
private final JavaComposer	m_Composer	The reference to the factory.
private final List<String>	m_FormatParts	A heterogeneous list containing string literals and value placeholders.
private final Set<String>	m_StaticImports	The static imports.
static final Pattern	NAMED_ARGUMENT	The regular expression that is used to obtain the argument name from a format string.

Constructor Summary

Constructors

Constructor	Description
CodeBlockImpl(CodeBlockImpl.BuilderImpl builder)	Creates a new CodeBlockImpl instance.

Method Summary

Modifier and Type	Method	Description
final List<Object>	args()	Returns the arguments.
final boolean	equals(Object o)
final List<String>	formatParts()	Returns the format parts from this code block.
final JavaComposer	getFactory()	Returns the JavaComposer factory.
final Set<String>	getStaticImports()	Returns the static imports for this code block.
final int	hashCode()
private final String	initialiseCachedString()	The initializer for m_CachedString.
final boolean	isEmpty()	Checks whether this code block is empty.
final CodeBlock	join(String separator, String prefix, String suffix, CodeBlock... codeBlocks)	Joins this code block with the given code blocks into a single new CodeBlock instance, each separated by the given separator.
final CodeBlock	join(String separator, CodeBlock... codeBlocks)	Joins this code block with the given code blocks into a single new CodeBlock instance, each separated by the given separator.
final Collector<CodeBlockImpl,?,CodeBlockImpl>	joining(String separator)	A Collector implementation that joins CodeBlock instances together into one new code block, separated by the given separator.
final Collector<CodeBlockImpl,?,CodeBlockImpl>	joining(String separator, String prefix, String suffix)	A Collector implementation that joins CodeBlock instances together into one new code block, separated by the given separator.
private static final Stream<CodeBlockImpl>	makeCodeBlockStream(CodeBlock head, CodeBlock... tail)	Composes a stream from the given CodeBlock instances.
final CodeBlockImpl.BuilderImpl	toBuilder()	Creates a new builder that is initialised with the components of this code block.
final String	toString()

Methods inherited from class java.lang.Object

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

Field Details

m_Args

private final List<Object> m_Args

The arguments.

m_CachedString

private final Lazy<String> m_CachedString

Lazily initialised return value of toString() for this code block.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_FormatParts

private final List<String> m_FormatParts

A heterogeneous list containing string literals and value placeholders.

m_StaticImports

private final Set<String> m_StaticImports

The static imports.

LOWERCASE

public static final Pattern LOWERCASE

The regular expression that is used to determine whether a parameter name starts with a lowercase character.

NAMED_ARGUMENT

public static final Pattern NAMED_ARGUMENT

The regular expression that is used to obtain the argument name from a format string.

Constructor Details

CodeBlockImpl

public CodeBlockImpl(CodeBlockImpl.BuilderImpl builder)

Creates a new CodeBlockImpl instance.

Parameters:

builder - The builder for this instance.

Method Details

args

public final List<Object> args()

Returns the arguments.

Returns:

The arguments.

equals

public final boolean equals(Object o)

Specified by:

equals in interface CodeBlock

Overrides:

equals in class Object

formatParts

public final List<String> formatParts()

Returns the format parts from this code block.

Returns:

The format parts.

getFactory

public final JavaComposer getFactory()

Returns the JavaComposer factory.

Returns:

The reference to the factory.

getStaticImports

@API(status=INTERNAL,
     since="0.2.0")
public final Set<String> getStaticImports()

Returns the static imports for this code block.

Returns:

The static imports.

hashCode

public final int hashCode()

Specified by:

hashCode in interface CodeBlock

Overrides:

hashCode in class Object

initialiseCachedString

private final String initialiseCachedString()

The initializer for m_CachedString.

Returns:

The return value for toString().

isEmpty

public final boolean isEmpty()

Checks whether this code block is empty.

Specified by:

isEmpty in interface CodeBlock

Returns:

true if the code block is empty, false otherwise.

join

public final CodeBlock join(String separator,
 CodeBlock... codeBlocks)

Joins this code block with the given code blocks into a single new CodeBlock instance, each separated by the given separator.

For example, joining "String s", "Object o" and "int i" using ", " as the separator would produce "String s, Object o, int i".

Specified by:

join in interface CodeBlock

Parameters:

separator - The separator.

codeBlocks - The code blocks to join with this one.

Returns:

The new code block.

join

public final CodeBlock join(String separator,
 String prefix,
 String suffix,
 CodeBlock... codeBlocks)

Joins this code block with the given code blocks into a single new CodeBlock instance, each separated by the given separator. The given prefix will be prepended to the new CodeBloc, and the given suffix will be appended to it.

For example, joining "String s", "Object o" and "int i" using ", " as the separator would produce "String s, Object o, int i".

Specified by:

join in interface CodeBlock

Parameters:

separator - The separator.

prefix - The prefix.

suffix - The suffix.

codeBlocks - The code blocks to join.

Returns:

The new code block.

joining

public final Collector<CodeBlockImpl,?,CodeBlockImpl> joining(String separator)

A Collector implementation that joins CodeBlock instances together into one new code block, separated by the given separator.

For example, joining "String s", "Object o" and "int i" using ", " as the separator would produce "String s, Object o, int i".

Parameters:

separator - The separator.

Returns:

The new collector.

joining

public final Collector<CodeBlockImpl,?,CodeBlockImpl> joining(String separator,
 String prefix,
 String suffix)

A Collector implementation that joins CodeBlock instances together into one new code block, separated by the given separator. The given prefix will be prepended to the new CodeBloc, and the given suffix will be appended to it.

For example, joining "String s", "Object o" and "int i" using ", " as the separator, and "int func( " as the prefix and " )" as the suffix respectively would produce "int func( String s, Object o, int i )".

Parameters:

separator - The separator.

prefix - The prefix.

suffix - The suffix.

Returns:

The new collector.

makeCodeBlockStream

private static final Stream<CodeBlockImpl> makeCodeBlockStream(CodeBlock head,
 CodeBlock... tail)

Composes a stream from the given CodeBlock instances.

Parameters:

head - The first code block.

tail - The other code blocks.

Returns:

The Stream instance with the CodeBlock instances.

toBuilder

public final CodeBlockImpl.BuilderImpl toBuilder()

Creates a new builder that is initialised with the components of this code block.

Specified by:

toBuilder in interface CodeBlock

Returns:

The new builder.

toString

public final String toString()

Specified by:

toString in interface CodeBlock

Overrides:

toString in class Object