Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class MethodSpecImpl.BuilderImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.MethodSpecImpl.BuilderImpl

All Implemented Interfaces:

MethodSpec.Builder

Enclosing class:

MethodSpecImpl

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

The implementation for MethodSpec.Builder

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Collection<AnnotationSpecImpl>	m_Annotations	The annotations for the method.
private final CodeBlockImpl.BuilderImpl	m_Code	The code for the method.
private final JavaComposer	m_Composer	The reference to the factory.
private CodeBlockImpl	m_DefaultValue	The default value for the method; this is for annotations only.
private final Collection<TypeNameImpl>	m_Exceptions	The declared exceptions for the method.
private final CodeBlockImpl.BuilderImpl	m_Javadoc	The Javadoc comment for the method.
private final Set<Modifier>	m_Modifiers	The modifiers for the method.
private final String	m_Name	The name for the method.
private final List<ParameterSpecImpl>	m_Parameters	The parameters for the method.
private final CodeBlockImpl.BuilderImpl	m_ReturnComment	The comment for the return value for the method.
private TypeNameImpl	m_ReturnType	The return type for the method.
private final Collection<String>	m_StaticImports	The static imports.
private final Collection<TypeVariableNameImpl>	m_TypeVariables	The type variables for the method.
private boolean	m_Varargs	The flag that indicates whether a parameter (the last one) is a varargs parameter.

Constructor Summary

Constructors

Constructor	Description
BuilderImpl(JavaComposer composer, CharSequence name)	Creates a new BuilderImpl instance.

Method Summary

