Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class AnnotationSpecImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.AnnotationSpecImpl

All Implemented Interfaces:

AnnotationSpec

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

The implementation of AnnotationSpec for a generated annotation on a declaration.

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"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AnnotationSpecImpl.BuilderImpl	The implementation of AnnotationSpec.Builder for a builder of an AnnotationSpecImpl instance.

Nested classes/interfaces inherited from interface org.tquadrat.foundation.javacomposer.AnnotationSpec

AnnotationSpec.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final Lazy<String>	m_CachedString	Lazily initialised return value of toString() for this annotation.
private final JavaComposer	m_Composer	The reference to the factory.
private final boolean	m_ForceInline	A flag that indicates whether the inline representation is forced for this annotation.
private final Map<String,List<CodeBlockImpl>>	m_Members	The code blocks that define this annotation.
private final TypeNameImpl	m_Type	The name of this annotation.

Constructor Summary

Constructors

Constructor	Description
AnnotationSpecImpl(AnnotationSpecImpl.BuilderImpl builder)	Creates a new AnnotationSpecImpl instance.

Method Summary

Modifier and Type	Method	Description
final void	emit(CodeWriter codeWriter, boolean inline)	Emits this annotation to the given code writer.
private final void	emit4Foundation(CodeWriter codeWriter, boolean inline)	Emits this annotation to the given code writer.
private final void	emit4JavaPoet(CodeWriter codeWriter, boolean inline)	Emits this annotation to the given code writer using the original JavaPoet layout.
private static final void	emitAnnotationValues(CodeWriter codeWriter, String whitespace, String memberSeparator, List<CodeBlockImpl> values)	Emits the values of this annotation to the given code writer.
final boolean	equals(Object o)
final JavaComposer	getFactory()	Returns the JavaComposer factory.
final int	hashCode()
private final String	initializeCachedString()	The initializer for m_CachedString.
final AnnotationSpec.Builder	toBuilder()	Creates a new builder that is initialised with the components of this annotation.
final String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

m_CachedString

private final Lazy<String> m_CachedString

Lazily initialised return value of toString() for this annotation.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_ForceInline

private final boolean m_ForceInline

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

See Also:

• AnnotationSpec.Builder.forceInline(boolean)

m_Members

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

The code blocks that define this annotation.

m_Type

private final TypeNameImpl m_Type

The name of this annotation.

Constructor Details

AnnotationSpecImpl

public AnnotationSpecImpl(AnnotationSpecImpl.BuilderImpl builder)

Creates a new AnnotationSpecImpl instance.

Parameters:

builder - The builder for this instance.

Method Details

emit

public final void emit(CodeWriter codeWriter,
 boolean inline)
                throws UncheckedIOException

Emits this annotation to the given code writer.

Parameters:

codeWriter - The code writer.

inline - true if the annotation should be placed on the same line as the annotated element, false otherwise.

Throws:

UncheckedIOException - A problem occurred when writing to the output target.

emit4Foundation

private final void emit4Foundation(CodeWriter codeWriter,
 boolean inline)
                            throws UncheckedIOException

Emits this annotation to the given code writer.

Parameters:

codeWriter - The code writer.

inline - true if the annotation should be placed on the same line as the annotated element, false otherwise.

Throws:

UncheckedIOException - A problem occurred when writing to the output target.

emit4JavaPoet

private final void emit4JavaPoet(CodeWriter codeWriter,
 boolean inline)
                          throws UncheckedIOException

Emits this annotation to the given code writer using the original JavaPoet layout.

Parameters:

codeWriter - The code writer.

inline - true if the annotation should be placed on the same line as the annotated element, false otherwise.

Throws:

UncheckedIOException - A problem occurred when writing to the output target.

emitAnnotationValues

private static final void emitAnnotationValues(CodeWriter codeWriter,
 String whitespace,
 String memberSeparator,
 List<CodeBlockImpl> values)
                                        throws UncheckedIOException

Emits the values of this annotation to the given code writer.

Parameters:

codeWriter - The code writer.

whitespace - The whitespace to emit.

memberSeparator - The separator for the members.

values - The members to emit.

Throws:

UncheckedIOException - A problem occurred when writing to the output target.

equals

public final boolean equals(Object o)

Specified by:

equals in interface AnnotationSpec

Overrides:

equals in class Object

getFactory

public final JavaComposer getFactory()

Returns the JavaComposer factory.

Returns:

The reference to the factory.

hashCode

public final int hashCode()

Specified by:

hashCode in interface AnnotationSpec

Overrides:

hashCode in class Object

initializeCachedString

private final String initializeCachedString()

The initializer for m_CachedString.

Returns:

The return value for toString().

toBuilder

public final AnnotationSpec.Builder toBuilder()

Creates a new builder that is initialised with the components of this annotation.

Specified by:

toBuilder in interface AnnotationSpec

Returns:

The new builder.

toString

public final String toString()

Specified by:

toString in interface AnnotationSpec

Overrides:

toString in class Object