Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer

Interface ParameterSpec

All Known Implementing Classes:

ParameterSpecImpl

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

The specification for a generated parameter declaration.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
boolean	hasModifier(Modifier modifier)	Checks whether this parameter has the given modifier.
String	name()	Returns the name of this parameter.
ParameterSpec.Builder	toBuilder()	Returns a builder that is initialised with the components of this parameter.
ParameterSpec.Builder	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.
String	toString()
TypeName	type()	Returns the type of this parameter.

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 this parameter has the given modifier.

Parameters:

modifier - The modifier.

Returns:

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

name

String name()

Returns the name of this parameter.

Returns:

The name.

toBuilder

ParameterSpec.Builder toBuilder()

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

Returns:

The builder.

toBuilder

ParameterSpec.Builder 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.

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

String toString()

Overrides:

toString in class Object

type

TypeName type()

Returns the type of this parameter.

Returns:

The type