org.springframework.data.keyvalue.core.query

Class KeyValueQuery<T>

java.lang.Object

org.springframework.data.keyvalue.core.query.KeyValueQuery<T>

Type Parameters:

T - Criteria type

public class KeyValueQuery<T>
extends Object

Author:

Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor and Description
KeyValueQuery() Creates new instance of KeyValueQuery.
KeyValueQuery(Sort sort) Creates new instance of KeyValueQuery with given Sort.
KeyValueQuery(T criteria) Creates new instance of KeyValueQuery with given criteria.

Method Summary

Modifier and Type	Method and Description
T	getCriteria() Get the criteria object.
long	getOffset() Number of elements to skip.
int	getRows() Number of elements to read.
Sort	getSort() Get Sort.
KeyValueQuery<T>	limit(int rows)
KeyValueQuery<T>	orderBy(Sort sort) Add given Sort.
void	setOffset(long offset) Set the number of elements to skip.
void	setRows(int rows) Set the number of elements to read.
void	setSort(Sort sort) Set Sort to be applied.
KeyValueQuery<T>	skip(long offset)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueQuery

public KeyValueQuery()

Creates new instance of KeyValueQuery.

KeyValueQuery

public KeyValueQuery(@Nullable
                     T criteria)

Creates new instance of KeyValueQuery with given criteria.

Parameters:

criteria - can be null.

KeyValueQuery

public KeyValueQuery(Sort sort)

Creates new instance of KeyValueQuery with given Sort.

Parameters:

sort - must not be null.

Method Detail

getCriteria

@Nullable
public T getCriteria()

Get the criteria object.

Returns:

Since:

2.0

getSort

public Sort getSort()

Get Sort.

Returns:

getOffset

public long getOffset()

Number of elements to skip.

Returns:

negative value if not set.

getRows

public int getRows()

Number of elements to read.

Returns:

negative value if not set.

setOffset

public void setOffset(long offset)

Set the number of elements to skip.

Parameters:

offset - use negative value for none.

setRows

public void setRows(int rows)

Set the number of elements to read.

Parameters:

rows - use negative value for all.

setSort

public void setSort(Sort sort)

Set Sort to be applied.

Parameters:

sort -

orderBy

public KeyValueQuery<T> orderBy(Sort sort)

Add given Sort.

Parameters:

sort - must not be null.

Returns:

skip

public KeyValueQuery<T> skip(long offset)

Parameters:

offset -

Returns:

See Also:

setOffset(long)

limit

public KeyValueQuery<T> limit(int rows)

Parameters:

rows -

Returns:

See Also:

setRows(int)