Modifier and Type	Method	Description
final MethodSpecImpl.BuilderImpl	addAnnotation(Class<?> annotation)	Adds an annotation for the method.
final MethodSpecImpl.BuilderImpl	addAnnotation(AnnotationSpec annotationSpec)	Adds an annotation for the method.
final MethodSpecImpl.BuilderImpl	addAnnotation(ClassName annotationClass)	Adds an annotation for the method.
final MethodSpecImpl.BuilderImpl	addAnnotations(Iterable<? extends AnnotationSpec> annotationSpecs)	Adds annotations for the method.
final MethodSpecImpl.BuilderImpl	addCode(String format, Object... args)	Adds code for the method.
final MethodSpecImpl.BuilderImpl	addCode(CodeBlock codeBlock)	Adds code for the method.
final MethodSpecImpl.BuilderImpl	addComment(String format, Object... args)	Adds a comment for the method.
final MethodSpecImpl.BuilderImpl	addException(Type exception)	Adds the declaration for an exception for the method.
final MethodSpecImpl.BuilderImpl	addException(TypeName exception)	Adds the declaration for an exception for the method.
final MethodSpecImpl.BuilderImpl	addExceptions(Iterable<? extends TypeName> exceptions)	Adds the declarations for exceptions for the method.
final MethodSpecImpl.BuilderImpl	addJavadoc(String format, Object... args)	Adds a Javadoc comment for the method.
final MethodSpecImpl.BuilderImpl	addJavadoc(CodeBlock block)	Adds a Javadoc comment for the method.
final MethodSpecImpl.BuilderImpl	addModifiers(Iterable<Modifier> modifiers)	Adds modifiers for the method.
final MethodSpecImpl.BuilderImpl	addModifiers(Modifier... modifiers)	Adds modifiers for the method.
final MethodSpecImpl.BuilderImpl	addNamedCode(String format, Map<String,?> args)	Adds code using named arguments for the method.
final MethodSpecImpl.BuilderImpl	addParameter(Type type, String name, Modifier... modifiers)	Adds a parameter for the method.
final MethodSpecImpl.BuilderImpl	addParameter(ParameterSpec parameterSpec)	Adds a parameter for the method.
final MethodSpecImpl.BuilderImpl	addParameter(TypeName type, String name, Modifier... modifiers)	Adds a parameter for the method.
final MethodSpecImpl.BuilderImpl	addParameters(Iterable<? extends ParameterSpec> parameterSpecs)	Adds parameters for the method.
final MethodSpecImpl.BuilderImpl	addStatement(String format, Object... args)	Adds a statement to the code for the method.
final MethodSpecImpl.BuilderImpl	addStaticImport(Class<?> clazz, String... names)	Adds a static import.
final MethodSpecImpl.BuilderImpl	addStaticImport(Enum<?> constant)	Adds a static import for the given enum value.
final MethodSpecImpl.BuilderImpl	addStaticImport(ClassName className, String... names)	Adds a static import.
final MethodSpecImpl.BuilderImpl	addTypeVariable(TypeVariableName typeVariable)	Adds a type variable for the method.
final MethodSpecImpl.BuilderImpl	addTypeVariables(Iterable<TypeVariableName> typeVariables)	Adds type variables for the method.
final MethodSpecImpl.BuilderImpl	beginControlFlow(String controlFlow, Object... args)	Adds the beginning of a control flow for the method.
final MethodSpecImpl	build()	Creates a new MethodSpec instance from the components that have been added to this builder.
final MethodSpecImpl.BuilderImpl	defaultValue(String format, Object... args)	Sets the default value for this method.
final MethodSpecImpl.BuilderImpl	defaultValue(CodeBlock defaultValue)	Sets the default value for this method.
final MethodSpecImpl.BuilderImpl	endControlFlow()	Ends the current control flow for the method.
final MethodSpecImpl.BuilderImpl	endControlFlow(String controlFlow, Object... args)	Ends the current control flow for the method; this version is only used for do-while constructs.
final Collection<TypeNameImpl>	exceptions()	Returns a reference to the declared exceptions.
final MethodSpecImpl.BuilderImpl	nextControlFlow(String controlFlow, Object... args)	Begins another control flow for the method.
final List<ParameterSpecImpl>	parameters()	Returns a reference tothe parameters.
final MethodSpecImpl.BuilderImpl	returns(Type returnType)	Sets the return type for the method.
final MethodSpecImpl.BuilderImpl	returns(Type returnType, String format, Object... args)	Sets the return type for the method and adds the respective Javadoc comment.
final MethodSpecImpl.BuilderImpl	returns(TypeName returnType)	Sets the return type for the method.
final MethodSpecImpl.BuilderImpl	returns(TypeName returnType, String format, Object... args)	Sets the return type for the method and adds the respective Javadoc comment.
final MethodSpecImpl.BuilderImpl	varargs()	Sets the flag that indicates whether a parameter (the last one) is a varargs parameter to true.
final MethodSpecImpl.BuilderImpl	varargs(boolean varargs)	Sets the flag that indicates whether a parameter (the last one) is a varargs parameter.

Methods inherited from class java.lang.Object

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

Field Details

m_Annotations

private final Collection<AnnotationSpecImpl> m_Annotations

The annotations for the method.

m_Code

private final CodeBlockImpl.BuilderImpl m_Code

The code for the method.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_DefaultValue

private CodeBlockImpl m_DefaultValue

The default value for the method; this is for annotations only.

m_Exceptions

private final Collection<TypeNameImpl> m_Exceptions

The declared exceptions for the method.

m_Javadoc

private final CodeBlockImpl.BuilderImpl m_Javadoc

The Javadoc comment for the method.

m_Modifiers

private final Set<Modifier> m_Modifiers

The modifiers for the method.

m_Name

private final String m_Name

The name for the method.

m_Parameters

private final List<ParameterSpecImpl> m_Parameters

The parameters for the method.

m_ReturnComment

private final CodeBlockImpl.BuilderImpl m_ReturnComment

The comment for the return value for the method.

m_ReturnType

private TypeNameImpl m_ReturnType

The return type for the method.

m_StaticImports

private final Collection<String> m_StaticImports

The static imports.

m_TypeVariables

private final Collection<TypeVariableNameImpl> m_TypeVariables

The type variables for the method.

m_Varargs

private boolean m_Varargs

The flag that indicates whether a parameter (the last one) is a varargs parameter.

Constructor Details

BuilderImpl

public BuilderImpl(JavaComposer composer,
 CharSequence name)

Creates a new BuilderImpl instance.

Parameters:

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

name - The name for the method.

Method Details

