org.redisson.api.RMultimapCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redisson Show documentation

Redis Java client with features of In-Memory Data Grid

There is a newer version: 3.40.2

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * 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
 *
 *    http://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 org.redisson.api;

import java.util.concurrent.TimeUnit;

/**
 * Base Multimap interface. Allows to map multiple values per key and define expiration per key.
 *
 * @author Nikita Koksharov
 *
 * @param  key type
 * @param  value type
 */
public interface RMultimapCache extends RMultimap, RMultimapCacheAsync {

    /**
     * Set a timeout for key. After the timeout has expired,
     * the key and its values will automatically be deleted.
     * 
     * @param key - map key
     * @param timeToLive - timeout before key will be deleted
     * @param timeUnit - timeout time unit
     * @return true if key exists and the timeout was set and false if key not exists
     */
    boolean expireKey(K key, long timeToLive, TimeUnit timeUnit);
    
}