Interface RedisSet<E>

Type Parameters:

E - the type of elements in this collection.

All Superinterfaces:

BoundKeyOperations<String>, Collection<E>, Iterable<E>, RedisCollection<E>, RedisStore, Set<E>

All Known Implementing Classes:

DefaultRedisSet

public interface RedisSet<E>
extends RedisCollection<E>, Set<E>

Redis extension for the Set contract. Supports Set specific operations backed by Redis operations.

Author:

Costin Leau, Christoph Strobl, Mark Paluch, Mingi Lee

Method Summary

Modifier and Type	Method	Description
static <E> RedisSet<E>	create(String key, RedisOperations<String,E> operations)	Constructs a new RedisSet instance.
Set<E>	diff(Collection<? extends RedisSet<?>> sets)	Diff this set and other RedisSets.
Set<E>	diff(RedisSet<?> set)	Diff this set and another RedisSet.
RedisSet<E>	diffAndStore(Collection<? extends RedisSet<?>> sets, String destKey)	Create a new RedisSet by diffing this sorted set and the collection RedisSet and store result in destination destKey.
RedisSet<E>	diffAndStore(RedisSet<?> set, String destKey)	Create a new RedisSet by diffing this sorted set and RedisSet and store result in destination destKey.
Set<E>	intersect(Collection<? extends RedisSet<?>> sets)	Intersect this set and other RedisSets.
Set<E>	intersect(RedisSet<?> set)	Intersect this set and another RedisSet.
RedisSet<E>	intersectAndStore(Collection<? extends RedisSet<?>> sets, String destKey)	Create a new RedisSet by intersecting this sorted set and the collection RedisSet and store result in destination destKey.
RedisSet<E>	intersectAndStore(RedisSet<?> set, String destKey)	Create a new RedisSet by intersecting this sorted set and RedisSet and store result in destination destKey.
Long	intersectSize(Collection<? extends RedisSet<?>> sets)	Returns the cardinality of the set which would result from the intersection of this set and other RedisSets.
Long	intersectSize(RedisSet<?> set)	Returns the cardinality of the set which would result from the intersection of this set and another RedisSet.
E	randomValue()	Get random element from the set.
Iterator<E>	scan()
Set<E>	union(Collection<? extends RedisSet<?>> sets)	Union this set and other RedisSets.
Set<E>	union(RedisSet<?> set)	Union this set and another RedisSet.
RedisSet<E>	unionAndStore(Collection<? extends RedisSet<?>> sets, String destKey)	Create a new RedisSet by union this sorted set and the collection RedisSet and store result in destination destKey.
RedisSet<E>	unionAndStore(RedisSet<?> set, String destKey)	Create a new RedisSet by union this sorted set and RedisSet and store result in destination destKey.

Methods inherited from interface BoundKeyOperations

expiration, expire, expire, expireAt, expireAt, getExpire, getKey, getType, persist, rename

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface RedisStore

getOperations

Methods inherited from interface Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Method Details

create

static <E> RedisSet<E> create(String key,
 RedisOperations<String,E> operations)

Constructs a new RedisSet instance.

Parameters:

key - Redis key of this set.

operations - RedisOperations for the value type of this set.

Since:

2.6

diff

Set<E> diff(RedisSet<?> set)

Diff this set and another RedisSet.

Parameters:

set - must not be null.

Returns:

a Set containing the values that differ.

Since:

1.0

diff

Set<E> diff(Collection<? extends RedisSet<?>> sets)

Diff this set and other RedisSets.

Parameters:

sets - must not be null.

Returns:

a Set containing the values that differ.

Since:

1.0

diffAndStore

RedisSet<E> diffAndStore(RedisSet<?> set,
 String destKey)

Create a new RedisSet by diffing this sorted set and RedisSet and store result in destination destKey.

Parameters:

set - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

Since:

1.0

diffAndStore

RedisSet<E> diffAndStore(Collection<? extends RedisSet<?>> sets,
 String destKey)

Create a new RedisSet by diffing this sorted set and the collection RedisSet and store result in destination destKey.

Parameters:

sets - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

Since:

1.0

intersect

Set<E> intersect(RedisSet<?> set)

Intersect this set and another RedisSet.

Parameters:

set - must not be null.

Returns:

a Set containing the intersecting values.

Since:

1.0

intersect

Set<E> intersect(Collection<? extends RedisSet<?>> sets)

Intersect this set and other RedisSets.

Parameters:

sets - must not be null.

Returns:

a Set containing the intersecting values.

Since:

1.0

intersectAndStore

RedisSet<E> intersectAndStore(RedisSet<?> set,
 String destKey)

Create a new RedisSet by intersecting this sorted set and RedisSet and store result in destination destKey.

Parameters:

set - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey

Since:

1.0

intersectAndStore

RedisSet<E> intersectAndStore(Collection<? extends RedisSet<?>> sets,
 String destKey)

Create a new RedisSet by intersecting this sorted set and the collection RedisSet and store result in destination destKey.

Parameters:

sets - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

Since:

1.0

intersectSize

Long intersectSize(RedisSet<?> set)

Returns the cardinality of the set which would result from the intersection of this set and another RedisSet.

Parameters:

set - must not be null.

Returns:

the cardinality of the intersection.

Since:

4.0

See Also:

• Redis Documentation: SINTERCARD

intersectSize

Long intersectSize(Collection<? extends RedisSet<?>> sets)

Returns the cardinality of the set which would result from the intersection of this set and other RedisSets.

Parameters:

sets - must not be null.

Returns:

the cardinality of the intersection.

Since:

4.0

See Also:

• Redis Documentation: SINTERCARD

randomValue

E randomValue()

Get random element from the set.

Returns:

Since:

2.6

scan

Iterator<E> scan()

Returns:

Since:

1.4

union

Set<E> union(RedisSet<?> set)

Union this set and another RedisSet.

Parameters:

set - must not be null.

Returns:

a Set containing the combined values.

Since:

2.6

union

Set<E> union(Collection<? extends RedisSet<?>> sets)

Union this set and other RedisSets.

Parameters:

sets - must not be null.

Returns:

a Set containing the combined values.

Since:

1.0

unionAndStore

RedisSet<E> unionAndStore(RedisSet<?> set,
 String destKey)

Create a new RedisSet by union this sorted set and RedisSet and store result in destination destKey.

Parameters:

set - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

Since:

1.0

unionAndStore

RedisSet<E> unionAndStore(Collection<? extends RedisSet<?>> sets,
 String destKey)

Create a new RedisSet by union this sorted set and the collection RedisSet and store result in destination destKey.

Parameters:

sets - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

Since:

1.0