org.springframework.data.redis.connection

Class RedisGeoCommands.GeoRadiusCommandArgs

java.lang.Object

org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs

All Implemented Interfaces:

Cloneable

Enclosing interface:

RedisGeoCommands

public static class RedisGeoCommands.GeoRadiusCommandArgs
extends Object
implements Cloneable

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

Since:

1.8

Author:

Ninad Divadkar, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedisGeoCommands.GeoRadiusCommandArgs.Flag

Method Summary

Modifier and Type	Method and Description
protected RedisGeoCommands.GeoRadiusCommandArgs	clone()
Set<RedisGeoCommands.GeoRadiusCommandArgs.Flag>	getFlags()
Long	getLimit()
Sort.Direction	getSortDirection()
boolean	hasFlags()
boolean	hasLimit()
boolean	hasSortDirection()
RedisGeoCommands.GeoRadiusCommandArgs	includeCoordinates() Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD flag to also return the longitude, latitude coordinates of the matching items.
RedisGeoCommands.GeoRadiusCommandArgs	includeDistance() Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHDIST flag to also return the distance of the returned items from the specified center.
RedisGeoCommands.GeoRadiusCommandArgs	limit(long count) Limit the results to the first N matching items.
static RedisGeoCommands.GeoRadiusCommandArgs	newGeoRadiusArgs() Create new RedisGeoCommands.GeoRadiusCommandArgs.
RedisGeoCommands.GeoRadiusCommandArgs	sortAscending() Sort returned items from the nearest to the furthest, relative to the center.
RedisGeoCommands.GeoRadiusCommandArgs	sortDescending() Sort returned items from the furthest to the nearest, relative to the center.

Methods inherited from class java.lang.Object

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

Method Detail

newGeoRadiusArgs

public static RedisGeoCommands.GeoRadiusCommandArgs newGeoRadiusArgs()

Create new RedisGeoCommands.GeoRadiusCommandArgs.

Returns:

never null.

includeCoordinates

public RedisGeoCommands.GeoRadiusCommandArgs includeCoordinates()

Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD flag to also return the longitude, latitude coordinates of the matching items.

Returns:

includeDistance

public RedisGeoCommands.GeoRadiusCommandArgs includeDistance()

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

Returns:

never null.

sortAscending

public RedisGeoCommands.GeoRadiusCommandArgs sortAscending()

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

Returns:

never null.

sortDescending

public RedisGeoCommands.GeoRadiusCommandArgs sortDescending()

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

Returns:

never null.

limit

public RedisGeoCommands.GeoRadiusCommandArgs limit(long count)

Limit the results to the first N matching items.

Parameters:

count -

Returns:

never null.

getFlags

public Set<RedisGeoCommands.GeoRadiusCommandArgs.Flag> getFlags()

Returns:

never null.

getLimit

@Nullable
public Long getLimit()

Returns:

can be null.

getSortDirection

@Nullable
public Sort.Direction getSortDirection()

Returns:

can be null.

hasFlags

public boolean hasFlags()

hasSortDirection

public boolean hasSortDirection()

hasLimit

public boolean hasLimit()

clone

protected RedisGeoCommands.GeoRadiusCommandArgs clone()

Overrides:

clone in class Object