addAnnotation

public final MethodSpecImpl.BuilderImpl addAnnotation(AnnotationSpec annotationSpec)

Adds an annotation for the method.

Specified by:

addAnnotation in interface MethodSpec.Builder

Parameters:

annotationSpec - The annotation.

Returns:

This Builder instance.

addAnnotation

public final MethodSpecImpl.BuilderImpl addAnnotation(Class<?> annotation)

Adds an annotation for the method.

Specified by:

addAnnotation in interface MethodSpec.Builder

Parameters:

annotation - The annotation.

Returns:

This Builder instance.

addAnnotation

public final MethodSpecImpl.BuilderImpl addAnnotation(ClassName annotationClass)

Adds an annotation for the method.

Specified by:

addAnnotation in interface MethodSpec.Builder

Parameters:

annotationClass - The annotation.

Returns:

This Builder instance.

addAnnotations

public final MethodSpecImpl.BuilderImpl addAnnotations(Iterable<? extends AnnotationSpec> annotationSpecs)

Adds annotations for the method.

Specified by:

addAnnotations in interface MethodSpec.Builder

Parameters:

annotationSpecs - The annotations.

Returns:

This Builder instance.

addCode

public final MethodSpecImpl.BuilderImpl addCode(CodeBlock codeBlock)

Adds code for the method.

Specified by:

addCode in interface MethodSpec.Builder

Parameters:

codeBlock - The code.

Returns:

This Builder instance.

addCode

public final MethodSpecImpl.BuilderImpl addCode(String format,
 Object... args)

Adds code for the method.

Specified by:

addCode in interface MethodSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addComment

public final MethodSpecImpl.BuilderImpl addComment(String format,
 Object... args)

Adds a comment for the method.

Specified by:

addComment in interface MethodSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addException

public final MethodSpecImpl.BuilderImpl addException(Type exception)

Adds the declaration for an exception for the method.

Specified by:

addException in interface MethodSpec.Builder

Parameters:

exception - The exception.

Returns:

This Builder instance.

addException

public final MethodSpecImpl.BuilderImpl addException(TypeName exception)

Adds the declaration for an exception for the method.

Specified by:

addException in interface MethodSpec.Builder

Parameters:

exception - The exception.

Returns:

This Builder instance.

addExceptions

public final MethodSpecImpl.BuilderImpl addExceptions(Iterable<? extends TypeName> exceptions)

Adds the declarations for exceptions for the method.

Specified by:

addExceptions in interface MethodSpec.Builder

Parameters:

exceptions - The exceptions.

Returns:

This Builder instance.

addJavadoc

public final MethodSpecImpl.BuilderImpl addJavadoc(CodeBlock block)

Adds a Javadoc comment for the method.

Specified by:

addJavadoc in interface MethodSpec.Builder

Parameters:

block - The Javadoc comment.

Returns:

This Builder instance.

addJavadoc

public final MethodSpecImpl.BuilderImpl addJavadoc(String format,
 Object... args)

Adds a Javadoc comment for the method.

Specified by:

addJavadoc in interface MethodSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addModifiers

public final MethodSpecImpl.BuilderImpl addModifiers(Iterable<Modifier> modifiers)

Adds modifiers for the method.

Specified by:

addModifiers in interface MethodSpec.Builder

Parameters:

modifiers - The modifiers.

Returns:

This Builder instance.

addModifiers

public final MethodSpecImpl.BuilderImpl addModifiers(Modifier... modifiers)

Adds modifiers for the method.

Specified by:

addModifiers in interface MethodSpec.Builder

Parameters:

modifiers - The modifiers.

Returns:

This Builder instance.

addNamedCode

public final MethodSpecImpl.BuilderImpl addNamedCode(String format,
 Map<String,?> args)

Adds code using named arguments for the method.

Named arguments specify their name after the '$' followed by a colon ":" and the corresponding type character. Argument names consist of characters in a-z, A-Z, 0-9, and _ and must start with a lowercase character.

For example, to refer to the type Integer with the argument name clazz use a format string containing $clazz:T and include the key clazz with value java.lang.Integer.class in the argument map.

