Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class MethodSpecImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.MethodSpecImpl

All Implemented Interfaces:

MethodSpec

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

The implementation for MethodSpec.

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"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MethodSpecImpl.BuilderImpl	The implementation for MethodSpec.Builder

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

MethodSpec.Builder

Field Summary

Fields

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

Fields inherited from interface org.tquadrat.foundation.javacomposer.MethodSpec

CONSTRUCTOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Optional<CodeBlockImpl>	defaultValue()	Returns the default value of this method.
final void	emit(CodeWriter codeWriter, Optional<String> enclosingName, Collection<Modifier> implicitModifiers)	Emits this method to the given code writer.
private final void	emit4Foundation(CodeWriter codeWriter, Optional<String> enclosingName, Collection<Modifier> implicitModifiers)	Emits this method to the given code writer, using the Foundation layout.
private final void	emit4JavaPoet(CodeWriter codeWriter, Optional<String> enclosingName, Collection<Modifier> implicitModifiers)	Emits this method to the given code writer, using the JavaPoet layout.
private final void	emitJavadoc(CodeWriter codeWriter)	Emits the Javadoc to the given code writer.
final boolean	equals(Object o)
final List<TypeNameImpl>	exceptions()	Returns the declared exceptions for this method.
final JavaComposer	getFactory()	Returns the JavaComposer factory.
final Set<String>	getStaticImports()	Returns the static imports for this code block.
final int	hashCode()
final boolean	hasModifier(Modifier modifier)	Checks whether the method has the given modifier.
private final String	initializeCachedString()	The initializer for m_CachedString.
final boolean	isConstructor()	Checks whether this method is a constructor.
private static final boolean	lastParameterIsArray(SequencedCollection<ParameterSpecImpl> parameters)	Checks whether the last entry of the given parameter list is an array.
static final MethodSpecImpl.BuilderImpl	methodBuilder(CharSequence name)	Deprecated, for removal: This API element is subject to removal in a future version. Got obsolete with the introduction of JavaComposer.
final Set<Modifier>	modifiers()	Returns the modifiers of this method.
final String	name()	Returns the name of this method.
static final MethodSpecImpl.BuilderImpl	overriding(Method method)	Deprecated, for removal: This API element is subject to removal in a future version. Got obsolete with the introduction of JavaComposer.
static final MethodSpecImpl.BuilderImpl	overriding(ExecutableElement method)	Deprecated, for removal: This API element is subject to removal in a future version. Got obsolete with the introduction of JavaComposer.
static final MethodSpecImpl.BuilderImpl	overriding(ExecutableElement method, DeclaredType enclosing, Types types)	Deprecated, for removal: This API element is subject to removal in a future version. Got obsolete with the introduction of JavaComposer.
final Collection<ParameterSpec>	parameters()	Returns the parameters for this method.
final TypeName	returnType()	Return the return type for this method.
final String	signature()	Returns the signature for this method.
final MethodSpecImpl.BuilderImpl	toBuilder(boolean omitCode)	Returns a builder that is initialised with all the components of this method, like the result of a call to MethodSpec.toBuilder(), but without the body code, if specified that way.
final String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tquadrat.foundation.javacomposer.MethodSpec

toBuilder

Field Details

m_Annotations

private final List<AnnotationSpecImpl> m_Annotations

The annotations of this method.

m_CachedString

private final Lazy<String> m_CachedString

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

m_Code

private final CodeBlockImpl m_Code

The code of this method.

m_Composer

private final JavaComposer m_Composer

The reference to the factory.

m_DefaultValue

private final Optional<CodeBlockImpl> m_DefaultValue

The default value of this method; only applicable for annotations.

m_Exceptions

private final List<TypeNameImpl> m_Exceptions

The declared exceptions for this method.

m_Javadoc

private final CodeBlockImpl m_Javadoc

The Javadoc comment of this method.

m_Modifiers

private final Set<Modifier> m_Modifiers

The modifiers of this method.

