Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer

Interface ParameterSpec.Builder

All Known Implementing Classes:

ParameterSpecImpl.BuilderImpl

Enclosing interface:

ParameterSpec

@ClassVersion(sourceVersion="$Id: ParameterSpec.java 1085 2024-01-05 16:23:28Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public static interface ParameterSpec.Builder

The builder for an instance of ParameterSpec

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.ParameterSpec.Builder"

⁠

Method Summary

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

Method Details

addAnnotation

ParameterSpec.Builder addAnnotation(AnnotationSpec annotationSpec)

Adds an annotation for the parameter.

Parameters:

annotationSpec - The annotation.

Returns:

This Builder instance.

addAnnotation

ParameterSpec.Builder addAnnotation(Class<?> annotation)

Adds an annotation for the parameter.

Parameters:

annotation - The annotation.

Returns:

This Builder instance.

addAnnotation

ParameterSpec.Builder addAnnotation(ClassName annotationClassName)

Adds an annotation for the parameter.

Parameters:

annotationClassName - The name of the annotation class.

Returns:

This Builder instance.

addAnnotations

ParameterSpec.Builder addAnnotations(Iterable<AnnotationSpec> annotationSpecs)

Adds annotations for the parameter.

Parameters:

annotationSpecs - The annotation.

Returns:

This Builder instance.

addJavadoc

ParameterSpec.Builder addJavadoc(CodeBlock block)

Adds text to the JavaDoc for the parameter.

Parameters:

block - The comment text.

Returns:

This Builder instance.

addJavadoc

ParameterSpec.Builder addJavadoc(String format,
 Object... args)

Adds text to the Javadoc for the parameter.

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addModifiers

ParameterSpec.Builder addModifiers(Iterable<Modifier> modifiers)

Adds modifiers for the parameter.

Parameters:

modifiers - The modifiers.

Returns:

This Builder instance.

addModifiers

ParameterSpec.Builder addModifiers(Modifier... modifiers)

Adds modifiers for the parameter.

Parameters:

modifiers - The modifiers.

Returns:

This Builder instance.

build

ParameterSpec build()

Builds a new ParameterSpec instance from the added components.

Returns:

The new ParameterSpec instance.