public class GeoArgs extends Object implements CompositeArgument
GeoArgs
is a mutable object and instances should be used only once to avoid shared mutable state.Modifier and Type | Class and Description |
---|---|
static class |
GeoArgs.Builder
Builder entry points for
GeoArgs . |
static class |
GeoArgs.Sort
Sort order.
|
static class |
GeoArgs.Unit
Supported geo unit.
|
Constructor and Description |
---|
GeoArgs() |
Modifier and Type | Method and Description |
---|---|
GeoArgs |
asc()
Sort results ascending.
|
<K,V> void |
build(CommandArgs<K,V> args)
Build command arguments and contribute arguments to
CommandArgs . |
GeoArgs |
desc()
Sort results descending.
|
boolean |
isWithCoordinates() |
boolean |
isWithDistance() |
boolean |
isWithHash() |
GeoArgs |
sort(GeoArgs.Sort sort)
Sort results.
|
GeoArgs |
withCoordinates()
Request coordinates for results.
|
GeoArgs |
withCount(long count)
Limit results to
count entries. |
GeoArgs |
withDistance()
Request distance for results.
|
GeoArgs |
withHash()
Request geohash for results.
|
public GeoArgs withCoordinates()
this
GeoArgs
.public GeoArgs withCount(long count)
count
entries.count
- number greater 0.this
GeoArgs
.public boolean isWithDistance()
public boolean isWithCoordinates()
public boolean isWithHash()
public GeoArgs asc()
this
public GeoArgs desc()
this
public GeoArgs sort(GeoArgs.Sort sort)
sort
- sort order, must not be nullthis
public <K,V> void build(CommandArgs<K,V> args)
CompositeArgument
CommandArgs
.
Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.
build
in interface CompositeArgument
K
- Key type.V
- Value type.args
- the command arguments, must not be null.Copyright © 2019 lettuce.io. All rights reserved.