Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer

Interface AnnotationSpec.Builder

All Known Implementing Classes:

AnnotationSpecImpl.BuilderImpl

Enclosing interface:

AnnotationSpec

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

The specification of a builder for an instance of an implementation of AnnotationSpec.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Method Summary

Modifier and Type	Method	Description
AnnotationSpec.Builder	addMember(CharSequence name, String format, Object... args)	Adds a building block.
AnnotationSpec.Builder	addMember(CharSequence name, CodeBlock codeBlock)	Adds a building block.
AnnotationSpec	build()	Creates the AnnotationSpec instance from the added members.
AnnotationSpec.Builder	forceInline(boolean flag)	Sets a flag that forces the inline presentation of the annotation. Inline:

Method Details

addMember

AnnotationSpec.Builder addMember(CharSequence name,
 String format,
 Object... args)

Adds a building block.

Parameters:

name - The name.

format - The format for the CodeBlock.

args - The arguments for the CodeBlock.

Returns:

This Builder instance.

See Also:

• JavaComposer.codeBlockOf(String, Object...)

addMember

AnnotationSpec.Builder addMember(CharSequence name,
 CodeBlock codeBlock)

Adds a building block.

Parameters:

name - The name.

codeBlock - The CodeBlock representing the new member.

Returns:

This Builder instance.

build

AnnotationSpec build()

Creates the AnnotationSpec instance from the added members.

Returns:

The built instance.

forceInline

AnnotationSpec.Builder forceInline(boolean flag)

Sets a flag that forces the inline presentation of the annotation.

Inline:

@Column(name = "updated_at", nullable = false)

Not inline:

  @Column(
      name = "updated_at",
      nullable = false
  )

Parameters:

flag - true for the forced inline presentation, false for the multi-line presentation.

Returns:

This Builder instance.