Class RedisGeoCommands.GeoRadiusCommandArgs
java.lang.Object
org.springframework.data.redis.connection.RedisGeoCommands.GeoSearchCommandArgs
org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs
- All Implemented Interfaces:
Cloneable
,RedisGeoCommands.GeoCommandArgs
- Enclosing interface:
- RedisGeoCommands
public static class RedisGeoCommands.GeoRadiusCommandArgs
extends RedisGeoCommands.GeoSearchCommandArgs
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/interfaces inherited from interface org.springframework.data.redis.connection.RedisGeoCommands.GeoCommandArgs
RedisGeoCommands.GeoCommandArgs.GeoCommandFlag
-
Field Summary
Fields inherited from class org.springframework.data.redis.connection.RedisGeoCommands.GeoSearchCommandArgs
flags, limit, sortDirection
-
Method Summary
Modifier and TypeMethodDescriptionprotected RedisGeoCommands.GeoRadiusCommandArgs
clone()
getFlags()
Sets theRedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD
flag to also return the longitude, latitude coordinates of the matching items.Sets theRedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHDIST
flag to also return the distance of the returned items from the specified center.limit
(long count) Limit the results to the first N matching items.Create newRedisGeoCommands.GeoRadiusCommandArgs
.sort
(org.springframework.data.domain.Sort.Direction direction) Apply a sort direction.Sort returned items from the nearest to the furthest, relative to the center.Sort returned items from the furthest to the nearest, relative to the center.Methods inherited from class org.springframework.data.redis.connection.RedisGeoCommands.GeoSearchCommandArgs
getLimit, getSortDirection, hasAnyLimit, limit, newGeoSearchArgs
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
-
newGeoRadiusArgs
Create newRedisGeoCommands.GeoRadiusCommandArgs
.- Returns:
- never null.
-
includeCoordinates
Sets theRedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD
flag to also return the longitude, latitude coordinates of the matching items.- Overrides:
includeCoordinates
in classRedisGeoCommands.GeoSearchCommandArgs
- Returns:
-
includeDistance
Sets theRedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHDIST
flag to also return the distance of the returned items from the specified center.- Overrides:
includeDistance
in classRedisGeoCommands.GeoSearchCommandArgs
- Returns:
- never null.
-
sort
public RedisGeoCommands.GeoRadiusCommandArgs sort(org.springframework.data.domain.Sort.Direction direction) Apply a sort direction.- Overrides:
sort
in classRedisGeoCommands.GeoSearchCommandArgs
- Returns:
- never null.
- Since:
- 2.6
-
sortAscending
Sort returned items from the nearest to the furthest, relative to the center.- Overrides:
sortAscending
in classRedisGeoCommands.GeoSearchCommandArgs
- Returns:
- never null.
-
sortDescending
Sort returned items from the furthest to the nearest, relative to the center.- Overrides:
sortDescending
in classRedisGeoCommands.GeoSearchCommandArgs
- Returns:
- never null.
-
limit
Limit the results to the first N matching items.- Overrides:
limit
in classRedisGeoCommands.GeoSearchCommandArgs
- Parameters:
count
-- Returns:
- never null.
-
getFlags
- Specified by:
getFlags
in interfaceRedisGeoCommands.GeoCommandArgs
- Overrides:
getFlags
in classRedisGeoCommands.GeoSearchCommandArgs
- Returns:
- never null.
-
clone
- Overrides:
clone
in classRedisGeoCommands.GeoSearchCommandArgs
-