Package org.springframework.data.redis.support.collections

Class DefaultRedisSet<E>

java.lang.Object

java.util.AbstractCollection<E>

org.springframework.data.redis.support.collections.AbstractRedisCollection<E>

org.springframework.data.redis.support.collections.DefaultRedisSet<E>

All Implemented Interfaces:

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

public class DefaultRedisSet<E>
extends AbstractRedisCollection<E>
implements RedisSet<E>

Default implementation for RedisSet. Note that the collection support works only with normal, non-pipeline/multi-exec connections as it requires a reply to be sent right away.

Author:

Costin Leau, Christoph Strobl, Mark Paluch

Field Summary

Fields inherited from class org.springframework.data.redis.support.collections.AbstractRedisCollection

ENCODING

Constructor Summary

Constructors

Constructor	Description
DefaultRedisSet(String key, RedisOperations<String,E> operations)	Constructs a new DefaultRedisSet instance.
DefaultRedisSet(BoundSetOperations<String,E> boundOps)	Constructs a new DefaultRedisSet instance.

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
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.
DataType	getType()	Returns the associated Redis type.
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.
Iterator<E>	iterator()
E	randomValue()	Get random element from the set.
boolean	remove(Object o)
Cursor<E>	scan()
Cursor<E>	scan(ScanOptions options)
int	size()
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 class org.springframework.data.redis.support.collections.AbstractRedisCollection

addAll, checkResult, equals, expire, expireAt, getExpire, getKey, getOperations, hashCode, persist, removeAll, rename, toString

Methods inherited from class java.util.AbstractCollection

isEmpty, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.springframework.data.redis.support.collections.RedisStore

getOperations

Methods inherited from interface java.util.Set

addAll, equals, hashCode, isEmpty, removeAll, retainAll, spliterator, toArray, toArray

Constructor Details

DefaultRedisSet

public DefaultRedisSet(String key,
 RedisOperations<String,E> operations)

Constructs a new DefaultRedisSet instance.

Parameters:

key - Redis key of this set.

operations - RedisOperations for the value type of this set.

DefaultRedisSet

public DefaultRedisSet(BoundSetOperations<String,E> boundOps)

Constructs a new DefaultRedisSet instance.

Parameters:

boundOps - BoundSetOperations for the value type of this set.

Method Details

diff

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

Description copied from interface: RedisSet

Diff this set and another RedisSet.

Specified by:

diff in interface RedisSet<E>

Parameters:

set - must not be null.

Returns:

a Set containing the values that differ.

diff

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

Description copied from interface: RedisSet

Diff this set and other RedisSets.

Specified by:

diff in interface RedisSet<E>

Parameters:

sets - must not be null.

Returns:

a Set containing the values that differ.

diffAndStore

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

Description copied from interface: RedisSet

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

Specified by:

diffAndStore in interface RedisSet<E>

Parameters:

set - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

diffAndStore

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

Description copied from interface: RedisSet

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

Specified by:

diffAndStore in interface RedisSet<E>

Parameters:

sets - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

intersect

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

Description copied from interface: RedisSet

Intersect this set and another RedisSet.

Specified by:

intersect in interface RedisSet<E>

Parameters:

set - must not be null.

Returns:

a Set containing the intersecting values.

intersect

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

Description copied from interface: RedisSet

Intersect this set and other RedisSets.

Specified by:

intersect in interface RedisSet<E>

Parameters:

sets - must not be null.

Returns:

a Set containing the intersecting values.

intersectAndStore

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

Description copied from interface: RedisSet

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

Specified by:

intersectAndStore in interface RedisSet<E>

Parameters:

set - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey

intersectAndStore

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

Description copied from interface: RedisSet

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

Specified by:

intersectAndStore in interface RedisSet<E>

Parameters:

sets - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

union

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

Description copied from interface: RedisSet

Union this set and another RedisSet.

Specified by:

union in interface RedisSet<E>

Parameters:

set - must not be null.

Returns:

a Set containing the combined values.

union

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

Description copied from interface: RedisSet

Union this set and other RedisSets.

Specified by:

union in interface RedisSet<E>

Parameters:

sets - must not be null.

Returns:

a Set containing the combined values.

unionAndStore

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

Description copied from interface: RedisSet

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

Specified by:

unionAndStore in interface RedisSet<E>

Parameters:

set - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

unionAndStore

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

Description copied from interface: RedisSet

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

Specified by:

unionAndStore in interface RedisSet<E>

Parameters:

sets - must not be null.

destKey - must not be null.

Returns:

a new RedisSet pointing at destKey.

randomValue

public E randomValue()

Description copied from interface: RedisSet

Get random element from the set.

Specified by:

randomValue in interface RedisSet<E>

Returns:

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

Overrides:

containsAll in class AbstractRedisCollection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

getType

public DataType getType()

Description copied from interface: BoundKeyOperations

Returns the associated Redis type.

Specified by:

getType in interface BoundKeyOperations<E>

Returns:

key type. null when used in pipeline / transaction.

scan

public Cursor<E> scan()

Specified by:

scan in interface RedisSet<E>

Returns:

scan

public Cursor<E> scan(ScanOptions options)

Parameters:

options -

Returns:

Since:

1.4