Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class JavaFileImpl.BuilderImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.JavaFileImpl.BuilderImpl

All Implemented Interfaces:

JavaFile.Builder

Enclosing class:

JavaFileImpl

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

The builder for an instance of JavaFileImpl as an implementation of JavaFile.Builder.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final JavaComposer	m_Composer	The reference to the factory.
private final CodeBlockImpl.BuilderImpl	m_FileComment	The file comment.
private Layout	m_Layout	The layout for the output of JavaFile.
private final String	m_PackageName	The name of the package for the class in the JavaFileImpl.
private boolean	m_SkipJavaLangImports	Flag that determines whether to skip the imports for classes from the package java.lang.
private final Collection<String>	m_StaticImports	The static imports.
private final TypeSpecImpl	m_TypeSpec	The TypeSpecImpl for the class in the JavaFileImpl.

Constructor Summary

Constructors

Constructor	Description
BuilderImpl(JavaComposer composer, CharSequence packageName, TypeSpecImpl typeSpec)	Creates a new BuilderImpl instance.
BuilderImpl(JavaComposer composer, CharSequence packageName, TypeSpecImpl typeSpec, CodeBlockImpl fileComment, Layout layout, boolean skipJavaLangImports)	Creates a new BuilderImpl instance.

Method Summary

Modifier and Type	Method	Description
final JavaFileImpl.BuilderImpl	addFileComment(String format, Object... args)	Adds text to the file comment.
final JavaFileImpl.BuilderImpl	addStaticImport(Class<?> clazz, String... names)	Adds a static import.
final JavaFileImpl.BuilderImpl	addStaticImport(Enum<?> constant)	Adds a static import for the given enum value.
final JavaFileImpl.BuilderImpl	addStaticImport(ClassName className, String... names)	Adds a static import.
final JavaFileImpl	build()	Builds an instance of JavaFile from this builder.
final CodeBlockImpl	fileComment()	Returns the file comment.
final Layout	layout()	Returns the layout for the output of the JavaFile.
final String	packageName()	Returns the package name.
final boolean	skipJavaLangImports()	Returns the flag that rules whether imports for classes from the package java.lang will be omitted.
final JavaFileImpl.BuilderImpl	skipJavaLangImports(boolean flag)	Call this to omit imports for classes from the package java.lang, such as String or Math.
final Set<String>	staticImports()	Returns the static imports.
final TypeSpecImpl	typeSpec()	Returns the specification of the type for the Java file.

Methods inherited from class java.lang.Object

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

Field Details

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_FileComment

private final CodeBlockImpl.BuilderImpl m_FileComment

The file comment.

m_Layout

private Layout m_Layout

The layout for the output of JavaFile.

m_PackageName

private final String m_PackageName

The name of the package for the class in the JavaFileImpl.

m_SkipJavaLangImports

private boolean m_SkipJavaLangImports

Flag that determines whether to skip the imports for classes from the package java.lang.

m_StaticImports

private final Collection<String> m_StaticImports

The static imports.

m_TypeSpec

private final TypeSpecImpl m_TypeSpec

The TypeSpecImpl for the class in the JavaFileImpl.

Constructor Details

BuilderImpl

public BuilderImpl(JavaComposer composer,
 CharSequence packageName,
 TypeSpecImpl typeSpec)

Creates a new BuilderImpl instance.

Parameters:

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

packageName - The name of the package for the class in the Java file. May be empty for the default package.

typeSpec - The TypeSpec instance for the class in the Java file.

BuilderImpl

public BuilderImpl(JavaComposer composer,
 CharSequence packageName,
 TypeSpecImpl typeSpec,
 CodeBlockImpl fileComment,
 Layout layout,
 boolean skipJavaLangImports)

Creates a new BuilderImpl instance.

Parameters:

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

packageName - The name of the package for the class in the JavaFileImpl.

typeSpec - The TypeSpecImpl instance for the class in the JavaFileImpl.

fileComment - The already existing file comments.

layout - The layout for the output of JavaFile.

skipJavaLangImports - true means that the imports for classes from the package java.lang are skipped, false means that the imports are added explicitly.

Method Details

addFileComment

public final JavaFileImpl.BuilderImpl addFileComment(String format,
 Object... args)

Adds text to the file comment.

Specified by:

addFileComment in interface JavaFile.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addStaticImport

public final JavaFileImpl.BuilderImpl addStaticImport(Class<?> clazz,
 String... names)

Adds a static import.

Specified by:

addStaticImport in interface JavaFile.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

public final JavaFileImpl.BuilderImpl addStaticImport(ClassName className,
 String... names)

Adds a static import.

Specified by:

addStaticImport in interface JavaFile.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

public final JavaFileImpl.BuilderImpl addStaticImport(Enum<?> constant)

Adds a static import for the given enum value.

Specified by:

addStaticImport in interface JavaFile.Builder

Parameters:

constant - The enum value.

Returns:

This Builder instance.

build

public final JavaFileImpl build()

Builds an instance of JavaFile from this builder.

Specified by:

build in interface JavaFile.Builder

Returns:

The JavaFile instance.

fileComment

public final CodeBlockImpl fileComment()

Returns the file comment.

Returns:

The file comment.

layout

public final Layout layout()

Returns the layout for the output of the JavaFile.

Returns:

The layout.

packageName

public final String packageName()

Returns the package name.

Returns:

The package name.

skipJavaLangImports

public final JavaFileImpl.BuilderImpl skipJavaLangImports(boolean flag)

Call this to omit imports for classes from the package java.lang, such as String or Math.

By default, JavaComposer 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.

Specified by:

skipJavaLangImports in interface JavaFile.Builder

Parameters:

flag - true means that the imports for classes from the package java.lang are skipped, false means that the imports are added explicitly.

Returns:

This Builder instance.

skipJavaLangImports

public final boolean skipJavaLangImports()

Returns the flag that rules whether imports for classes from the package java.lang will be omitted.

Returns:

true means that the imports for classes from the package java.lang are skipped, false means that the imports are added explicitly.

See Also:

• skipJavaLangImports(boolean)

staticImports

public final Set<String> staticImports()

Returns the static imports.

Returns:

The static imports.

typeSpec

public final TypeSpecImpl typeSpec()

Returns the specification of the type for the Java file.

Returns:

The type specification.