org.springframework.data.redis.core.SetOperations Maven / Gradle / Ivy
/*
* Copyright 2011-2018 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
*
* 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.springframework.data.redis.core;
import java.util.Collection;
import java.util.List;
import java.util.Set;
import org.springframework.lang.Nullable;
/**
* Redis set specific operations.
*
* @author Costin Leau
* @author Christoph Strobl
* @author Mark Paluch
*/
public interface SetOperations {
/**
* Add given {@code values} to set at {@code key}.
*
* @param key must not be {@literal null}.
* @param values
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SADD
*/
@Nullable
Long add(K key, V... values);
/**
* Remove given {@code values} from set at {@code key} and return the number of removed elements.
*
* @param key must not be {@literal null}.
* @param values
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SREM
*/
@Nullable
Long remove(K key, Object... values);
/**
* Remove and return a random member from set at {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SPOP
*/
@Nullable
V pop(K key);
/**
* Remove and return {@code count} random members from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count number of random members to pop from the set.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SPOP
* @since 2.0
*/
@Nullable
List pop(K key, long count);
/**
* Move {@code value} from {@code key} to {@code destKey}
*
* @param key must not be {@literal null}.
* @param value
* @param destKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SMOVE
*/
@Nullable
Boolean move(K key, V value, K destKey);
/**
* Get size of set at {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SCARD
*/
@Nullable
Long size(K key);
/**
* Check if set at {@code key} contains {@code value}.
*
* @param key must not be {@literal null}.
* @param o
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SISMEMBER
*/
@Nullable
Boolean isMember(K key, Object o);
/**
* Returns the members intersecting all given sets at {@code key} and {@code otherKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SINTER
*/
@Nullable
Set intersect(K key, K otherKey);
/**
* Returns the members intersecting all given sets at {@code key} and {@code otherKeys}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SINTER
*/
@Nullable
Set intersect(K key, Collection otherKeys);
/**
* Intersect all given sets at {@code key} and {@code otherKey} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SINTERSTORE
*/
@Nullable
Long intersectAndStore(K key, K otherKey, K destKey);
/**
* Intersect all given sets at {@code key} and {@code otherKeys} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SINTERSTORE
*/
@Nullable
Long intersectAndStore(K key, Collection otherKeys, K destKey);
/**
* Union all sets at given {@code keys} and {@code otherKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SUNION
*/
@Nullable
Set union(K key, K otherKey);
/**
* Union all sets at given {@code keys} and {@code otherKeys}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SUNION
*/
@Nullable
Set union(K key, Collection otherKeys);
/**
* Union all sets at given {@code key} and {@code otherKey} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SUNIONSTORE
*/
@Nullable
Long unionAndStore(K key, K otherKey, K destKey);
/**
* Union all sets at given {@code key} and {@code otherKeys} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SUNIONSTORE
*/
@Nullable
Long unionAndStore(K key, Collection otherKeys, K destKey);
/**
* Diff all sets for given {@code key} and {@code otherKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SDIFF
*/
@Nullable
Set difference(K key, K otherKey);
/**
* Diff all sets for given {@code key} and {@code otherKeys}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SDIFF
*/
@Nullable
Set difference(K key, Collection otherKeys);
/**
* Diff all sets for given {@code key} and {@code otherKey} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SDIFFSTORE
*/
@Nullable
Long differenceAndStore(K key, K otherKey, K destKey);
/**
* Diff all sets for given {@code key} and {@code otherKeys} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SDIFFSTORE
*/
@Nullable
Long differenceAndStore(K key, Collection otherKeys, K destKey);
/**
* Get all elements of set at {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SMEMBERS
*/
@Nullable
Set members(K key);
/**
* Get random element from set at {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SRANDMEMBER
*/
V randomMember(K key);
/**
* Get {@code count} distinct random elements from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return
* @return empty {@link Set} if {@code key} does not exist.
* @throws IllegalArgumentException if count is negative.
* @see Redis Documentation: SRANDMEMBER
*/
@Nullable
Set distinctRandomMembers(K key, long count);
/**
* Get {@code count} random elements from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return.
* @return empty {@link List} if {@code key} does not exist or {@literal null} when used in pipeline / transaction.
* @throws IllegalArgumentException if count is negative.
* @see Redis Documentation: SRANDMEMBER
*/
@Nullable
List randomMembers(K key, long count);
/**
* Iterate over elements in set at {@code key}.
* Important: Call {@link Cursor#close()} when done to avoid resource leak.
*
* @param key
* @param options
* @return
* @since 1.4
*/
Cursor scan(K key, ScanOptions options);
RedisOperations getOperations();
}