io.lettuce.core.GeoRadiusStoreArgs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lettuce-core Show documentation
Advanced and thread-safe Java Redis client for synchronous, asynchronous, and reactive usage. Supports Cluster, Sentinel, Pipelining, Auto-Reconnect, Codecs and much more.
The newest version!
package io.lettuce.core;

import io.lettuce.core.GeoArgs.Sort;
import io.lettuce.core.internal.LettuceAssert;
import io.lettuce.core.protocol.CommandArgs;
import io.lettuce.core.protocol.CommandKeyword;

/**
 * Argument list builder for the Redis GEORADIUS command to store
 * {@literal GEORADIUS} results or {@literal GEORADIUS} distances in a sorted set.
 * 
 * {@link GeoRadiusStoreArgs} is a mutable object and instances should be used only once to avoid shared mutable state.
 *
 * @author Mark Paluch
 */
public class GeoRadiusStoreArgs implements CompositeArgument {

    private K storeKey;

    private K storeDistKey;

    private Long count;

    private Sort sort = Sort.none;

    /**
     * Builder entry points for {@link GeoRadiusStoreArgs}.
     */
    public static class Builder {

        /**
         * Utility constructor.
         */
        private Builder() {
        }

        /**
         * Creates new {@link GeoRadiusStoreArgs} with {@literal STORE} enabled.
         *
         * @param key must not be {@code null}.
         * @return new {@link GeoRadiusStoreArgs} with {@literal STORE} enabled.
         * @see GeoRadiusStoreArgs#withStore(Object)
         */
        public static  GeoRadiusStoreArgs store(K key) {
            return new GeoRadiusStoreArgs<>().withStore(key);
        }

        /**
         * Creates new {@link GeoRadiusStoreArgs} with {@literal STOREDIST} enabled.
         *
         * @param key must not be {@code null}.
         * @return new {@link GeoRadiusStoreArgs} with {@literal STOREDIST} enabled.
         * @see GeoRadiusStoreArgs#withStoreDist(Object)
         */
        public static  GeoRadiusStoreArgs withStoreDist(K key) {
            return new GeoRadiusStoreArgs<>().withStoreDist(key);
        }

        /**
         * Creates new {@link GeoRadiusStoreArgs} with {@literal COUNT} set.
         *
         * @param count number greater 0.
         * @return new {@link GeoRadiusStoreArgs} with {@literal COUNT} set.
         * @see GeoRadiusStoreArgs#withStoreDist(Object)
         */
        public static  GeoRadiusStoreArgs count(long count) {
            return new GeoRadiusStoreArgs<>().withCount(count);
        }

    }

    /**
     * Store the resulting members with their location in the new Geo set {@code storeKey}. Cannot be used together with
     * {@link #withStoreDist(Object)}.
     *
     * @param storeKey the destination key.
     * @return {@code this} {@link GeoRadiusStoreArgs}.
     */
    public GeoRadiusStoreArgs withStore(K storeKey) {

        LettuceAssert.notNull(storeKey, "StoreKey must not be null");

        this.storeKey = storeKey;
        return this;
    }

    /**
     * Store the resulting members with their distance in the sorted set {@code storeKey}. Cannot be used together with
     * {@link #withStore(Object)}.
     *
     * @param storeKey the destination key.
     * @return {@code this} {@link GeoRadiusStoreArgs}.
     */
    public GeoRadiusStoreArgs withStoreDist(K storeKey) {

        LettuceAssert.notNull(storeKey, "StoreKey must not be null");

        this.storeDistKey = storeKey;
        return this;
    }

    /**
     * Limit results to {@code count} entries.
     *
     * @param count number greater 0.
     * @return {@code this} {@link GeoRadiusStoreArgs}.
     */
    public GeoRadiusStoreArgs withCount(long count) {

        LettuceAssert.isTrue(count > 0, "Count must be greater 0");

        this.count = count;
        return this;
    }

    /**
     * Sort results ascending.
     *
     * @return {@code this} {@link GeoRadiusStoreArgs}.
     */
    public GeoRadiusStoreArgs asc() {
        return sort(Sort.asc);
    }

    /**
     * Sort results descending.
     *
     * @return {@code this} {@link GeoRadiusStoreArgs}.
     */
    public GeoRadiusStoreArgs desc() {
        return sort(Sort.desc);
    }

    /**
     * @return the key for storing results
     */
    public K getStoreKey() {
        return storeKey;
    }

    /**
     * @return the key for storing distance results
     */
    public K getStoreDistKey() {
        return storeDistKey;
    }

    /**
     * Sort results.
     *
     * @param sort sort order, must not be {@code null}
     * @return {@code this} {@link GeoRadiusStoreArgs}.
     */
    public GeoRadiusStoreArgs sort(Sort sort) {
        LettuceAssert.notNull(sort, "Sort must not be null");

        this.sort = sort;
        return this;
    }

    @SuppressWarnings("unchecked")
    public  void build(CommandArgs args) {

        if (sort != null && sort != Sort.none) {
            args.add(sort.name());
        }

        if (count != null) {
            args.add(CommandKeyword.COUNT).add(count);
        }

        if (storeKey != null) {
            args.add("STORE").addKey((K) storeKey);
        }

        if (storeDistKey != null) {
            args.add("STOREDIST").addKey((K) storeDistKey);
        }
    }

}