Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer

Interface MethodSpec

All Known Implementing Classes:

MethodSpecImpl

@ClassVersion(sourceVersion="$Id: MethodSpec.java 1085 2024-01-05 16:23:28Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public sealed interface MethodSpec
permits MethodSpecImpl

The specification for a generated constructor or method declaration.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.MethodSpec"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MethodSpec.Builder	The builder for an instance of MethodSpec

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONSTRUCTOR	The "name" for a method that is in fact a constructor: "<init>".

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
boolean	hasModifier(Modifier modifier)	Checks whether the method has the given modifier.
boolean	isConstructor()	Checks whether this method is a constructor.
Set<Modifier>	modifiers()	Returns the modifiers of this method.
String	name()	Returns the name of this method.
Collection<ParameterSpec>	parameters()	Returns the parameters for this method.
TypeName	returnType()	Return the return type for this method.
String	signature()	Returns the signature for this method.
default MethodSpec.Builder	toBuilder()	Returns a builder that is initialised with all the components of this method.
MethodSpec.Builder	toBuilder(boolean omitCode)	Returns a builder that is initialised with all the components of this method, like the result of a call to toBuilder(), but without the body code, if specified that way.
String	toString()

Field Details

CONSTRUCTOR

static final String CONSTRUCTOR

The "name" for a method that is in fact a constructor: "<init>".

See Also:

• Constant Field Values

Method Details

equals

boolean equals(Object o)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

hasModifier

boolean hasModifier(Modifier modifier)

Checks whether the method has the given modifier.

Parameters:

modifier - The modifier.

Returns:

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

isConstructor

boolean isConstructor()

Checks whether this method is a constructor.

Returns:

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

modifiers

Set<Modifier> modifiers()

Returns the modifiers of this method.

Returns:

The modifiers.

name

String name()

Returns the name of this method.

Returns:

The name

parameters

Collection<ParameterSpec> parameters()

Returns the parameters for this method.

Returns:

The parameters.

signature

String signature()

Returns the signature for this method.

Returns:

The signature.

returnType

TypeName returnType()

Return the return type for this method.

Returns:

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

toBuilder

default MethodSpec.Builder toBuilder()

Returns a builder that is initialised with all the components of this method. Use this to implement a method from an interface.

Returns:

The builder.

See Also:

• toBuilder(boolean)

toBuilder

@API(status=STABLE,
     since="0.0.8")
MethodSpec.Builder toBuilder(boolean omitCode)

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

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

Parameters:

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

Returns:

The builder.

toString

String toString()

Overrides:

toString in class Object