Class GeoRadiusStoreArgs<K>

  • All Implemented Interfaces:
    CompositeArgument

    public class GeoRadiusStoreArgs<K>
    extends Object
    implements CompositeArgument
    Argument list builder for the Redis GEORADIUS command to store GEORADIUS results or GEORADIUS distances in a sorted set.

    GeoRadiusStoreArgs is a mutable object and instances should be used only once to avoid shared mutable state.

    Author:
    Mark Paluch
    • Constructor Detail

      • GeoRadiusStoreArgs

        public GeoRadiusStoreArgs()
    • Method Detail

      • withStoreDist

        public GeoRadiusStoreArgs withStoreDist​(K storeKey)
        Store the resulting members with their distance in the sorted set storeKey. Cannot be used together with withStore(Object).
        Parameters:
        storeKey - the destination key.
        Returns:
        this GeoRadiusStoreArgs.
      • getStoreKey

        public K getStoreKey()
        Returns:
        the key for storing results
      • getStoreDistKey

        public K getStoreDistKey()
        Returns:
        the key for storing distance results
      • build

        public <K,​V> void build​(CommandArgs<K,​V> args)
        Description copied from interface: CompositeArgument
        Build command arguments and contribute arguments to 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.

        Specified by:
        build in interface CompositeArgument
        Type Parameters:
        K - Key type.
        V - Value type.
        Parameters:
        args - the command arguments, must not be null.