m_Name

private final String m_Name

The name of this method.

m_Parameters

private final List<ParameterSpecImpl> m_Parameters

The parameters of this method.

m_ReturnComment

private final CodeBlockImpl m_ReturnComment

The comment for the return value of the method.

m_ReturnType

private final TypeNameImpl m_ReturnType

The return type of the method.

m_StaticImports

private final Set<String> m_StaticImports

The static imports.

m_TypeVariables

private final List<TypeVariableNameImpl> m_TypeVariables

The type variables of this method.

m_Varargs

private final boolean m_Varargs

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

Constructor Details

MethodSpecImpl

public MethodSpecImpl(MethodSpecImpl.BuilderImpl builder)

Creates a new MethodSpecImpl instance.

Parameters:

builder - The builder.

Method Details

defaultValue

public final Optional<CodeBlockImpl> defaultValue()

Returns the default value of this method.

Returns:

An instance of Optional that holds the default value.

emitJavadoc

private final void emitJavadoc(CodeWriter codeWriter)
                        throws UncheckedIOException

Emits the Javadoc to the given code writer.

Parameters:

codeWriter - The code writer.

Throws:

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

emit

public final void emit(CodeWriter codeWriter,
 Optional<String> enclosingName,
 Collection<Modifier> implicitModifiers)
                throws UncheckedIOException

Emits this method to the given code writer.

Parameters:

codeWriter - The code writer.

enclosingName - The name of the type that owns this method.

implicitModifiers - The implicit modifiers for this method.

Throws:

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

emit4Foundation

private final void emit4Foundation(CodeWriter codeWriter,
 Optional<String> enclosingName,
 Collection<Modifier> implicitModifiers)
                            throws UncheckedIOException

Emits this method to the given code writer, using the Foundation layout.

Parameters:

codeWriter - The code writer.

enclosingName - The name of the type that owns this method.

implicitModifiers - The implicit modifiers for this method.

Throws:

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

emit4JavaPoet

private final void emit4JavaPoet(CodeWriter codeWriter,
 Optional<String> enclosingName,
 Collection<Modifier> implicitModifiers)
                          throws UncheckedIOException

Emits this method to the given code writer, using the JavaPoet layout.

Parameters:

codeWriter - The code writer.

enclosingName - The name of the type that owns this method.

implicitModifiers - The implicit modifiers for this method.

Throws:

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

equals

public final boolean equals(Object o)

Specified by:

equals in interface MethodSpec

Overrides:

equals in class Object

exceptions

public final List<TypeNameImpl> exceptions()

Returns the declared exceptions for this method.

Returns:

The declared exceptions.

getFactory

public final JavaComposer getFactory()

Returns the JavaComposer factory.

Returns:

The reference to the factory.

getStaticImports

@API(status=INTERNAL,
     since="0.2.0")
public final Set<String> getStaticImports()

Returns the static imports for this code block.

Returns:

The static imports.

hashCode

public final int hashCode()

Specified by:

hashCode in interface MethodSpec

Overrides:

hashCode in class Object

hasModifier

public final boolean hasModifier(Modifier modifier)

Checks whether the method has the given modifier.

Specified by:

hasModifier in interface MethodSpec

Parameters:

modifier - The modifier.

Returns:

true if the given modifier has been applied to this method, false otherwise.

initializeCachedString

private final String initializeCachedString()

The initializer for m_CachedString.

Returns:

The return value for toString().

isConstructor

public final boolean isConstructor()

Checks whether this method is a constructor.

Specified by:

isConstructor in interface MethodSpec

Returns:

true if the method is a constructor, false if it is a regular method.

lastParameterIsArray

private static final boolean lastParameterIsArray(SequencedCollection<ParameterSpecImpl> parameters)

Checks whether the last entry of the given parameter list is an array.

Parameters:

parameters - The parameter list.

Returns:

true if the last entry of the given parameter list is an array type, false if not.

methodBuilder

