Package io.spring.initializr.generator.language

Class Parameter

java.lang.Object

io.spring.initializr.generator.language.Parameter

All Implemented Interfaces:

Annotatable

public class Parameter
extends Object
implements Annotatable

A parameter, typically of a method or function.

Author:

Andy Wilkinson, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameter.Builder	Builder for creating a Parameter.

Constructor Summary

Constructors

Constructor	Description
Parameter(String type, String name)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of of(String, String)

Method Summary

Modifier and Type	Method	Description
AnnotationContainer	annotations()	Return the AnnotationContainer to use to configure the annotations of this element.
static Parameter.Builder	builder(String name)	Initialize a builder for a parameter with the specified name.
String	getName()	Return the name of the parameter.
String	getType()	Return the typ of the parameter.
static Parameter	of(String name, ClassName type)	Create a parameter with the specified name and type.
static Parameter	of(String name, Class<?> type)	Create a parameter with the specified name and type.
static Parameter	of(String name, String type)	Create a parameter with the specified name and type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spring.initializr.generator.language.Annotatable

annotate, getAnnotations

Constructor Details

Parameter

@Deprecated(since="0.20.0",
            forRemoval=true)
public Parameter(String type,
 String name)

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

in favor of of(String, String)

Create a parameter with the specified type and name.

Parameters:

type - the type of the annotation

name - the name of the annotation

Method Details

of

public static Parameter of(String name,
 String type)

Create a parameter with the specified name and type.

Parameters:

name - the name of the parameter

type - the type

Returns:

a parameter

of

public static Parameter of(String name,
 ClassName type)

Create a parameter with the specified name and type.

Parameters:

name - the name of the parameter

type - the type

Returns:

a parameter

of

public static Parameter of(String name,
 Class<?> type)

Create a parameter with the specified name and type.

Parameters:

name - the name of the parameter

type - the type

Returns:

a parameter

builder

public static Parameter.Builder builder(String name)

Initialize a builder for a parameter with the specified name.

Parameters:

name - the name of the parameter

Returns:

a builder to further configure the parameter

getName

public String getName()

Return the name of the parameter.

Returns:

the name

getType

public String getType()

Return the typ of the parameter.

Returns:

the type

annotations

public AnnotationContainer annotations()

Description copied from interface: Annotatable

Return the AnnotationContainer to use to configure the annotations of this element.

Specified by:

annotations in interface Annotatable

Returns:

the annotation container