Interface FieldSpec.Builder

All Known Implementing Classes:

FieldSpecImpl.BuilderImpl

Enclosing interface:

FieldSpec

@ClassVersion(sourceVersion="$Id: FieldSpec.java 1258 2026-06-04 18:33:06Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public static sealed interface FieldSpec.Builder
permits FieldSpecImpl.BuilderImpl

The specification of a builder for an instance of an implementation for FieldSpec

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: FieldSpec.java 1258 2026-06-04 18:33:06Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

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

⁠

Method Summary

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

Method Details

addAnnotation

FieldSpec.Builder addAnnotation(AnnotationSpec annotationSpec)

Adds an annotation for the field.

Parameters:

annotationSpec - The annotation.

Returns:

This Builder instance.

addAnnotation

FieldSpec.Builder addAnnotation(Class<?> annotation)

Adds an annotation for the field.

Parameters:

annotation - The annotation.

Returns:

This Builder instance.

addAnnotation

FieldSpec.Builder addAnnotation(ClassName annotation)

Adds an annotation for the field.

Parameters:

annotation - The annotation.

Returns:

This Builder instance.

addAnnotations

FieldSpec.Builder addAnnotations(Iterable<AnnotationSpec> annotationSpecs)

Adds annotations for the field.

Parameters:

annotationSpecs - The annotations.

Returns:

This Builder instance.

addJavadoc

FieldSpec.Builder addJavadoc(CodeBlock block)

Adds a Javadoc comment for the field.

Parameters:

block - The comment block.

Returns:

This Builder instance.

addJavadoc

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

Adds a Javadoc comment for the field.

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addModifiers

FieldSpec.Builder addModifiers(Modifier... modifiers)

Adds modifiers for the field.

Parameters:

modifiers - The modifiers.

Returns:

This Builder instance.

build

FieldSpec build()

Builds a new FieldSpec instance from the added components.

Returns:

The FieldSpec instance.

initializer

FieldSpec.Builder initializer(CodeBlock codeBlock)

Sets the initializer for the field.

Parameters:

codeBlock - The code that initialises the field.

Returns:

This Builder instance.

initializer

FieldSpec.Builder initializer(String format,
 Object... args)

Sets the initializer for the field.

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.