Package org.springframework.data.redis.connection

Class RedisGeoCommands.GeoSearchStoreCommandArgs

java.lang.Object

org.springframework.data.redis.connection.RedisGeoCommands.GeoSearchStoreCommandArgs

All Implemented Interfaces:

Cloneable, RedisGeoCommands.GeoCommandArgs

Enclosing interface:

RedisGeoCommands

public static class RedisGeoCommands.GeoSearchStoreCommandArgs
extends Object
implements RedisGeoCommands.GeoCommandArgs, Cloneable

Additional arguments (like count/sort/...) to be used with RedisGeoCommands.

Since:

2.6

Author:

Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisGeoCommands.GeoCommandArgs

RedisGeoCommands.GeoCommandArgs.GeoCommandFlag

Method Summary

Modifier and Type	Method	Description
protected RedisGeoCommands.GeoSearchStoreCommandArgs	clone()
Set<RedisGeoCommands.GeoCommandArgs.GeoCommandFlag>	getFlags()
Long	getLimit()
Sort.Direction	getSortDirection()
boolean	hasAnyLimit()
boolean	isStoreDistance()
RedisGeoCommands.GeoSearchStoreCommandArgs	limit(long count)	Limit the results to the first N matching items.
RedisGeoCommands.GeoSearchStoreCommandArgs	limit(long count, boolean any)	Limit the results to the first N matching items.
static RedisGeoCommands.GeoSearchStoreCommandArgs	newGeoSearchStoreArgs()	Create new RedisGeoCommands.GeoSearchStoreCommandArgs.
RedisGeoCommands.GeoSearchStoreCommandArgs	sort(Sort.Direction direction)	Apply a sort direction.
RedisGeoCommands.GeoSearchStoreCommandArgs	sortAscending()	Sort returned items from the nearest to the furthest, relative to the center.
RedisGeoCommands.GeoSearchStoreCommandArgs	sortDescending()	Sort returned items from the furthest to the nearest, relative to the center.
RedisGeoCommands.GeoSearchStoreCommandArgs	storeDistance()	Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.STOREDIST flag to also store the distance of the returned items from the specified center.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.redis.connection.RedisGeoCommands.GeoCommandArgs

hasFlags, hasLimit, hasSortDirection

Method Details

newGeoSearchStoreArgs

public static RedisGeoCommands.GeoSearchStoreCommandArgs newGeoSearchStoreArgs()

Create new RedisGeoCommands.GeoSearchStoreCommandArgs.

Returns:

never null.

storeDistance

public RedisGeoCommands.GeoSearchStoreCommandArgs storeDistance()

Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.STOREDIST flag to also store the distance of the returned items from the specified center.

Returns:

never null.

sort

public RedisGeoCommands.GeoSearchStoreCommandArgs sort(Sort.Direction direction)

Apply a sort direction.

Returns:

never null.

sortAscending

public RedisGeoCommands.GeoSearchStoreCommandArgs sortAscending()

Sort returned items from the nearest to the furthest, relative to the center.

Returns:

never null.

sortDescending

public RedisGeoCommands.GeoSearchStoreCommandArgs sortDescending()

Sort returned items from the furthest to the nearest, relative to the center.

Returns:

never null.

limit

public RedisGeoCommands.GeoSearchStoreCommandArgs limit(long count)

Limit the results to the first N matching items.

Parameters:

count -

Returns:

never null.

limit

public RedisGeoCommands.GeoSearchStoreCommandArgs limit(long count,
 boolean any)

Limit the results to the first N matching items.

Parameters:

count -

any -

Returns:

never null.

getFlags

public Set<RedisGeoCommands.GeoCommandArgs.GeoCommandFlag> getFlags()

Specified by:

getFlags in interface RedisGeoCommands.GeoCommandArgs

Returns:

never null.

getLimit

@Nullable
public Long getLimit()

Specified by:

getLimit in interface RedisGeoCommands.GeoCommandArgs

Returns:

can be null.

getSortDirection

@Nullable
public Sort.Direction getSortDirection()

Specified by:

getSortDirection in interface RedisGeoCommands.GeoCommandArgs

Returns:

can be null.

isStoreDistance

public boolean isStoreDistance()

hasAnyLimit

public boolean hasAnyLimit()

clone

protected RedisGeoCommands.GeoSearchStoreCommandArgs clone()

Overrides:

clone in class Object