org.springframework.data.redis.support.collections.RedisMap Maven / Gradle / Ivy
/*
* Copyright 2011-2022 the original author or authors.
*
* 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 org.springframework.data.redis.support.collections;
import java.util.Iterator;
import java.util.Map;
import java.util.concurrent.ConcurrentMap;
import org.springframework.lang.Nullable;
/**
* Map view of a Redis hash.
*
* @author Costin Leau
* @author Christoph Strobl
*/
public interface RedisMap extends RedisStore, ConcurrentMap {
/**
* Increment {@code value} of the hash {@code key} by the given {@code delta}.
*
* @param key must not be {@literal null}.
* @param delta
* @return {@literal null} if hash does not exist.
* @since 1.0
*/
Long increment(K key, long delta);
/**
* Increment {@code value} of the hash {@code key} by the given {@code delta}.
*
* @param key must not be {@literal null}.
* @param delta
* @return {@literal null} if hash does not exist.
* @since 1.1
*/
Double increment(K key, double delta);
/**
* Get a random key from the hash.
*
* @return {@literal null} if the hash does not exist.
* @since 2.6
*/
K randomKey();
/**
* Get a random entry from the hash.
*
* @return {@literal null} if the hash does not exist.
* @since 2.6
*/
@Nullable
Map.Entry randomEntry();
/**
* @since 1.4
* @return
*/
Iterator> scan();
}