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

@NullMarked
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

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

Nested classes/interfaces inherited from interface RedisGeoCommands.GeoCommandArgs

RedisGeoCommands.GeoCommandArgs.GeoCommandFlag

Field Summary

Fields inherited from class RedisGeoCommands.GeoSearchCommandArgs

flags, limit, sortDirection

Method Summary

Modifier and Type	Method	Description
protected RedisGeoCommands.GeoRadiusCommandArgs	clone()
Set<RedisGeoCommands.GeoRadiusCommandArgs.Flag>	getFlags()
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	sort(Sort.Direction direction)	Apply a sort direction.
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 RedisGeoCommands.GeoSearchCommandArgs

getLimit, getSortDirection, hasAnyLimit, limit, newGeoSearchArgs

Methods inherited from class Object

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

Methods inherited from interface RedisGeoCommands.GeoCommandArgs

hasFlags, hasLimit, hasSortDirection

Method Details

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.

Overrides:

includeCoordinates in class RedisGeoCommands.GeoSearchCommandArgs

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.

Overrides:

includeDistance in class RedisGeoCommands.GeoSearchCommandArgs

Returns:

never null.

sort

public RedisGeoCommands.GeoRadiusCommandArgs sort(Sort.Direction direction)

Apply a sort direction.

Overrides:

sort in class RedisGeoCommands.GeoSearchCommandArgs

Returns:

never null.

Since:

2.6

sortAscending

public RedisGeoCommands.GeoRadiusCommandArgs sortAscending()

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

Overrides:

sortAscending in class RedisGeoCommands.GeoSearchCommandArgs

Returns:

never null.

sortDescending

public RedisGeoCommands.GeoRadiusCommandArgs sortDescending()

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

Overrides:

sortDescending in class RedisGeoCommands.GeoSearchCommandArgs

Returns:

never null.

limit

public RedisGeoCommands.GeoRadiusCommandArgs limit(long count)

Limit the results to the first N matching items.

Overrides:

limit in class RedisGeoCommands.GeoSearchCommandArgs

Parameters:

count -

Returns:

never null.

getFlags

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

Specified by:

getFlags in interface RedisGeoCommands.GeoCommandArgs

Overrides:

getFlags in class RedisGeoCommands.GeoSearchCommandArgs

Returns:

never null.

clone

protected RedisGeoCommands.GeoRadiusCommandArgs clone()

Overrides:

clone in class RedisGeoCommands.GeoSearchCommandArgs