org.openingo.spring.extension.data.redis.commands

Interface ISetCommands<K,V>

All Known Subinterfaces:

IRedisCommands<K,V>

All Known Implementing Classes:

AbstractRedisCommands, RedisTemplateX, StringRedisTemplateX

public interface ISetCommands<K,V>

ISetCommands

Author:

Qicz

Method Summary

Modifier and Type	Method and Description
Long	sAdd(K key, V... values) Add given values to set at key.
Long	sCard(K key) Get size of set at key.
Set<V>	sDiff(K key, Collection<K> otherKeys) Diff all sets for given key and otherKeys.
Set<V>	sDiff(K key, K otherKey) Diff all sets for given key and otherKey.
Long	sDiffStore(K key, Collection<K> otherKeys, K destKey) Diff all sets for given key and otherKeys and store result in destKey.
Long	sDiffStore(K key, K otherKey, K destKey) Diff all sets for given key and otherKey and store result in destKey.
Set<V>	sInter(K key, Collection<K> otherKeys) Returns the members intersecting all given sets at key and otherKeys.
Set<V>	sInter(K key, K otherKey) Returns the members intersecting all given sets at key and otherKey.
Long	sInterStore(K key, Collection<K> otherKeys, K destKey) Intersect all given sets at key and otherKeys and store result in destKey.
Long	sInterstore(K key, K otherKey, K destKey) Intersect all given sets at key and otherKey and store result in destKey.
Boolean	sIsMember(K key, Object member) Check if set at key contains value.
Set<V>	sMembers(K key) Get all elements of set at key.
V	sPop(K key) Remove and return a random member from set at key.
V	sRandMember(K key) Get random element from set at key.
List<V>	sRandMember(K key, long count) Get count random elements from set at key.
Long	sRem(K key, Object... members) Remove given values from set at key and return the number of removed elements.
Set<V>	sUnion(K key, Collection<K> otherKeys) Union all sets at given keys and otherKeys.
Set<V>	sUnion(K key, K otherKey) Union all sets at given keys and otherKey.
Long	sUnionStore(K key, Collection<K> otherKeys, K destKey) Union all sets at given key and otherKeys and store result in destKey.
Long	sUnionStore(K key, K otherKey, K destKey) Union all sets at given key and otherKey and store result in destKey.

Method Detail

sAdd

@Nullable
Long sAdd(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

sCard

@Nullable
Long sCard(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

sPop

@Nullable
V sPop(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

sMembers

@Nullable
Set<V> sMembers(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

sIsMember

@Nullable
Boolean sIsMember(K key,
                            Object member)

Check if set at key contains value.

Parameters:

key - must not be null.

member -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SISMEMBER

sInter

@Nullable
Set<V> sInter(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

sInter

@Nullable
Set<V> sInter(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

sInterstore

@Nullable
Long sInterstore(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

sInterStore

@Nullable
Long sInterStore(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

sRandMember

V sRandMember(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

sRandMember

@Nullable
List<V> sRandMember(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

sRem

@Nullable
Long sRem(K key,
                    Object... members)

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

Parameters:

key - must not be null.

members -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SREM

sUnion

@Nullable
Set<V> sUnion(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

sUnion

@Nullable
Set<V> sUnion(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

sUnionStore

@Nullable
Long sUnionStore(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

sUnionStore

@Nullable
Long sUnionStore(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

sDiff

@Nullable
Set<V> sDiff(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

sDiff

@Nullable
Set<V> sDiff(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

sDiffStore

@Nullable
Long sDiffStore(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

sDiffStore

@Nullable
Long sDiffStore(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