Parameter (Spring Data Core 2.1.3.RELEASE API)

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected Parameter(MethodParameter parameter)
Creates a new Parameter for the given MethodParameter.

Constructors
Modifier	Constructor and Description
`protected`	`Parameter(MethodParameter parameter)` Creates a new `Parameter` for the given `MethodParameter`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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).
`String`	`getPlaceholder()` Returns the placeholder to be used for the parameter.
`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`.
`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 Detail
  - Parameter
```
protected Parameter(MethodParameter parameter)
```
    Creates a new Parameter for the given MethodParameter.
    
    Parameters:
    
    parameter - must not be null.
- Method Detail
  - 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.
    
    Returns:
  - getName
```
public Optional<String> getName()
```
    Returns the name of the parameter (through Param annotation).
    
    Returns:
  - getType
```
public Class<?> getType()
```
    Returns the type of the Parameter.
    
    Returns:
    
    the type
  - isExplicitlyNamed
```
public boolean isExplicitlyNamed()
```
    Returns whether the parameter is named explicitly, i.e. annotated with Param.
    
    Returns:
    
    Since:
    
    1.11
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Parameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Parameter

Method Detail

isSpecialParameter

isBindable

isDynamicProjectionParameter

getPlaceholder

getIndex

isNamedParameter

getName

getType

isExplicitlyNamed

toString