Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class ParameterSpecImpl.BuilderImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.ParameterSpecImpl.BuilderImpl

All Implemented Interfaces:

ParameterSpec.Builder

Enclosing class:

ParameterSpecImpl

@ClassVersion(sourceVersion="$Id: ParameterSpecImpl.java 1085 2024-01-05 16:23:28Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public static final class ParameterSpecImpl.BuilderImpl
extends Object
implements ParameterSpec.Builder

The implementation of ParameterSpec.Builder

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ParameterSpecImpl.java 1085 2024-01-05 16:23:28Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final ParameterSpecImpl.BuilderImpl	addAnnotation(Class<?> annotation)	Adds an annotation for the parameter.
final ParameterSpecImpl.BuilderImpl	addAnnotation(AnnotationSpec annotationSpec)	Adds an annotation for the parameter.
final ParameterSpecImpl.BuilderImpl	addAnnotation(ClassName annotationClassName)	Adds an annotation for the parameter.
final ParameterSpecImpl.BuilderImpl	addAnnotations(Iterable<AnnotationSpec> annotationSpecs)	Adds annotations for the parameter.
final ParameterSpecImpl.BuilderImpl	addJavadoc(String format, Object... args)	Adds text to the Javadoc for the parameter.
final ParameterSpecImpl.BuilderImpl	addJavadoc(CodeBlock block)	Adds text to the JavaDoc for the parameter.
final ParameterSpecImpl.BuilderImpl	addModifiers(Iterable<Modifier> modifiers)	Adds modifiers for the parameter.
final ParameterSpecImpl.BuilderImpl	addModifiers(Modifier... modifiers)	Adds modifiers for the parameter.
final ParameterSpecImpl	build()	Builds a new ParameterSpec instance from the added components.

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 parameter.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_Javadoc

private final CodeBlockImpl.BuilderImpl m_Javadoc

The Javadoc comment for the parameter.

m_Modifiers

private final Set<Modifier> m_Modifiers

The modifiers for the parameter.

m_Name

private final String m_Name

The name for the parameter.

m_Type

private final TypeNameImpl m_Type

The type for the parameter.

Constructor Details

BuilderImpl

public BuilderImpl(JavaComposer composer,
 TypeName 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 parameter.

name - The name for the new parameter.

Method Details

addAnnotation

public final ParameterSpecImpl.BuilderImpl addAnnotation(AnnotationSpec annotationSpec)

Adds an annotation for the parameter.

Specified by:

addAnnotation in interface ParameterSpec.Builder

Parameters:

annotationSpec - The annotation.

Returns:

This Builder instance.

addAnnotation

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

Adds an annotation for the parameter.

Specified by:

addAnnotation in interface ParameterSpec.Builder

Parameters:

annotation - The annotation.

Returns:

This Builder instance.

addAnnotation

public final ParameterSpecImpl.BuilderImpl addAnnotation(ClassName annotationClassName)

Adds an annotation for the parameter.

Specified by:

addAnnotation in interface ParameterSpec.Builder

Parameters:

annotationClassName - The name of the annotation class.

Returns:

This Builder instance.

addAnnotations

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

Adds annotations for the parameter.

Specified by:

addAnnotations in interface ParameterSpec.Builder

Parameters:

annotationSpecs - The annotation.

Returns:

This Builder instance.

addJavadoc

public final ParameterSpecImpl.BuilderImpl addJavadoc(CodeBlock block)

Adds text to the JavaDoc for the parameter.

Specified by:

addJavadoc in interface ParameterSpec.Builder

Parameters:

block - The comment text.

Returns:

This Builder instance.

addJavadoc

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

Adds text to the Javadoc for the parameter.

Specified by:

addJavadoc in interface ParameterSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addModifiers

public final ParameterSpecImpl.BuilderImpl addModifiers(Iterable<Modifier> modifiers)

Adds modifiers for the parameter.

Specified by:

addModifiers in interface ParameterSpec.Builder

Parameters:

modifiers - The modifiers.

Returns:

This Builder instance.

addModifiers

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

Adds modifiers for the parameter.

Specified by:

addModifiers in interface ParameterSpec.Builder

Parameters:

modifiers - The modifiers.

Returns:

This Builder instance.

build

public final ParameterSpecImpl build()

Builds a new ParameterSpec instance from the added components.

Specified by:

build in interface ParameterSpec.Builder

Returns:

The new ParameterSpec instance.