org.springframework.data.redis.core.BoundSetOperations Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-redis Show documentation
Show all versions of spring-data-redis Show documentation
Spring Data module for Redis
/*
* Copyright 2011-2023 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;
/**
* Set operations bound to a certain key.
*
* @author Costin Leau
* @author Mark Paluch
*/
public interface BoundSetOperations extends BoundKeyOperations {
/**
* Add given {@code values} to set at the bound key.
*
* @param values
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SADD
*/
@Nullable
Long add(V... values);
/**
* Remove given {@code values} from set at the bound key and return the number of removed elements.
*
* @param values
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SREM
*/
@Nullable
Long remove(Object... values);
/**
* Remove and return a random member from set at the bound key.
*
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SPOP
*/
@Nullable
V pop();
/**
* Move {@code value} from the bound key to {@code destKey}
*
* @param destKey must not be {@literal null}.
* @param value
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SMOVE
*/
@Nullable
Boolean move(K destKey, V value);
/**
* Get size of set at the bound key.
*
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SCARD
*/
@Nullable
Long size();
/**
* Check if set at the bound key contains {@code value}.
*
* @param o
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SISMEMBER
*/
@Nullable
Boolean isMember(Object o);
/**
* Check if set at at the bound key contains one or more {@code values}.
*
* @param objects
* @return {@literal null} when used in pipeline / transaction.
* @since 2.6
* @see Redis Documentation: SMISMEMBER
*/
@Nullable
Map isMember(Object... objects);
/**
* Returns the members intersecting all given sets at the bound key and {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SINTER
*/
@Nullable
Set intersect(K key);
/**
* Returns the members intersecting all given sets at the bound key and {@code keys}.
*
* @param keys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SINTER
*/
@Nullable
Set intersect(Collection keys);
/**
* Intersect all given sets at the bound key and {@code key} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @see Redis Documentation: SINTERSTORE
*/
void intersectAndStore(K key, K destKey);
/**
* Intersect all given sets at the bound key and {@code keys} and store result in {@code destKey}.
*
* @param keys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @see Redis Documentation: SINTERSTORE
*/
void intersectAndStore(Collection keys, K destKey);
/**
* Union all sets at given {@code key} and {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SUNION
*/
@Nullable
Set union(K key);
/**
* Union all sets at given {@code keys} and {@code keys}.
*
* @param keys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SUNION
*/
@Nullable
Set union(Collection keys);
/**
* Union all sets at given the bound key and {@code key} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @see Redis Documentation: SUNIONSTORE
*/
void unionAndStore(K key, K destKey);
/**
* Union all sets at given the bound key and {@code keys} and store result in {@code destKey}.
*
* @param keys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @see Redis Documentation: SUNIONSTORE
*/
void unionAndStore(Collection keys, K destKey);
/**
* Diff all sets for given the bound key and {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SDIFF
* @deprecated since 3.0, use {@link #difference(Object)} instead to follow a consistent method naming scheme.
*/
@Nullable
default Set diff(K key) {
return difference(key);
}
/**
* Diff all sets for given the bound key and {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 3.0
* @see Redis Documentation: SDIFF
*/
@Nullable
Set difference(K key);
/**
* Diff all sets for given the bound key and {@code keys}.
*
* @param keys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SDIFF
* @deprecated since 3.0, use {@link #difference(Collection)} instead to follow a consistent method naming scheme.
*/
@Nullable
default Set diff(Collection keys) {
return difference(keys);
}
/**
* Diff all sets for given the bound key and {@code keys}.
*
* @param keys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 3.0
* @see Redis Documentation: SDIFF
*/
@Nullable
Set difference(Collection keys);
/**
* Diff all sets for given the bound key and {@code keys} and store result in {@code destKey}.
*
* @param keys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @see Redis Documentation: SDIFFSTORE
* @deprecated since 3.0, use {@link #differenceAndStore(Object, Object)} instead to follow a consistent method naming
* scheme..
*/
@Deprecated
default void diffAndStore(K keys, K destKey) {
differenceAndStore(keys, destKey);
}
/**
* Diff all sets for given the bound key and {@code keys} and store result in {@code destKey}.
*
* @param keys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @since 3.0
* @see Redis Documentation: SDIFFSTORE
*/
void differenceAndStore(K keys, K destKey);
/**
* Diff all sets for given the bound key and {@code keys} and store result in {@code destKey}.
*
* @param keys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @see Redis Documentation: SDIFFSTORE
* @deprecated since 3.0, use {@link #differenceAndStore(Collection, Object)} instead to follow a consistent method
* naming scheme.
*/
@Deprecated
default void diffAndStore(Collection keys, K destKey) {
differenceAndStore(keys, destKey);
}
/**
* Diff all sets for given the bound key and {@code keys} and store result in {@code destKey}.
*
* @param keys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @since 3.0
* @see Redis Documentation: SDIFFSTORE
*/
void differenceAndStore(Collection keys, K destKey);
/**
* Get all elements of set at the bound key.
*
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SMEMBERS
*/
@Nullable
Set members();
/**
* Get random element from set at the bound key.
*
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SRANDMEMBER
*/
@Nullable
V randomMember();
/**
* Get {@code count} distinct random elements from set at the bound key.
*
* @param count
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SRANDMEMBER
*/
@Nullable
Set distinctRandomMembers(long count);
/**
* Get {@code count} random elements from set at the bound key.
*
* @param count
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: SRANDMEMBER
*/
@Nullable
List randomMembers(long count);
/**
* Use a {@link Cursor} to iterate over entries in set at {@code key}.
* Important: Call {@link Cursor#close()} when done to avoid resource leaks.
*
* @param options must not be {@literal null}.
* @return the result cursor providing access to the scan result. Must be closed once fully processed (e.g. through a
* try-with-resources clause).
* @since 1.4
*/
@Nullable
Cursor scan(ScanOptions options);
/**
* @return never {@literal null}.
*/
RedisOperations getOperations();
}