Specified by:

addNamedCode in interface MethodSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addParameter

public final MethodSpecImpl.BuilderImpl addParameter(ParameterSpec parameterSpec)

Adds a parameter for the method.

Specified by:

addParameter in interface MethodSpec.Builder

Parameters:

parameterSpec - The parameter.

Returns:

This Builder instance.

addParameter

public final MethodSpecImpl.BuilderImpl addParameter(Type type,
 String name,
 Modifier... modifiers)

Adds a parameter for the method.

Specified by:

addParameter in interface MethodSpec.Builder

Parameters:

type - The type of the parameter.

name - The name of the parameter.

modifiers - The modifiers for the parameter.

Returns:

This Builder instance.

addParameter

public final MethodSpecImpl.BuilderImpl addParameter(TypeName type,
 String name,
 Modifier... modifiers)

Adds a parameter for the method.

Specified by:

addParameter in interface MethodSpec.Builder

Parameters:

type - The type of the parameter.

name - The name of the parameter.

modifiers - The modifiers for the parameter.

Returns:

This Builder instance.

addParameters

public final MethodSpecImpl.BuilderImpl addParameters(Iterable<? extends ParameterSpec> parameterSpecs)

Adds parameters for the method.

Specified by:

addParameters in interface MethodSpec.Builder

Parameters:

parameterSpecs - The parameters.

Returns:

This Builder instance.

addStatement

public final MethodSpecImpl.BuilderImpl addStatement(String format,
 Object... args)

Adds a statement to the code for the method.

Specified by:

addStatement in interface MethodSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

addStaticImport

@API(status=STABLE,
     since="0.2.0")
public final MethodSpecImpl.BuilderImpl addStaticImport(Class<?> clazz,
 String... names)

Adds a static import.

Specified by:

addStaticImport in interface MethodSpec.Builder

Parameters:

clazz - The class.

names - The names of the elements from the given class that are to be imported.

Returns:

This Builder instance.

addStaticImport

@API(status=STABLE,
     since="0.2.0")
public final MethodSpecImpl.BuilderImpl addStaticImport(ClassName className,
 String... names)

Adds a static import.

Specified by:

addStaticImport in interface MethodSpec.Builder

Parameters:

className - The class.

names - The names of the elements from the given class that are to be imported.

Returns:

This Builder instance.

addStaticImport

@API(status=STABLE,
     since="0.2.0")
public final MethodSpecImpl.BuilderImpl addStaticImport(Enum<?> constant)

Adds a static import for the given enum value.

Specified by:

addStaticImport in interface MethodSpec.Builder

Parameters:

constant - The enum value.

Returns:

This Builder instance.

addTypeVariable

public final MethodSpecImpl.BuilderImpl addTypeVariable(TypeVariableName typeVariable)

Adds a type variable for the method.

Specified by:

addTypeVariable in interface MethodSpec.Builder

Parameters:

typeVariable - The type variable.

Returns:

This Builder instance.

addTypeVariables

public final MethodSpecImpl.BuilderImpl addTypeVariables(Iterable<TypeVariableName> typeVariables)

Adds type variables for the method.

Specified by:

addTypeVariables in interface MethodSpec.Builder

Parameters:

typeVariables - The type variables.

Returns:

This Builder instance.

beginControlFlow

public final MethodSpecImpl.BuilderImpl beginControlFlow(String controlFlow,
 Object... args)

Adds the beginning of a control flow for the method.

Specified by:

beginControlFlow in interface MethodSpec.Builder

Parameters:

controlFlow - The control flow construct and its code, such as "if (foo == 5)"; it should not contain braces or newline characters.

args - The arguments.

Returns:

This Builder instance.

See Also:

• MethodSpec.Builder.endControlFlow()
• MethodSpec.Builder.endControlFlow(String, Object...)
• MethodSpec.Builder.nextControlFlow(String, Object...)

build

public final MethodSpecImpl build()

Creates a new MethodSpec instance from the components that have been added to this builder.

Specified by:

build in interface MethodSpec.Builder

Returns:

The MethodSpec instance.

defaultValue

