Package org.springframework.data.repository.query

Interface ParameterAccessor

All Superinterfaces:
Iterable<Object>
All Known Implementing Classes:
ParametersParameterAccessor
public interface ParameterAccessor extends Iterable<Object>
Interface to access method parameters. Allows dedicated access to parameters of special types
Author:
Oliver Gierke, Mark Paluch

  • Method Details

    • getVector

      default @Nullable Vector getVector()
      Returns:
      the Vector of the parameters, if available; null otherwise.
      Since:
      4.0

    • getScore

      default @Nullable Score getScore()
      Returns:
      the Score of the parameters, if available; null otherwise.
      Since:
      4.0

    • getScoreRange

      default @Nullable Range<Score> getScoreRange()
      Returns:
      the Range of Score of the parameters, if available; null otherwise.
      Since:
      4.0

    • getScrollPosition

      @Nullable ScrollPosition getScrollPosition()
      Returns:
      the ScrollPosition of the parameters, if available; null otherwise.

    • getPageable

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

    • getSort

      Sort getSort()
      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

      default Limit getLimit()
      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.
      Since:
      3.2

    • findDynamicProjection

      @Nullable Class<?> findDynamicProjection()
      Returns:
      the dynamic projection type to be used when executing the query or null if none is defined.
      Since:
      2.2

    • getBindableValue

      @Nullable Object getBindableValue(int index)
      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.
      Parameters:
      index -
      Returns:
      the bindable value with the given index

    • hasBindableNullValue

      boolean hasBindableNullValue()
      Returns whether one of the bindable parameter values is null.
      Returns:
      true if one of the bindable parameter values is null.

    • iterator

      Iterator<Object> iterator()
      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>
      Returns:
      iterator over all bindable parameters.