Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class ParameterSpecImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.ParameterSpecImpl

All Implemented Interfaces:

ParameterSpec

@ClassVersion(sourceVersion="$Id: ParameterSpecImpl.java 1085 2024-01-05 16:23:28Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public final class ParameterSpecImpl
extends Object
implements ParameterSpec

The implementation of ParameterSpec.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.ParameterSpecImpl"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ParameterSpecImpl.BuilderImpl	The implementation of ParameterSpec.Builder

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

ParameterSpec.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final List<AnnotationSpecImpl>	m_Annotations	The annotations of this parameter.
private final Lazy<String>	m_CachedString	Lazily initialised return value of toString() for this instance.
private final JavaComposer	m_Composer	The reference to the factory.
private final CodeBlockImpl	m_Javadoc	The Javadoc comment for this type.
private final Set<Modifier>	m_Modifiers	The modifiers of this parameter.
private final String	m_Name	The name of this parameter.
private final TypeNameImpl	m_Type	The type of this parameter.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final void	emit(CodeWriter codeWriter, boolean varargs)	Emits the parameter to the given code writer.
final boolean	equals(Object o)
final JavaComposer	getFactory()	Returns the JavaComposer factory.
final int	hashCode()
final boolean	hasModifier(Modifier modifier)	Checks whether this parameter has the given modifier.
private final String	initializeCachedString()	The initializer for m_CachedString.
final Optional<CodeBlock>	javadoc()	Returns the Javadoc comment for this parameter.
final String	name()	Returns the name of this parameter.
final ParameterSpecImpl.BuilderImpl	toBuilder()	Returns a builder that is initialised with the components of this parameter.
final ParameterSpecImpl.BuilderImpl	toBuilder(TypeName type, CharSequence name, boolean keepJavadoc)	Returns a builder for a parameter with the given type and name, and that is initialised with the components of this parameter.
final String	toString()
final TypeNameImpl	type()	Returns the type of this parameter.

Methods inherited from class java.lang.Object

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

Field Details

m_Annotations

private final List<AnnotationSpecImpl> m_Annotations

The annotations of this parameter.

m_CachedString

private final Lazy<String> m_CachedString

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

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_Javadoc

private final CodeBlockImpl m_Javadoc

The Javadoc comment for this type.

m_Modifiers

private final Set<Modifier> m_Modifiers

The modifiers of this parameter.

m_Name

private final String m_Name

The name of this parameter.

m_Type

private final TypeNameImpl m_Type

The type of this parameter.

Constructor Details

ParameterSpecImpl

public ParameterSpecImpl(ParameterSpecImpl.BuilderImpl builder)

Creates a new ParameterSpecImpl instance.

Parameters:

builder - The builder.

Method Details

emit

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

Emits the parameter to the given code writer.

Parameters:

codeWriter - The code writer.

varargs - true if this parameter is a vararg parameter, false if it is a regular parameter.

Throws:

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

equals

public final boolean equals(Object o)

Specified by:

equals in interface ParameterSpec

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 ParameterSpec

Overrides:

hashCode in class Object

hasModifier

public final boolean hasModifier(Modifier modifier)

Checks whether this parameter has the given modifier.

Specified by:

hasModifier in interface ParameterSpec

Parameters:

modifier - The modifier.

Returns:

true if the parameter has the given modifier, false if not.

initializeCachedString

private final String initializeCachedString()

The initializer for m_CachedString.

Returns:

The return value for toString().

javadoc

public final Optional<CodeBlock> javadoc()

Returns the Javadoc comment for this parameter.

Returns:

An instance of Optional that holds the JavaDoc comment.

name

public final String name()

Returns the name of this parameter.

Specified by:

name in interface ParameterSpec

Returns:

The name.

toBuilder

public final ParameterSpecImpl.BuilderImpl toBuilder()

Returns a builder that is initialised with the components of this parameter.

Specified by:

toBuilder in interface ParameterSpec

Returns:

The builder.

toBuilder

public final ParameterSpecImpl.BuilderImpl toBuilder(TypeName type,
 CharSequence name,
 boolean keepJavadoc)

Returns a builder for a parameter with the given type and name, and that is initialised with the components of this parameter.

Specified by:

toBuilder in interface ParameterSpec

Parameters:

type - The type for the new parameter.

name - The name for the new parameter.

keepJavadoc - true if an existing Javadoc comment should be preserved, false if it should be dropped.

Returns:

The builder.

toString

public final String toString()

Specified by:

toString in interface ParameterSpec

Overrides:

toString in class Object

type

public final TypeNameImpl type()

Returns the type of this parameter.

Specified by:

type in interface ParameterSpec

Returns:

The type