BoundSetOperations (Spring Data Redis 2.2.0.RELEASE API)

All Superinterfaces:

BoundKeyOperations<K>
```
public interface BoundSetOperations<K,V>
extends BoundKeyOperations<K>
```
Set operations bound to a certain key.

Author:

Costin Leau, Mark Paluch

Method Summary

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

Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations
expire, expireAt, getExpire, getKey, getType, persist, rename

- Method Detail
  - add
```
@Nullable
Long add(V... values)
```
    Add given values to set at the bound key.
    
    Parameters:
    
    values -
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SADD
  - remove
```
@Nullable
Long remove(Object... values)
```
    Remove given values from set at the bound key and return the number of removed elements.
    
    Parameters:
    
    values -
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SREM
  - pop
```
@Nullable
V pop()
```
    Remove and return a random member from set at the bound key.
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SPOP
  - move
```
@Nullable
Boolean move(K destKey,
                       V value)
```
    Move value from the bound key to destKey
    
    Parameters:
    
    destKey - must not be null.
    
    value -
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SMOVE
  - size
```
@Nullable
Long size()
```
    Get size of set at the bound key.
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SCARD
  - isMember
```
@Nullable
Boolean isMember(Object o)
```
    Check if set at the bound key contains value.
    
    Parameters:
    
    o -
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SISMEMBER
  - intersect
```
@Nullable
Set<V> intersect(K key)
```
    Returns the members intersecting all given sets at the bound key and key.
    
    Parameters:
    
    key - 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 the bound key and keys.
    
    Parameters:
    
    keys - must not be null.
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SINTER
  - intersectAndStore
```
void intersectAndStore(K key,
                       K destKey)
```
    Intersect all given sets at the bound key and key and store result in destKey.
    
    Parameters:
    
    key - must not be null.
    
    destKey - must not be null.
    
    See Also:
    
    Redis Documentation: SINTERSTORE
  - intersectAndStore
```
void intersectAndStore(Collection<K> keys,
                       K destKey)
```
    Intersect all given sets at the bound key and keys and store result in destKey.
    
    Parameters:
    
    keys - must not be null.
    
    destKey - must not be null.
    
    See Also:
    
    Redis Documentation: SINTERSTORE
  - union
```
@Nullable
Set<V> union(K key)
```
    Union all sets at given key and key.
    
    Parameters:
    
    key - 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 and keys.
    
    Parameters:
    
    keys - must not be null.
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SUNION
  - unionAndStore
```
void unionAndStore(K key,
                   K destKey)
```
    Union all sets at given the bound key and key and store result in destKey.
    
    Parameters:
    
    key - must not be null.
    
    destKey - must not be null.
    
    See Also:
    
    Redis Documentation: SUNIONSTORE
  - unionAndStore
```
void unionAndStore(Collection<K> keys,
                   K destKey)
```
    Union all sets at given the bound key and keys and store result in destKey.
    
    Parameters:
    
    keys - must not be null.
    
    destKey - must not be null.
    
    See Also:
    
    Redis Documentation: SUNIONSTORE
  - diff
```
@Nullable
Set<V> diff(K key)
```
    Diff all sets for given the bound key and key.
    
    Parameters:
    
    key - must not be null.
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SDIFF
  - diff
```
@Nullable
Set<V> diff(Collection<K> keys)
```
    Diff all sets for given the bound key and keys.
    
    Parameters:
    
    keys - must not be null.
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SDIFF
  - diffAndStore
```
void diffAndStore(K keys,
                  K destKey)
```
    Diff all sets for given the bound key and keys and store result in destKey.
    
    Parameters:
    
    keys - must not be null.
    
    destKey - must not be null.
    
    See Also:
    
    Redis Documentation: SDIFFSTORE
  - diffAndStore
```
void diffAndStore(Collection<K> keys,
                  K destKey)
```
    Diff all sets for given the bound key and keys and store result in destKey.
    
    Parameters:
    
    keys - must not be null.
    
    destKey - must not be null.
    
    See Also:
    
    Redis Documentation: SDIFFSTORE
  - members
```
@Nullable
Set<V> members()
```
    Get all elements of set at the bound key.
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SMEMBERS
  - randomMember
```
@Nullable
V randomMember()
```
    Get random element from set at the bound key.
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SRANDMEMBER
  - distinctRandomMembers
```
@Nullable
Set<V> distinctRandomMembers(long count)
```
    Get count distinct random elements from set at the bound key.
    
    Parameters:
    
    count -
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SRANDMEMBER
  - randomMembers
```
@Nullable
List<V> randomMembers(long count)
```
    Get count random elements from set at the bound key.
    
    Parameters:
    
    count -
    
    Returns:
    
    null when used in pipeline / transaction.
    
    See Also:
    
    Redis Documentation: SRANDMEMBER
  - scan
```
@Nullable
Cursor<V> scan(ScanOptions options)
```
    Parameters:
    
    options -
    
    Returns:
    
    null when used in pipeline / transaction.
    
    Since:
    
    1.4
  - getOperations
```
RedisOperations<K,V> getOperations()
```
    Returns:
    
    never null.

Interface BoundSetOperations<K,V>

Method Summary

Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations

Method Detail

add

remove

pop

move

size

isMember

intersect

intersect

intersectAndStore

intersectAndStore

union

union

unionAndStore

unionAndStore

diff

diff

diffAndStore

diffAndStore

members

randomMember

distinctRandomMembers

randomMembers

scan

getOperations