io.lettuce.core.RestoreArgs 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!
/*
 * Copyright 2018-Present, Redis Ltd. and Contributors
 * All rights reserved.
 *
 * Licensed under the MIT License.
 *
 * This file contains contributions from third-party contributors
 * licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.lettuce.core;

import static io.lettuce.core.protocol.CommandKeyword.*;

import java.time.Duration;

import io.lettuce.core.internal.LettuceAssert;
import io.lettuce.core.protocol.CommandArgs;

/**
 * Argument list builder for the Redis RESTORE command. Static import the
 * methods from {@link RestoreArgs.Builder} and call the methods: {@code ttl(…)} .
 * 
 * {@link RestoreArgs} is a mutable object and instances should be used only once to avoid shared mutable state.
 *
 * @author Mark Paluch
 * @author dengliming
 * @since 5.1
 */
public class RestoreArgs implements CompositeArgument {

    long ttl;

    private boolean replace;

    private boolean absttl;

    private Long frequency;

    private Long idleTime;

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

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

        /**
         * Creates new {@link RestoreArgs} and set the TTL.
         *
         * @return new {@link RestoreArgs} with min idle time set.
         * @see RestoreArgs#ttl(long)
         */
        public static RestoreArgs ttl(long milliseconds) {
            return new RestoreArgs().ttl(milliseconds);
        }

        /**
         * Creates new {@link RestoreArgs} and set the minimum idle time.
         *
         * @return new {@link RestoreArgs} with min idle time set.
         * @see RestoreArgs#ttl(Duration)
         */
        public static RestoreArgs ttl(Duration ttl) {

            LettuceAssert.notNull(ttl, "Time to live must not be null");

            return ttl(ttl.toMillis());
        }

    }

    /**
     * Set TTL in {@code milliseconds} after restoring the key.
     *
     * @param milliseconds time to live.
     * @return {@code this}.
     */
    public RestoreArgs ttl(long milliseconds) {

        this.ttl = milliseconds;
        return this;
    }

    /**
     * Set TTL in {@code milliseconds} after restoring the key.
     *
     * @param ttl time to live.
     * @return {@code this}.
     */
    public RestoreArgs ttl(Duration ttl) {

        LettuceAssert.notNull(ttl, "Time to live must not be null");

        return ttl(ttl.toMillis());
    }

    /**
     * Replaces existing keys if the target key already exists.
     *
     * @return {@code this}.
     */
    public RestoreArgs replace() {
        return replace(true);
    }

    /**
     * Replaces existing keys if the target key already exists.
     *
     * @param replace {@code true} to enable replacing of existing keys.
     * @return {@code this}.
     */
    public RestoreArgs replace(boolean replace) {

        this.replace = replace;
        return this;
    }

    /**
     * TTL will represent an absolute Unix timestamp (in milliseconds) in which the key will expire.
     *
     * @return {@code this}.
     * @since 6.1
     */
    public RestoreArgs absttl() {
        return absttl(true);
    }

    /**
     * TTL will represent an absolute Unix timestamp (in milliseconds) in which the key will expire.
     *
     * @param absttl {@code true} to apply absolute TTL instead of a relative remaining TTL.
     * @return {@code this}.
     * @since 6.1
     */
    public RestoreArgs absttl(boolean absttl) {

        this.absttl = absttl;
        return this;
    }

    /**
     * Set the number of seconds since the object stored at the specified key is idle (not requested by read or write
     * operations).
     *
     * @param idleTime the idle time when using a LRU eviction policy.
     * @return {@code this}.
     * @since 6.1
     */
    public RestoreArgs idleTime(long idleTime) {

        this.idleTime = idleTime;
        return this;
    }

    /**
     * Set the logarithmic access frequency counter of the object stored at the specified key.
     *
     * @param frequency the access frequency when using a LFU eviction policy.
     * @return {@code this}.
     * @since 6.1
     */
    public RestoreArgs frequency(long frequency) {

        this.frequency = frequency;
        return this;
    }

    @Override
    public  void build(CommandArgs args) {

        if (replace) {
            args.add(REPLACE);
        }

        if (absttl) {
            args.add(ABSTTL);
        }

        if (idleTime != null) {
            args.add(IDLETIME).add(idleTime);
        }

        if (frequency != null) {
            args.add(FREQ).add(frequency);
        }
    }

}