org.springframework.data.redis.core.BoundHashOperations 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.core;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.springframework.lang.Nullable;
/**
* Hash operations bound to a certain key.
*
* @author Costin Leau
* @author Christoph Strobl
* @author Ninad Divadkar
* @author Mark Paluch
*/
public interface BoundHashOperations extends BoundKeyOperations {
/**
* Delete given hash {@code keys} at the bound key.
*
* @param keys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
Long delete(Object... keys);
/**
* Determine if given hash {@code key} exists at the bound key.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
Boolean hasKey(Object key);
/**
* Get value for given {@code key} from the hash at the bound key.
*
* @param member must not be {@literal null}.
* @return {@literal null} when member does not exist or when used in pipeline / transaction.
*/
@Nullable
HV get(Object member);
/**
* Get values for given {@code keys} from the hash at the bound key.
*
* @param keys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
List multiGet(Collection keys);
/**
* Increment {@code value} of a hash {@code key} by the given {@code delta} at the bound key.
*
* @param key must not be {@literal null}.
* @param delta
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
Long increment(HK key, long delta);
/**
* Increment {@code value} of a hash {@code key} by the given {@code delta} at the bound key.
*
* @param key must not be {@literal null}.
* @param delta
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
Double increment(HK key, double delta);
/**
* Return a random key (aka field) from the hash value stored at the bound key.
*
* @return {@literal null} if the hash does not exist or when used in pipeline / transaction.
* @since 2.6
* @see Redis Documentation: HRANDFIELD
*/
@Nullable
HK randomKey();
/**
* Return a random entry from the hash value stored at the bound key.
*
* @return {@literal null} if key does not exist or when used in pipeline / transaction.
* @since 2.6
* @see Redis Documentation: HRANDFIELD
*/
@Nullable
Map.Entry randomEntry();
/**
* Return a random keys (aka fields) from the hash value stored at the bound key. If the provided {@code count} argument is
* positive, return a list of distinct keys, capped either at {@code count} or the hash size. If {@code count} is
* negative, the behavior changes and the command is allowed to return the same key multiple times. In this case,
* the number of returned keys is the absolute value of the specified count.
*
* @param count number of keys to return.
* @return {@literal null} if key does not exist or when used in pipeline / transaction.
* @since 2.6
* @see Redis Documentation: HRANDFIELD
*/
@Nullable
List randomKeys(long count);
/**
* Return a random entry from the hash value stored at the bound key.
*
* @param count number of entries to return. Must be positive.
* @return {@literal null} if the hash does not exist or when used in pipeline / transaction.
* @since 2.6
* @see Redis Documentation: HRANDFIELD
*/
@Nullable
Map randomEntries(long count);
/**
* Get key set (fields) of hash at the bound key.
*
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
Set keys();
/**
* Returns the length of the value associated with {@code hashKey}. If the {@code hashKey} do not exist, {@code 0} is
* returned.
*
* @param hashKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.1
*/
@Nullable
Long lengthOfValue(HK hashKey);
/**
* Get size of hash at the bound key.
*
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
Long size();
/**
* Set multiple hash fields to multiple values using data provided in {@code m} at the bound key.
*
* @param m must not be {@literal null}.
*/
void putAll(Map m);
/**
* Set the {@code value} of a hash {@code key} at the bound key.
*
* @param key must not be {@literal null}.
* @param value
*/
void put(HK key, HV value);
/**
* Set the {@code value} of a hash {@code key} only if {@code key} does not exist.
*
* @param key must not be {@literal null}.
* @param value
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
Boolean putIfAbsent(HK key, HV value);
/**
* Get entry set (values) of hash at the bound key.
*
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
List values();
/**
* Get entire hash at the bound key.
*
* @return {@literal null} when used in pipeline / transaction.
*/
@Nullable
Map entries();
/**
* Use a {@link Cursor} to iterate over entries in the hash.
*
* @param options
* @return
* @since 1.4
*/
Cursor> scan(ScanOptions options);
/**
* @return never {@literal null}.
*/
RedisOperations getOperations();
}