Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class AnnotationSpecImpl.BuilderImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.AnnotationSpecImpl.BuilderImpl

All Implemented Interfaces:

AnnotationSpec.Builder

Enclosing class:

AnnotationSpecImpl

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

The implementation of AnnotationSpec.Builder for a builder of an AnnotationSpecImpl instance.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,List<CodeBlockImpl>>	m_CodeBlocks	The building blocks.
private final JavaComposer	m_Composer	The reference to the factory.
private boolean	m_ForceInline	A flag that indicates whether the inline representation is forced for this annotation.
private final TypeNameImpl	m_Type	The name of the annotation type to build.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final AnnotationSpecImpl.BuilderImpl	addMember(CharSequence name, String format, Object... args)	Adds a building block.
final AnnotationSpecImpl.BuilderImpl	addMember(CharSequence name, CodeBlock codeBlock)	Adds a building block.
final AnnotationSpecImpl.BuilderImpl	addMemberForValue(String name, Object value)	Delegates to addMember(CharSequence,String,Object...), with parameter format depending on the given value object.
final AnnotationSpecImpl	build()	Creates the AnnotationSpec instance from the added members.
final boolean	forceInline()	Returns the flag that indicates whether this annotation is presented inline or multiline.
final AnnotationSpecImpl.BuilderImpl	forceInline(boolean flag)	Sets a flag that forces the inline presentation of the annotation. Inline:
final JavaComposer	getFactory()	Returns the JavaComposer factory.
final Map<String,List<CodeBlockImpl>>	members()	Returns the members.
final TypeNameImpl	type()	Returns the type of the annotation.

Methods inherited from class java.lang.Object

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

Field Details

m_CodeBlocks

private final Map<String,List<CodeBlockImpl>> m_CodeBlocks

The building blocks.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_ForceInline

private boolean m_ForceInline

A flag that indicates whether the inline representation is forced for this annotation.

See Also:

• AnnotationSpec.Builder.forceInline(boolean)

m_Type

private final TypeNameImpl m_Type

The name of the annotation type to build.

Constructor Details

BuilderImpl

public BuilderImpl(JavaComposer composer,
 TypeName type)

Creates a new BuilderImpl instance.

Parameters:

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

type - The name of the annotation type to build.

Method Details

addMember

public final AnnotationSpecImpl.BuilderImpl addMember(CharSequence name,
 String format,
 Object... args)

Adds a building block.

Specified by:

addMember in interface AnnotationSpec.Builder

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

public final AnnotationSpecImpl.BuilderImpl addMember(CharSequence name,
 CodeBlock codeBlock)

Adds a building block.

Specified by:

addMember in interface AnnotationSpec.Builder

Parameters:

name - The name.

codeBlock - The CodeBlock representing the new member.

Returns:

This Builder instance.

addMemberForValue

public final AnnotationSpecImpl.BuilderImpl addMemberForValue(String name,
 Object value)

Delegates to addMember(CharSequence,String,Object...), with parameter format depending on the given value object. Falls back to "$L" literal format if the class of the given value object is not supported.

Parameters:

name - The name for the new member.

value - The value for the new member.

Returns:

This Builder instance.

build

public final AnnotationSpecImpl build()

Creates the AnnotationSpec instance from the added members.

Specified by:

build in interface AnnotationSpec.Builder

Returns:

The built instance.

forceInline

public final AnnotationSpecImpl.BuilderImpl 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
  )

Specified by:

forceInline in interface AnnotationSpec.Builder

Parameters:

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

Returns:

This Builder instance.

forceInline

public final boolean forceInline()

Returns the flag that indicates whether this annotation is presented inline or multiline.

Returns:

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

getFactory

public final JavaComposer getFactory()

Returns the JavaComposer factory.

Returns:

The reference to the factory.

members

public final Map<String,List<CodeBlockImpl>> members()

Returns the members.

Returns:

The members.

type

public final TypeNameImpl type()

Returns the type of the annotation.

Returns:

The type.