io.lettuce.core.HGetExArgs 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.internal.LettuceAssert;
import io.lettuce.core.protocol.CommandArgs;
import io.lettuce.core.protocol.CommandType;

import java.time.Duration;
import java.time.Instant;
import java.util.Date;

/**
 * Argument list builder for the Redis HGETEX command starting from Redis 8.0.
 * Static import the methods from {@link Builder} and chain the method calls: {@code ex(10).nx()}.
 * 
 * {@link HGetExArgs} is a mutable object and instances should be used only once to avoid shared mutable state.
 *
 * @author Ivo Gaydajiev
 * @since 6.6
 */
public class HGetExArgs implements CompositeArgument {

    private Long ex;

    private Long exAt;

    private Long px;

    private Long pxAt;

    private boolean persist = false;

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

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

        /**
         * Creates new {@link HGetExArgs} and enable {@literal EX}.
         *
         * @param timeout expire time in seconds.
         * @return new {@link HGetExArgs} with {@literal EX} enabled.
         * @see HGetExArgs#ex(long)
         * @since 6.6
         */
        public static HGetExArgs ex(Duration timeout) {
            return new HGetExArgs().ex(timeout);
        }

        /**
         * Creates new {@link HGetExArgs} and enable {@literal EXAT}.
         *
         * @param timestamp the timestamp type: posix time in seconds.
         * @return new {@link HGetExArgs} with {@literal EXAT} enabled.
         * @see HGetExArgs#exAt(Instant)
         * @since 6.6
         */
        public static HGetExArgs exAt(Instant timestamp) {
            return new HGetExArgs().exAt(timestamp);
        }

        /**
         * Creates new {@link HGetExArgs} and enable {@literal PX}.
         *
         * @param timeout expire time in milliseconds.
         * @return new {@link HGetExArgs} with {@literal PX} enabled.
         * @see HGetExArgs#px(long)
         * @since 6.6
         */
        public static HGetExArgs px(Duration timeout) {
            return new HGetExArgs().px(timeout);
        }

        /**
         * Creates new {@link HGetExArgs} and enable {@literal PXAT}.
         *
         * @param timestamp the timestamp type: posix time.
         * @return new {@link HGetExArgs} with {@literal PXAT} enabled.
         * @see HGetExArgs#pxAt(Instant)
         * @since 6.6
         */
        public static HGetExArgs pxAt(Instant timestamp) {
            return new HGetExArgs().pxAt(timestamp);
        }

        /**
         * Creates new {@link HGetExArgs} and enable {@literal PERSIST}.
         *
         * @return new {@link HGetExArgs} with {@literal PERSIST} enabled.
         * @see HGetExArgs#persist()
         */
        public static HGetExArgs persist() {
            return new HGetExArgs().persist();
        }

    }

    /**
     * Set the specified expire time, in seconds.
     *
     * @param timeout expire time in seconds.
     * @return {@code this} {@link HGetExArgs}.
     * @since 6.6
     */
    public HGetExArgs ex(Duration timeout) {

        LettuceAssert.notNull(timeout, "Timeout must not be null");

        this.ex = timeout.getSeconds();
        return this;
    }

    /**
     * Set the specified expire at time using a posix {@code timestamp}.
     *
     * @param timestamp the timestamp type: posix time in seconds.
     * @return {@code this} {@link HGetExArgs}.
     * @since 6.6
     */
    public HGetExArgs exAt(Instant timestamp) {

        LettuceAssert.notNull(timestamp, "Timestamp must not be null");
        this.exAt = timestamp.getEpochSecond();
        return this;
    }

    /**
     * Set the specified expire time, in milliseconds.
     *
     * @param timeout expire time in milliseconds.
     * @return {@code this} {@link HGetExArgs}.
     */
    public HGetExArgs px(Duration timeout) {

        LettuceAssert.notNull(timeout, "Timeout must not be null");

        this.px = timeout.toMillis();
        return this;
    }

    /**
     * Set the specified expire at time using a posix {@code timestamp}.
     *
     * @param timestamp the timestamp type: posix time in milliseconds.
     * @return {@code this} {@link HGetExArgs}.
     * @since 6.6
     */
    public HGetExArgs pxAt(Instant timestamp) {

        LettuceAssert.notNull(timestamp, "Timestamp must not be null");

        this.pxAt = timestamp.toEpochMilli();
        return this;
    }

    /**
     * Remove the time to live associated with the key.
     *
     * @return {@code this} {@link HGetExArgs}.
     */
    public HGetExArgs persist() {

        this.persist = true;
        return this;
    }

    @Override
    public  void build(CommandArgs args) {

        if (ex != null) {
            args.add("EX").add(ex);
        }

        if (exAt != null) {
            args.add("EXAT").add(exAt);
        }

        if (px != null) {
            args.add("PX").add(px);
        }

        if (pxAt != null) {
            args.add("PXAT").add(pxAt);
        }

        if (persist) {
            args.add(CommandType.PERSIST);
        }
    }

}