Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class FieldSpecImpl.BuilderImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.FieldSpecImpl.BuilderImpl

All Implemented Interfaces:

FieldSpec.Builder

Enclosing class:

FieldSpecImpl

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

The implementation of FieldSpec.Builder

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Collection<AnnotationSpecImpl>	m_Annotations	The annotations for the field.
private final JavaComposer	m_Composer	The reference to the factory.
private CodeBlockImpl	m_Initializer	The initializer for the field.
private final CodeBlockImpl.BuilderImpl	m_Javadoc	The Javadoc comment for the field.
private final Set<Modifier>	m_Modifiers	The modifiers for the field.
private final String	m_Name	The name for the field.
private final TypeNameImpl	m_Type	The type for the field.

Constructor Summary

Constructors

Constructor	Description
BuilderImpl(JavaComposer composer, TypeNameImpl type, CharSequence name)	Creates a new BuilderImpl instance.

Method Summary

Modifier and Type	Method	Description
final FieldSpecImpl.BuilderImpl	addAnnotation(Class<?> annotation)	Adds an annotation for the field.
final FieldSpecImpl.BuilderImpl	addAnnotation(AnnotationSpec annotationSpec)	Adds an annotation for the field.
final FieldSpecImpl.BuilderImpl	addAnnotation(ClassName annotation)	Adds an annotation for the field.
final FieldSpecImpl.BuilderImpl	addAnnotations(Iterable<AnnotationSpec> annotationSpecs)	Adds annotations for the field.
final FieldSpecImpl.BuilderImpl	addJavadoc(String format, Object... args)	Adds a Javadoc comment for the field.
final FieldSpecImpl.BuilderImpl	addJavadoc(CodeBlock block)	Adds a Javadoc comment for the field.
final FieldSpecImpl.BuilderImpl	addModifiers(Modifier... modifiers)	Adds modifiers for the field.
final FieldSpecImpl	build()	Builds a new FieldSpec instance from the added components.
final FieldSpecImpl.BuilderImpl	initializer(String format, Object... args)	Sets the initializer for the field.
final FieldSpecImpl.BuilderImpl	initializer(CodeBlock codeBlock)	Sets the initializer for the field.

Methods inherited from class java.lang.Object

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

Field Details

m_Annotations

private final Collection<AnnotationSpecImpl> m_Annotations

The annotations for the field.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_Initializer

private CodeBlockImpl m_Initializer

The initializer for the field.

m_Javadoc

private final CodeBlockImpl.BuilderImpl m_Javadoc

The Javadoc comment for the field.

m_Modifiers

private final Set<Modifier> m_Modifiers

The modifiers for the field.

m_Name

private final String m_Name

The name for the field.

m_Type

private final TypeNameImpl m_Type

The type for the field.

Constructor Details

BuilderImpl

public BuilderImpl(JavaComposer composer,
 TypeNameImpl type,
 CharSequence name)

Creates a new BuilderImpl instance.

Parameters:

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

type - The type for the new field.

name - The name for the new field.

Method Details

addAnnotation

public final FieldSpecImpl.BuilderImpl addAnnotation(AnnotationSpec annotationSpec)

Adds an annotation for the field.

Specified by:

addAnnotation in interface FieldSpec.Builder

Parameters:

annotationSpec - The annotation.

Returns:

This Builder instance.

addAnnotation

public final FieldSpecImpl.BuilderImpl addAnnotation(Class<?> annotation)

Adds an annotation for the field.

Specified by:

addAnnotation in interface FieldSpec.Builder

Parameters:

annotation - The annotation.

Returns:

This Builder instance.

addAnnotation

public final FieldSpecImpl.BuilderImpl addAnnotation(ClassName annotation)

Adds an annotation for the field.

Specified by:

addAnnotation in interface FieldSpec.Builder

Parameters:

annotation - The annotation.

Returns:

This Builder instance.

addAnnotations

public final FieldSpecImpl.BuilderImpl addAnnotations(Iterable<AnnotationSpec> annotationSpecs)

Adds annotations for the field.

Specified by:

addAnnotations in interface FieldSpec.Builder

Parameters:

annotationSpecs - The annotations.

Returns:

This Builder instance.

addJavadoc

public final FieldSpecImpl.BuilderImpl addJavadoc(CodeBlock block)

Adds a Javadoc comment for the field.

Specified by:

addJavadoc in interface FieldSpec.Builder

Parameters:

block - The comment block.

Returns:

This Builder instance.

addJavadoc

public final FieldSpecImpl.BuilderImpl addJavadoc(String format,
 Object... args)

Adds a Javadoc comment for the field.

Specified by:

addJavadoc in interface FieldSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addModifiers

public final FieldSpecImpl.BuilderImpl addModifiers(Modifier... modifiers)

Adds modifiers for the field.

Specified by:

addModifiers in interface FieldSpec.Builder

Parameters:

modifiers - The modifiers.

Returns:

This Builder instance.

build

public final FieldSpecImpl build()

Builds a new FieldSpec instance from the added components.

Specified by:

build in interface FieldSpec.Builder

Returns:

The FieldSpec instance.

initializer

public final FieldSpecImpl.BuilderImpl initializer(CodeBlock codeBlock)

Sets the initializer for the field.

Specified by:

initializer in interface FieldSpec.Builder

Parameters:

codeBlock - The code that initialises the field.

Returns:

This Builder instance.

initializer

public final FieldSpecImpl.BuilderImpl initializer(String format,
 Object... args)

Sets the initializer for the field.

Specified by:

initializer in interface FieldSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.