org.springframework.data.redis.core

Interface SetOperations<K,V>

public interface SetOperations<K,V>

Redis set specific operations.

Author:

Costin Leau, Christoph Strobl, Mark Paluch, Roman Bezpalko

Method Summary

Modifier and Type	Method and Description
Long	add(K key, V... values) Add given values to set at key.
Set<V>	difference(Collection<K> keys) Diff all sets for given keys.
Set<V>	difference(K key, Collection<K> otherKeys) Diff all sets for given key and otherKeys.
Set<V>	difference(K key, K otherKey) Diff all sets for given key and otherKey.
Long	differenceAndStore(Collection<K> keys, K destKey) Diff all sets for given keys and store result in destKey.
Long	differenceAndStore(K key, Collection<K> otherKeys, K destKey) Diff all sets for given key and otherKeys and store result in destKey.
Long	differenceAndStore(K key, K otherKey, K destKey) Diff all sets for given key and otherKey and store result in destKey.
Set<V>	distinctRandomMembers(K key, long count) Get count distinct random elements from set at key.
RedisOperations<K,V>	getOperations()
Set<V>	intersect(Collection<K> keys) Returns the members intersecting all given sets at keys.
Set<V>	intersect(K key, Collection<K> otherKeys) Returns the members intersecting all given sets at key and otherKeys.
Set<V>	intersect(K key, K otherKey) Returns the members intersecting all given sets at key and otherKey.
Long	intersectAndStore(Collection<K> keys, K destKey) Intersect all given sets at keys and store result in destKey.
Long	intersectAndStore(K key, Collection<K> otherKeys, K destKey) Intersect all given sets at key and otherKeys and store result in destKey.
Long	intersectAndStore(K key, K otherKey, K destKey) Intersect all given sets at key and otherKey and store result in destKey.
Boolean	isMember(K key, Object o) Check if set at key contains value.
Set<V>	members(K key) Get all elements of set at key.
Boolean	move(K key, V value, K destKey) Move value from key to destKey
V	pop(K key) Remove and return a random member from set at key.
List<V>	pop(K key, long count) Remove and return count random members from set at key.
V	randomMember(K key) Get random element from set at key.
List<V>	randomMembers(K key, long count) Get count random elements from set at key.
Long	remove(K key, Object... values) Remove given values from set at key and return the number of removed elements.
Cursor<V>	scan(K key, ScanOptions options) Iterate over elements in set at key.
Long	size(K key) Get size of set at key.
Set<V>	union(Collection<K> keys) Union all sets at given keys.
Set<V>	union(K key, Collection<K> otherKeys) Union all sets at given keys and otherKeys.
Set<V>	union(K key, K otherKey) Union all sets at given keys and otherKey.
Long	unionAndStore(Collection<K> keys, K destKey) Union all sets at given keys and store result in destKey.
Long	unionAndStore(K key, Collection<K> otherKeys, K destKey) Union all sets at given key and otherKeys and store result in destKey.
Long	unionAndStore(K key, K otherKey, K destKey) Union all sets at given key and otherKey and store result in destKey.

Method Detail

add

@Nullable
Long add(K key,
                   V... values)

Add given values to set at key.

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SADD

remove

@Nullable
Long remove(K key,
                      Object... values)

Remove given values from set at key and return the number of removed elements.

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SREM

pop

@Nullable
V pop(K key)

Remove and return a random member from set at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SPOP

pop

@Nullable
List<V> pop(K key,
                      long count)

Remove and return count random members from set at key.

Parameters:

key - must not be null.

count - number of random members to pop from the set.

Returns:

null when used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: SPOP

move

@Nullable
Boolean move(K key,
                       V value,
                       K destKey)

Move value from key to destKey

Parameters:

key - must not be null.

value -

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SMOVE

size

@Nullable
Long size(K key)

Get size of set at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SCARD

isMember

@Nullable
Boolean isMember(K key,
                           Object o)

Check if set at key contains value.

Parameters:

key - must not be null.

o -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SISMEMBER

intersect

@Nullable
Set<V> intersect(K key,
                           K otherKey)

Returns the members intersecting all given sets at key and otherKey.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTER

intersect