public final MethodSpecImpl.BuilderImpl defaultValue(CodeBlock defaultValue)

Sets the default value for this method.

Specified by:

defaultValue in interface MethodSpec.Builder

Parameters:

defaultValue - The default value.

Returns:

This Builder instance.

defaultValue

public final MethodSpecImpl.BuilderImpl defaultValue(String format,
 Object... args)

Sets the default value for this method.

Specified by:

defaultValue in interface MethodSpec.Builder

Parameters:

format - The format.

args - The arguments.

Returns:

This Builder instance.

endControlFlow

public final MethodSpecImpl.BuilderImpl endControlFlow()

Ends the current control flow for the method.

Specified by:

endControlFlow in interface MethodSpec.Builder

Returns:

This Builder instance.

See Also:

• MethodSpec.Builder.beginControlFlow(String, Object...)
• MethodSpec.Builder.endControlFlow(String, Object...)
• MethodSpec.Builder.nextControlFlow(String, Object...)

endControlFlow

public final MethodSpecImpl.BuilderImpl endControlFlow(String controlFlow,
 Object... args)

Ends the current control flow for the method; this version is only used for do-while constructs.

Specified by:

endControlFlow in interface MethodSpec.Builder

Parameters:

controlFlow - The optional control flow construct and its code, such as "while(foo == 20)"; it should not contain braces or newline characters.

args - The arguments.

Returns:

This Builder instance.

See Also:

• MethodSpec.Builder.beginControlFlow(String, Object...)
• MethodSpec.Builder.endControlFlow()

exceptions

public final Collection<TypeNameImpl> exceptions()

Returns a reference to the declared exceptions.

Returns:

The exceptions.

nextControlFlow

public final MethodSpecImpl.BuilderImpl nextControlFlow(String controlFlow,
 Object... args)

Begins another control flow for the method.

Specified by:

nextControlFlow in interface MethodSpec.Builder

Parameters:

controlFlow - The control flow construct and its code, such as "else if (foo == 10)"; it should not contain braces or newline characters.

args - The arguments.

Returns:

This Builder instance.

See Also:

• MethodSpec.Builder.beginControlFlow(String, Object...)
• MethodSpec.Builder.endControlFlow()

parameters

public final List<ParameterSpecImpl> parameters()

Returns a reference tothe parameters.

Returns:

The parameters.

returns

public final MethodSpecImpl.BuilderImpl returns(Type returnType)

Sets the return type for the method.

Specified by:

returns in interface MethodSpec.Builder

Parameters:

returnType - The return type.

Returns:

This Builder instance.

returns

public final MethodSpecImpl.BuilderImpl returns(Type returnType,
 String format,
 Object... args)

Sets the return type for the method and adds the respective Javadoc comment.

Specified by:

returns in interface MethodSpec.Builder

Parameters:

returnType - The return type.

format - The format for the return comment.

args - The arguments for the return comment.

Returns:

This Builder instance.

returns

public final MethodSpecImpl.BuilderImpl returns(TypeName returnType)

Sets the return type for the method.

Specified by:

returns in interface MethodSpec.Builder

Parameters:

returnType - The return type.

Returns:

This Builder instance.

returns

public final MethodSpecImpl.BuilderImpl returns(TypeName returnType,
 String format,
 Object... args)

Sets the return type for the method and adds the respective Javadoc comment.

Specified by:

returns in interface MethodSpec.Builder

Parameters:

returnType - The return type.

format - The format for the return comment.

args - The arguments for the return comment.

Returns:

This Builder instance.

varargs

public final MethodSpecImpl.BuilderImpl varargs()

Sets the flag that indicates whether a parameter (the last one) is a varargs parameter to true.

Specified by:

varargs in interface MethodSpec.Builder

Returns:

This Builder instance.

varargs

public final MethodSpecImpl.BuilderImpl varargs(boolean varargs)

Sets the flag that indicates whether a parameter (the last one) is a varargs parameter.

Specified by:

varargs in interface MethodSpec.Builder

Parameters:

varargs - true if the last parameter is a varargs parameter, false if not.

Returns:

This Builder instance.