Class ParametersParameterAccessor

java.lang.Object

org.springframework.data.repository.query.ParametersParameterAccessor

All Implemented Interfaces:

Iterable<Object>, ParameterAccessor

public class ParametersParameterAccessor
extends Object
implements ParameterAccessor

ParameterAccessor implementation using a Parameters instance to find special parameters.

Author:

Oliver Gierke, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
ParametersParameterAccessor(Parameters<?,?> parameters, @Nullable Object[] values)	Creates a new ParametersParameterAccessor.

Method Summary

Modifier and Type	Method	Description
@Nullable Class<?>	findDynamicProjection()	Returns the dynamic projection type if available, null otherwise.
@Nullable Object	getBindableValue(int index)	Returns the bindable value with the given index.
Limit	getLimit()
Pageable	getPageable()
Parameters<?,?>	getParameters()	Returns the Parameters instance backing the accessor.
@Nullable Score	getScore()
@Nullable Range<Score>	getScoreRange()
@Nullable ScrollPosition	getScrollPosition()
Sort	getSort()
protected <T> @Nullable T	getValue(int index)	Returns the value with the given index.
protected @Nullable Object[]	getValues()	Returns the potentially unwrapped values.
@Nullable Vector	getVector()
boolean	hasBindableNullValue()	Returns whether one of the bindable parameter values is null.
Iterator<Object>	iterator()	Returns an iterator over all bindable parameters.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

ParametersParameterAccessor

public ParametersParameterAccessor(Parameters<?,?> parameters,
 @Nullable Object[] values)

Creates a new ParametersParameterAccessor.

Parameters:

parameters - must not be null.

values - must not be null.

Method Details

getParameters

public Parameters<?,?> getParameters()

Returns the Parameters instance backing the accessor.

Returns:

the parameters will never be null.

getValues

protected @Nullable Object[] getValues()

Returns the potentially unwrapped values.

Returns:

getVector

public @Nullable Vector getVector()

Specified by:

getVector in interface ParameterAccessor

Returns:

the Vector of the parameters, if available; null otherwise.

getScore

public @Nullable Score getScore()

Specified by:

getScore in interface ParameterAccessor

Returns:

the Score of the parameters, if available; null otherwise.

getScoreRange

public @Nullable Range<Score> getScoreRange()

Specified by:

getScoreRange in interface ParameterAccessor

Returns:

the Range of Score of the parameters, if available; null otherwise.

getScrollPosition

public @Nullable ScrollPosition getScrollPosition()

Specified by:

getScrollPosition in interface ParameterAccessor

Returns:

the ScrollPosition of the parameters, if available; null otherwise.

getPageable

public Pageable getPageable()

Specified by:

getPageable in interface ParameterAccessor

Returns:

the Pageable of the parameters, if available; Pageable.unpaged() otherwise.

getSort

public Sort getSort()

Specified by:

getSort in interface ParameterAccessor

Returns:

the sort instance to be used for query creation. Will use a Sort parameter if available or the Sort contained in a Pageable if available. Sort.unsorted() if no Sort can be found.

getLimit

public Limit getLimit()

Specified by:

getLimit in interface ParameterAccessor

Returns:

the Limit instance to be used for query creation. If no Parameter assignable to Limit can be found Limit will be created out of Pageable.getPageSize() if present.

findDynamicProjection

public @Nullable Class<?> findDynamicProjection()

Returns the dynamic projection type if available, null otherwise.

Specified by:

findDynamicProjection in interface ParameterAccessor

Returns:

getValue

protected <T> @Nullable T getValue(int index)

Returns the value with the given index.

Parameters:

index -

Returns:

getBindableValue

public @Nullable Object getBindableValue(int index)

Description copied from interface: ParameterAccessor

Returns the bindable value with the given index. Bindable means, that Pageable and Sort values are skipped without noticed in the index. For a method signature taking String, Pageable , String, #getBindableParameter(1) would return the second String value.

Specified by:

getBindableValue in interface ParameterAccessor

Parameters:

index -

Returns:

the bindable value with the given index

hasBindableNullValue

public boolean hasBindableNullValue()

Description copied from interface: ParameterAccessor

Returns whether one of the bindable parameter values is null.

Specified by:

hasBindableNullValue in interface ParameterAccessor

Returns:

true if one of the bindable parameter values is null.

iterator

public Iterator<Object> iterator()

Description copied from interface: ParameterAccessor

Returns an iterator over all bindable parameters. This means parameters implementing Pageable or Sort will not be included in this Iterator.

Specified by:

iterator in interface Iterable<Object>

Specified by:

iterator in interface ParameterAccessor

Returns:

iterator over all bindable parameters.