@Nullable
Set<V> intersect(K key,
                           Collection<K> otherKeys)

Returns the members intersecting all given sets at key and otherKeys.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTER

intersect

@Nullable
Set<V> intersect(Collection<K> keys)

Returns the members intersecting all given sets at keys.

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.2

See Also:

Redis Documentation: SINTER

intersectAndStore

@Nullable
Long intersectAndStore(K key,
                                 K otherKey,
                                 K destKey)

Intersect all given sets at key and otherKey and store result in destKey.

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTERSTORE

intersectAndStore

@Nullable
Long intersectAndStore(K key,
                                 Collection<K> otherKeys,
                                 K destKey)

Intersect all given sets at key and otherKeys and store result in destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTERSTORE

intersectAndStore

@Nullable
Long intersectAndStore(Collection<K> keys,
                                 K destKey)

Intersect all given sets at keys and store result in destKey.

Parameters:

keys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.2

See Also:

Redis Documentation: SINTERSTORE

union

@Nullable
Set<V> union(K key,
                       K otherKey)

Union all sets at given keys and otherKey.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNION

union

@Nullable
Set<V> union(K key,
                       Collection<K> otherKeys)

Union all sets at given keys and otherKeys.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNION

union

@Nullable
Set<V> union(Collection<K> keys)

Union all sets at given keys.

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.2

See Also:

Redis Documentation: SUNION

unionAndStore

@Nullable
Long unionAndStore(K key,
                             K otherKey,
                             K destKey)

Union all sets at given key and otherKey and store result in destKey.

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNIONSTORE

unionAndStore

@Nullable
Long unionAndStore(K key,
                             Collection<K> otherKeys,
                             K destKey)

Union all sets at given key and otherKeys and store result in destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNIONSTORE

unionAndStore

@Nullable
Long unionAndStore(Collection<K> keys,
                             K destKey)

Union all sets at given keys and store result in destKey.

Parameters:

keys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.2

See Also:

Redis Documentation: SUNIONSTORE

difference

@Nullable
Set<V> difference(K key,
                            K otherKey)

Diff all sets for given key and otherKey.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFF

difference

@Nullable
Set<V> difference(K key,
                            Collection<K> otherKeys)

Diff all sets for given key and otherKeys.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFF

difference

@Nullable
Set<V> difference(Collection<K> keys)

Diff all sets for given keys.

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.2

See Also:

Redis Documentation: SDIFF

differenceAndStore

@Nullable
Long differenceAndStore(K key,
                                  K otherKey,
                                  K destKey)

Diff all sets for given key and otherKey and store result in destKey.

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFFSTORE

differenceAndStore

@Nullable
Long differenceAndStore(K key,
                                  Collection<K> otherKeys,
                                  K destKey)

Diff all sets for given key and otherKeys and store result in destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFFSTORE

differenceAndStore

@Nullable
Long differenceAndStore(Collection<K> keys,
                                  K destKey)

Diff all sets for given keys and store result in destKey.

Parameters:

keys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.2

See Also:

Redis Documentation: SDIFFSTORE

members

@Nullable
Set<V> members(K key)

Get all elements of set at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SMEMBERS

randomMember

V randomMember(K key)

Get random element from set at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SRANDMEMBER

distinctRandomMembers

@Nullable
Set<V> distinctRandomMembers(K key,
                                       long count)

Get count distinct random elements from set at key.

Parameters:

key - must not be null.

count - nr of members to return

Returns:

empty Set if key does not exist.

Throws:

IllegalArgumentException - if count is negative.

See Also:

Redis Documentation: SRANDMEMBER

randomMembers

@Nullable
List<V> randomMembers(K key,
                                long count)

Get count random elements from set at key.

Parameters:

key - must not be null.

count - nr of members to return.

Returns:

empty List if key does not exist or null when used in pipeline / transaction.

Throws:

IllegalArgumentException - if count is negative.

See Also:

Redis Documentation: SRANDMEMBER

scan

Cursor<V> scan(K key,
               ScanOptions options)

Iterate over elements in set at key.
Important: Call Closeable.close() when done to avoid resource leak.

Parameters:

key -

options -

Returns:

Since:

1.4

getOperations

RedisOperations<K,V> getOperations()