Class DefaultSortParameters

java.lang.Object

org.springframework.data.redis.connection.DefaultSortParameters

All Implemented Interfaces:

SortParameters

public class DefaultSortParameters
extends Object
implements SortParameters

Default implementation for SortParameters.

Author:

Costin Leau

Nested Class Summary

Nested classes/interfaces inherited from interface SortParameters

SortParameters.Order, SortParameters.Range

Constructor Summary

Constructors

Constructor	Description
DefaultSortParameters()	Constructs a new DefaultSortParameters instance.
DefaultSortParameters(byte @Nullable [] byPattern, @Nullable SortParameters.Range limit, byte @Nullable [][] getPattern, @Nullable SortParameters.Order order, @Nullable Boolean alphabetic)	Constructs a new DefaultSortParameters instance.
DefaultSortParameters(@Nullable SortParameters.Range limit, @Nullable SortParameters.Order order, @Nullable Boolean alphabetic)	Constructs a new DefaultSortParameters instance.

Method Summary

Modifier and Type	Method	Description
void	addGetPattern(byte @Nullable [] gPattern)
DefaultSortParameters	alpha()
DefaultSortParameters	asc()
DefaultSortParameters	by(byte[] pattern)
DefaultSortParameters	desc()
DefaultSortParameters	get(byte[] pattern)
byte @Nullable []	getByPattern()	Returns the pattern (if set) for sorting by external keys (BY).
byte[][]	getGetPattern()	Returns the pattern (if set) for retrieving external keys (GET).
@Nullable SortParameters.Range	getLimit()	Returns the sorting limit (range or pagination).
@Nullable SortParameters.Order	getOrder()	Returns the sorting order.
@Nullable Boolean	isAlphabetic()	Indicates if the sorting is numeric (default) or alphabetical (lexicographical).
DefaultSortParameters	limit(long start, long count)
DefaultSortParameters	numeric()
DefaultSortParameters	order(SortParameters.Order order)
void	setAlphabetic(Boolean alphabetic)
void	setByPattern(byte[] byPattern)
void	setGetPattern(byte @Nullable [][] gPattern)
void	setLimit(SortParameters.Range limit)
void	setOrder(SortParameters.Order order)

Methods inherited from class Object

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

Constructor Details

DefaultSortParameters

public DefaultSortParameters()

Constructs a new DefaultSortParameters instance.

DefaultSortParameters

public DefaultSortParameters(@Nullable SortParameters.Range limit,
 @Nullable SortParameters.Order order,
 @Nullable Boolean alphabetic)

Constructs a new DefaultSortParameters instance.

Parameters:

limit -

order -

alphabetic -

DefaultSortParameters

public DefaultSortParameters(byte @Nullable [] byPattern,
 @Nullable SortParameters.Range limit,
 byte @Nullable [][] getPattern,
 @Nullable SortParameters.Order order,
 @Nullable Boolean alphabetic)

Constructs a new DefaultSortParameters instance.

Parameters:

byPattern -

limit -

getPattern -

order -

alphabetic -

Method Details

getByPattern

public byte @Nullable [] getByPattern()

Description copied from interface: SortParameters

Returns the pattern (if set) for sorting by external keys (BY). Can be null if nothing is specified.

Specified by:

getByPattern in interface SortParameters

Returns:

BY pattern. null if not set.

setByPattern

public void setByPattern(byte[] byPattern)

getLimit

public @Nullable SortParameters.Range getLimit()

Description copied from interface: SortParameters

Returns the sorting limit (range or pagination). Can be null if nothing is specified.

Specified by:

getLimit in interface SortParameters

Returns:

sorting limit/range. null if not set.

setLimit

public void setLimit(SortParameters.Range limit)

getGetPattern

public byte[][] getGetPattern()

Description copied from interface: SortParameters

Returns the pattern (if set) for retrieving external keys (GET). Can be null if nothing is specified.

Specified by:

getGetPattern in interface SortParameters

Returns:

GET pattern. null if not set.

addGetPattern

public void addGetPattern(byte @Nullable [] gPattern)

setGetPattern

public void setGetPattern(byte @Nullable [][] gPattern)

getOrder

public @Nullable SortParameters.Order getOrder()

Description copied from interface: SortParameters

Returns the sorting order. Can be null if nothing is specified.

Specified by:

getOrder in interface SortParameters

Returns:

sorting order. null if not set.

setOrder

public void setOrder(SortParameters.Order order)

isAlphabetic

public @Nullable Boolean isAlphabetic()

Description copied from interface: SortParameters

Indicates if the sorting is numeric (default) or alphabetical (lexicographical). Can be null if nothing is specified.

Specified by:

isAlphabetic in interface SortParameters

Returns:

the type of sorting. null if not set.

setAlphabetic

public void setAlphabetic(Boolean alphabetic)

order

public DefaultSortParameters order(SortParameters.Order order)

alpha

public DefaultSortParameters alpha()

asc

public DefaultSortParameters asc()

desc

public DefaultSortParameters desc()

numeric

public DefaultSortParameters numeric()

get

public DefaultSortParameters get(byte[] pattern)

by

public DefaultSortParameters by(byte[] pattern)

limit

public DefaultSortParameters limit(long start,
 long count)