com.lambdaworks.redis

Class GeoRadiusStoreArgs<K>

java.lang.Object

com.lambdaworks.redis.GeoRadiusStoreArgs<K>

public class GeoRadiusStoreArgs<K>
extends Object

Argument list builder for the Redis GEORADIUS command to store GEORADIUS results or GEORADIUS distances in a sorted set.

GeoRadiusStoreArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoRadiusStoreArgs.Builder Builder entry points for GeoRadiusStoreArgs.

Constructor Summary

Constructors

Constructor and Description
GeoRadiusStoreArgs()

Method Summary

Modifier and Type	Method and Description
GeoRadiusStoreArgs	asc() Sort results ascending.
<V> void	build(CommandArgs<K,V> args)
GeoRadiusStoreArgs	desc() Sort results descending.
K	getStoreDistKey()
K	getStoreKey()
GeoRadiusStoreArgs	sort(GeoArgs.Sort sort) Sort results.
GeoRadiusStoreArgs	withCount(long count) Limit results to count entries.
GeoRadiusStoreArgs	withStore(K storeKey) Store the resulting members with their location in the new Geo set storeKey.
GeoRadiusStoreArgs	withStoreDist(K storeKey) Store the resulting members with their distance in the sorted set storeKey.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoRadiusStoreArgs

public GeoRadiusStoreArgs()

Method Detail

withStore

public GeoRadiusStoreArgs withStore(K storeKey)

Store the resulting members with their location in the new Geo set storeKey. Cannot be used together with withStoreDist(Object).

Parameters:

storeKey - the destination key.

Returns:

this GeoRadiusStoreArgs.

withStoreDist

public GeoRadiusStoreArgs withStoreDist(K storeKey)

Store the resulting members with their distance in the sorted set storeKey. Cannot be used together with withStore(Object).

Parameters:

storeKey - the destination key.

Returns:

this GeoRadiusStoreArgs.

withCount

public GeoRadiusStoreArgs withCount(long count)

Limit results to count entries.

Parameters:

count - number greater 0.

Returns:

this GeoRadiusStoreArgs.

asc

public GeoRadiusStoreArgs asc()

Sort results ascending.

Returns:

this GeoRadiusStoreArgs.

desc

public GeoRadiusStoreArgs desc()

Sort results descending.

Returns:

this GeoRadiusStoreArgs.

getStoreKey

public K getStoreKey()

Returns:

the key for storing results

getStoreDistKey

public K getStoreDistKey()

Returns:

the key for storing distance results

sort

public GeoRadiusStoreArgs sort(GeoArgs.Sort sort)

Sort results.

Parameters:

sort - sort order, must not be null

Returns:

this GeoRadiusStoreArgs.

build

public <V> void build(CommandArgs<K,V> args)