@Deprecated(since="0.2.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="0.0.5")
public static final MethodSpecImpl.BuilderImpl methodBuilder(CharSequence name)

Deprecated, for removal: This API element is subject to removal in a future version.

Got obsolete with the introduction of JavaComposer.

Returns a builder for a regular method.

Parameters:

name - The name for the method.

Returns:

The builder.

modifiers

public final Set<Modifier> modifiers()

Returns the modifiers of this method.

Specified by:

modifiers in interface MethodSpec

Returns:

The modifiers.

name

public final String name()

Returns the name of this method.

Specified by:

name in interface MethodSpec

Returns:

The name

overriding

@Deprecated(since="0.2.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="0.0.5")
public static final MethodSpecImpl.BuilderImpl overriding(ExecutableElement method)

Deprecated, for removal: This API element is subject to removal in a future version.

Got obsolete with the introduction of JavaComposer.

Returns a new method spec builder for a method that overrides the given method.

This new builder will copy visibility modifiers, type parameters, return type, name, parameters, and throws declarations. An Override annotation will be added.

Note:

• In JavaPoet 1.2 through 1.7 this method retained annotations from the method and parameters of the overridden method. Since JavaPoet 1.8 and in JavaComposer annotations must be added separately.

Parameters:

method - The method to override.

Returns:

The builder.

overriding

@Deprecated(since="0.2.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="0.0.5")
public static final MethodSpecImpl.BuilderImpl overriding(ExecutableElement method,
 DeclaredType enclosing,
 Types types)

Deprecated, for removal: This API element is subject to removal in a future version.

Got obsolete with the introduction of JavaComposer.

Returns a new method spec builder that overrides the given method as a member of of the given enclosing class. This will resolve type parameters: for example overriding Comparable.compareTo(T) in a type that implements Comparable<Movie>, the T parameter will be resolved to Movie.

This will copy its visibility modifiers, type parameters, return type, name, parameters, and throws declarations. An Override annotation will be added.

Note:

• In JavaPoet 1.2 through 1.7 this method retained annotations from the method and parameters of the overridden method. Since JavaPoet 1.8 and in JavaComposer annotations must be added separately.

Parameters:

method - The method to override.

enclosing - The enclosing class for the method.

types - The type variables.

Returns:

The builder.

overriding

@Deprecated(since="0.2.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="0.0.8")
public static final MethodSpecImpl.BuilderImpl overriding(Method method)

Deprecated, for removal: This API element is subject to removal in a future version.

Got obsolete with the introduction of JavaComposer.

Returns a new method spec builder for a method that overrides the given method.

This new builder will copy visibility modifiers, type parameters, return type, name, parameters, and throws declarations. An Override annotation will be added, but any other annotation will be omitted; this is consistent with the behaviour of overriding(ExecutableElement) and overriding(ExecutableElement, DeclaredType, Types).

Parameters:

method - The method to override.

Returns:

The builder.

parameters

public final Collection<ParameterSpec> parameters()

Returns the parameters for this method.

Specified by:

parameters in interface MethodSpec

Returns:

The parameters.

returnType

public final TypeName returnType()

Return the return type for this method.

Specified by:

returnType in interface MethodSpec

Returns:

The return type; will never be null, not even for a constructor.

signature

public final String signature()

Returns the signature for this method.

Specified by:

signature in interface MethodSpec

Returns:

The signature.

toBuilder

public final MethodSpecImpl.BuilderImpl toBuilder(boolean omitCode)

Returns a builder that is initialised with all the components of this method, like the result of a call to MethodSpec.toBuilder(), but without the body code, if specified that way.

If the body is not copied, the method will be marked as ABSTRACT, too.

Specified by:

toBuilder in interface MethodSpec

Parameters:

omitCode - true if the body code should not be copied, false otherwise; in the latter case, the result is the same as for MethodSpec.toBuilder().

Returns:

The builder.

toString

public final String toString()

Specified by:

toString in interface MethodSpec

Overrides:

toString in class Object