Package org.springframework.data.repository.query

Class Parameter

java.lang.Object

org.springframework.data.repository.query.Parameter

public class Parameter
extends Object

Class to abstract a single parameter of a query method. It is held in the context of a Parameters instance.

Author:

Oliver Gierke, Mark Paluch, Jens Schauder, Greg Turnquist, Johannes Englmeier

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Parameter(MethodParameter parameter)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.1, use Parameter(MethodParameter, TypeInformation) instead.
protected	Parameter(MethodParameter parameter, TypeInformation<?> domainType)	Creates a new Parameter for the given MethodParameter and domain TypeInformation.

Method Summary

Modifier and Type	Method	Description
int	getIndex()	Returns the position index the parameter is bound to in the context of its surrounding Parameters.
Optional<String>	getName()	Returns the name of the parameter (through Param annotation or method parameter naming).
String	getPlaceholder()	Returns the placeholder to be used for the parameter.
String	getRequiredName()	Returns the required name of the parameter (through Param annotation or method parameter naming) or throws IllegalStateException if the parameter has no name.
Class<?>	getType()	Returns the type of the Parameter.
boolean	isBindable()	Returns whether the Parameter is to be bound to a query.
boolean	isDynamicProjectionParameter()	Returns whether the current Parameter is the one used for dynamic projections.
boolean	isExplicitlyNamed()	Returns whether the parameter is named explicitly, i.e. annotated with Param.
boolean	isNamedParameter()	Returns whether the parameter is annotated with Param or has a method parameter name.
boolean	isSpecialParameter()	Returns whether the parameter is a special parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Parameter

@Deprecated(since="3.1",
            forRemoval=true)
protected Parameter(MethodParameter parameter)

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

since 3.1, use Parameter(MethodParameter, TypeInformation) instead.

Creates a new Parameter for the given MethodParameter.

Parameters:

parameter - must not be null.

Parameter

protected Parameter(MethodParameter parameter,
 TypeInformation<?> domainType)

Creates a new Parameter for the given MethodParameter and domain TypeInformation.

Parameters:

parameter - must not be null.

domainType - must not be null.

Since:

3.0.2

Method Details

isSpecialParameter

public boolean isSpecialParameter()

Returns whether the parameter is a special parameter.

Returns:

See Also:

• TYPES

isBindable

public boolean isBindable()

Returns whether the Parameter is to be bound to a query.

Returns:

isDynamicProjectionParameter

public boolean isDynamicProjectionParameter()

Returns whether the current Parameter is the one used for dynamic projections.

Returns:

getPlaceholder

public String getPlaceholder()

Returns the placeholder to be used for the parameter. Can either be a named one or positional.

Returns:

getIndex

public int getIndex()

Returns the position index the parameter is bound to in the context of its surrounding Parameters.

Returns:

isNamedParameter

public boolean isNamedParameter()

Returns whether the parameter is annotated with Param or has a method parameter name.

Returns:

See Also:

• Param
• ParameterNameDiscoverer

isExplicitlyNamed

public boolean isExplicitlyNamed()

Returns whether the parameter is named explicitly, i.e. annotated with Param.

Returns:

Since:

1.11

See Also:

• Param

getName

public Optional<String> getName()

Returns the name of the parameter (through Param annotation or method parameter naming).

Returns:

the optional name of the parameter.

See Also:

• Param
• ParameterNameDiscoverer

getRequiredName

public String getRequiredName()

Returns the required name of the parameter (through Param annotation or method parameter naming) or throws IllegalStateException if the parameter has no name.

Returns:

the required parameter name.

Throws:

IllegalStateException - if the parameter has no name.

Since:

3.4

See Also:

• Param
• ParameterNameDiscoverer

getType

public Class<?> getType()

Returns the type of the Parameter.

Returns:

the type

toString

public String toString()

Overrides:

toString in class Object