org.redisson

Class RedissonSet<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonSet<V>

Type Parameters:

V - value

All Implemented Interfaces:

Iterable<V>, Collection<V>, Set<V>, RCollectionAsync<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync, RSet<V>, RSetAsync<V>

public class RedissonSet<V>
extends RedissonObject
implements RSet<V>

Distributed and concurrent implementation of Set

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Modifier	Constructor and Description
	RedissonSet(Codec codec, CommandAsyncExecutor commandExecutor, String name)
protected	RedissonSet(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(V e)
boolean	addAll(Collection<? extends V> c)
RFuture<Boolean>	addAllAsync(Collection<? extends V> c)
RFuture<Boolean>	addAsync(V e)
void	clear()
boolean	clearExpire() Clear an expire timeout or expire date for object.
RFuture<Boolean>	clearExpireAsync() Clear an expire timeout or expire date for object in async mode.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
RFuture<Boolean>	containsAllAsync(Collection<?> c) Returns true if this collection contains all of the elements in the specified collection.
RFuture<Boolean>	containsAsync(Object o) Returns true if this collection contains the specified element.
int	diff(String... names) Diff sets specified by name and write to current set.
RFuture<Integer>	diffAsync(String... names) Diff sets specified by name and write to current set.
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
boolean	expireAt(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
RFuture<Boolean>	expireAtAsync(Date timestamp) Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(long timestamp) Set an expire date for object in async mode.
protected String	getName(Object o)
int	intersection(String... names) Intersection sets specified by name and write to current set.
RFuture<Integer>	intersectionAsync(String... names) Intersection sets specified by name and write to current set.
boolean	isEmpty()
Iterator<V>	iterator()
boolean	move(String destination, V member) Move a member from this set to the given destination set in.
RFuture<Boolean>	moveAsync(String destination, V member) Move a member from this set to the given destination set in async mode.
V	random() Returns random element from set
RFuture<V>	randomAsync() Returns random element from set in async mode
Set<V>	readAll() Read all elements at once
RFuture<Set<V>>	readAllAsync() Read all elements at once
Set<V>	readDiff(String... names) Diff sets specified by name with current set.
RFuture<Set<V>>	readDiffAsync(String... names) Diff sets specified by name with current set.
Set<V>	readIntersection(String... names) Intersection sets specified by name with current set without current set state change.
RFuture<Set<V>>	readIntersectionAsync(String... names) Intersection sets specified by name with current set.
Set<V>	readUnion(String... names) Union sets specified by name with current set without current set state change.
RFuture<Set<V>>	readUnionAsync(String... names) Union sets specified by name with current set.
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync() Get remaining time to live of object in seconds.
boolean	remove(Object value)
boolean	removeAll(Collection<?> c)
RFuture<Boolean>	removeAllAsync(Collection<?> c) Removes all of this collection's elements that are also contained in the specified collection (optional operation).
RFuture<Boolean>	removeAsync(Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
V	removeRandom() Removes and returns random element from set
RFuture<V>	removeRandomAsync() Removes and returns random element from set in async mode
boolean	retainAll(Collection<?> c)
RFuture<Boolean>	retainAllAsync(Collection<?> c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
int	size()
RFuture<Integer>	sizeAsync() Returns the number of elements in this collection.
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()
int	union(String... names) Union sets specified by name and write to current set.
RFuture<Integer>	unionAsync(String... names) Union sets specified by name and write to current set.

Methods inherited from class org.redisson.RedissonObject

await, delete, deleteAsync, encode, encodeMapKey, encodeMapValue, get, getCodec, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, newPromise, newSucceededFuture, prefixName, rename, renameAsync, renamenx, renamenxAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

equals, hashCode

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

delete, getCodec, getName, isExists, migrate, move, rename, renamenx

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonSet

protected RedissonSet(CommandAsyncExecutor commandExecutor,
           String name)

RedissonSet

public RedissonSet(Codec codec,
           CommandAsyncExecutor commandExecutor,
           String name)

Method Detail

size

public int size()

Specified by:

size in interface Collection<V>

Specified by:

size in interface Set<V>

sizeAsync

public RFuture<Integer> sizeAsync()

Description copied from interface: RCollectionAsync

Returns the number of elements in this collection.

Specified by:

sizeAsync in interface RCollectionAsync<V>

Returns:

size of collection

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<V>

Specified by:

isEmpty in interface Set<V>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<V>

Specified by:

contains in interface Set<V>

containsAsync

public RFuture<Boolean> containsAsync(Object o)

Description copied from interface: RCollectionAsync

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

containsAsync in interface RCollectionAsync<V>

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element

getName

protected String getName(Object o)

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Collection<V>

Specified by:

iterator in interface Set<V>

readAllAsync

public RFuture<Set<V>> readAllAsync()

Description copied from interface: RSetAsync

Read all elements at once

Specified by:

readAllAsync in interface RSetAsync<V>

Returns:

values

readAll

public Set<V> readAll()

Description copied from interface: RSet

Read all elements at once

Specified by:

readAll in interface RSet<V>

Returns:

values

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<V>

Specified by:

toArray in interface Set<V>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<V>

Specified by:

toArray in interface Set<V>

add

public boolean add(V e)

Specified by:

add in interface Collection<V>

Specified by:

add in interface Set<V>

addAsync

public RFuture<Boolean> addAsync(V e)

Specified by:

addAsync in interface RCollectionAsync<V>

removeRandom

public V removeRandom()

Description copied from interface: RSet

Removes and returns random element from set

Specified by:

removeRandom in interface RSet<V>

Returns:

value

removeRandomAsync

public RFuture<V> removeRandomAsync()

Description copied from interface: RSetAsync

Removes and returns random element from set in async mode

Specified by:

removeRandomAsync in interface RSetAsync<V>

Returns:

value

random

public V random()

Description copied from interface: RSet

Returns random element from set

Specified by:

random in interface RSet<V>

Returns:

value

randomAsync

public RFuture<V> randomAsync()

Description copied from interface: RSetAsync

Returns random element from set in async mode

Specified by:

randomAsync in interface RSetAsync<V>

Returns:

value

removeAsync

public RFuture<Boolean> removeAsync(Object o)

Description copied from interface: RCollectionAsync

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Specified by:

removeAsync in interface RCollectionAsync<V>

Parameters:

o - element to be removed from this collection, if present

Returns:

true if an element was removed as a result of this call

remove

public boolean remove(Object value)

Specified by:

remove in interface Collection<V>

Specified by:

remove in interface Set<V>

moveAsync

public RFuture<Boolean> moveAsync(String destination,
                         V member)

Description copied from interface: RSetAsync

Move a member from this set to the given destination set in async mode.

Specified by:

moveAsync in interface RSetAsync<V>

Parameters:

destination - the destination set

member - the member to move

Returns:

true if the element is moved, false if the element is not a member of this set or no operation was performed

move

public boolean move(String destination,
           V member)

Description copied from interface: RSet

Move a member from this set to the given destination set in.

Specified by:

move in interface RSet<V>

Parameters:

destination - the destination set

member - the member to move

Returns:

true if the element is moved, false if the element is not a member of this set or no operation was performed

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<V>

Specified by:

containsAll in interface Set<V>

containsAllAsync

public RFuture<Boolean> containsAllAsync(Collection<?> c)

Description copied from interface: RCollectionAsync

Returns true if this collection contains all of the elements in the specified collection.

Specified by:

containsAllAsync in interface RCollectionAsync<V>

Parameters:

c - collection to be checked for containment in this collection

Returns:

true if this collection contains all of the elements in the specified collection

addAll

public boolean addAll(Collection<? extends V> c)

Specified by:

addAll in interface Collection<V>

Specified by:

addAll in interface Set<V>

addAllAsync

public RFuture<Boolean> addAllAsync(Collection<? extends V> c)

Specified by:

addAllAsync in interface RCollectionAsync<V>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<V>

Specified by:

retainAll in interface Set<V>

retainAllAsync

public RFuture<Boolean> retainAllAsync(Collection<?> c)

Description copied from interface: RCollectionAsync

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Specified by:

retainAllAsync in interface RCollectionAsync<V>

Parameters:

c - collection containing elements to be retained in this collection

Returns:

true if this collection changed as a result of the call

removeAllAsync

public RFuture<Boolean> removeAllAsync(Collection<?> c)

Description copied from interface: RCollectionAsync

Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Specified by:

removeAllAsync in interface RCollectionAsync<V>

Parameters:

c - collection containing elements to be removed from this collection

Returns:

true if this collection changed as a result of the call

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<V>

Specified by:

removeAll in interface Set<V>

union

public int union(String... names)

Description copied from interface: RSet

Union sets specified by name and write to current set. If current set already exists, it is overwritten.

Specified by:

union in interface RSet<V>

Parameters:

names - - name of sets

Returns:

size of union

unionAsync

public RFuture<Integer> unionAsync(String... names)

Description copied from interface: RSetAsync

Union sets specified by name and write to current set. If current set already exists, it is overwritten.

Specified by:

unionAsync in interface RSetAsync<V>

Parameters:

names - - name of sets

Returns:

size of union

readUnion

public Set<V> readUnion(String... names)

Description copied from interface: RSet

Union sets specified by name with current set without current set state change.

Specified by:

readUnion in interface RSet<V>

Parameters:

names - - name of sets

Returns:

values

readUnionAsync

public RFuture<Set<V>> readUnionAsync(String... names)

Description copied from interface: RSetAsync

Union sets specified by name with current set. Without current set state change.

Specified by:

readUnionAsync in interface RSetAsync<V>

Parameters:

names - - name of sets

Returns:

values

diff

public int diff(String... names)

Description copied from interface: RSet

Diff sets specified by name and write to current set. If current set already exists, it is overwritten.

Specified by:

diff in interface RSet<V>

Parameters:

names - - name of sets

Returns:

values

diffAsync

public RFuture<Integer> diffAsync(String... names)

Description copied from interface: RSetAsync

Diff sets specified by name and write to current set. If current set already exists, it is overwritten.

Specified by:

diffAsync in interface RSetAsync<V>

Parameters:

names - - name of sets

Returns:

size of diff

readDiff

public Set<V> readDiff(String... names)

Description copied from interface: RSet

Diff sets specified by name with current set. Without current set state change.

Specified by:

readDiff in interface RSet<V>

Parameters:

names - - name of sets

Returns:

values

readDiffAsync

public RFuture<Set<V>> readDiffAsync(String... names)

Description copied from interface: RSetAsync

Diff sets specified by name with current set. Without current set state change.

Specified by:

readDiffAsync in interface RSetAsync<V>

Parameters:

names - - name of sets

Returns:

values

intersection

public int intersection(String... names)

Description copied from interface: RSet

Intersection sets specified by name and write to current set. If current set already exists, it is overwritten.

Specified by:

intersection in interface RSet<V>

Parameters:

names - - name of sets

Returns:

size of intersection

intersectionAsync

public RFuture<Integer> intersectionAsync(String... names)

Description copied from interface: RSetAsync

Intersection sets specified by name and write to current set. If current set already exists, it is overwritten.

Specified by:

intersectionAsync in interface RSetAsync<V>

Parameters:

names - - name of sets

Returns:

size of intersection

readIntersection

public Set<V> readIntersection(String... names)

Description copied from interface: RSet

Intersection sets specified by name with current set without current set state change.

Specified by:

readIntersection in interface RSet<V>

Parameters:

names - - name of sets

Returns:

values

readIntersectionAsync

public RFuture<Set<V>> readIntersectionAsync(String... names)

Description copied from interface: RSetAsync

Intersection sets specified by name with current set. Without current set state change.

Specified by:

readIntersectionAsync in interface RSetAsync<V>

Parameters:

names - - name of sets

Returns:

values

clear

public void clear()

Specified by:

clear in interface Collection<V>

Specified by:

clear in interface Set<V>

toString

public String toString()

Overrides:

toString in class Object

expire

public boolean expire(long timeToLive,
             TimeUnit timeUnit)

Description copied from interface: RExpirable

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                           TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in seconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

clearExpireAsync

public RFuture<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public RFuture<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds