Package org.redisson

Class RedissonSetCache<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonSetCache<V>

Type Parameters:

V - value

All Implemented Interfaces:

Iterable<V>, Collection<V>, Set<V>, RCollectionAsync<V>, RDestroyable, RExpirable, RExpirableAsync, RObject, RObjectAsync, RSetCache<V>, RSetCacheAsync<V>, ScanIterator

Direct Known Subclasses:

RedissonTransactionalSetCache

public class RedissonSetCache<V>
extends RedissonObject
implements RSetCache<V>, ScanIterator

Set-based cache with ability to set TTL for each entry via RSetCache.add(Object, long, TimeUnit) method.

Current Redis implementation doesn't have set entry eviction functionality. Thus values are checked for TTL expiration during any value read operation. If entry expired then it doesn't returns and clean task runs asynchronous. Clean task deletes removes 100 expired entries at once. In addition there is EvictionScheduler. This scheduler deletes expired entries in time interval between 5 seconds to 2 hours.

If eviction is not required then it's better to use RSet.

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Constructor	Description
RedissonSetCache(Codec codec, EvictionScheduler evictionScheduler, CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)
RedissonSetCache(EvictionScheduler evictionScheduler, CommandAsyncExecutor commandExecutor, String name, RedissonClient redisson)

Method Summary

Modifier and Type	Method	Description
boolean	add(V e)
boolean	add(V value, long ttl, TimeUnit unit)	Stores value with specified time to live.
boolean	addAll(Collection<? extends V> c)
RFuture<Boolean>	addAllAsync(Collection<? extends V> c)	Adds all elements contained in the specified collection
RFuture<Boolean>	addAsync(V value)	Adds element into this collection.
RFuture<Boolean>	addAsync(V value, long ttl, TimeUnit unit)	Stores value with specified time to live.
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 encoded state of the specified element.
void	destroy()	Destroys object when it's not necessary anymore.
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(long timestamp)	Set an expire date for object.
boolean	expireAt(Date timestamp)	Set an expire date for object.
RFuture<Boolean>	expireAtAsync(long timestamp)	Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(Date timestamp)	Set an expire date for object in async mode.
RLock	getLock(V value)	Returns lock instance associated with value
String	getLockName(Object value)
boolean	isEmpty()
Iterator<V>	iterator()
Iterator<V>	iterator(int count)	Returns an iterator over elements in this set.
Iterator<V>	iterator(String pattern)	Returns values iterator matches pattern.
Iterator<V>	iterator(String pattern, int count)	Returns an iterator over elements in this set.
<KOut,VOut> RCollectionMapReduce<V,KOut,VOut>	mapReduce()	Returns RMapReduce object associated with this map
Set<V>	readAll()	Read all elements at once
RFuture<Set<V>>	readAllAsync()	Read all elements at once
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
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.
RFuture<Boolean>	removeAsync(Object o)	Removes a single instance of the specified element from this collection, if it is present.
boolean	retainAll(Collection<?> c)
RFuture<Boolean>	retainAllAsync(Collection<?> c)	Retains only the elements in this collection that are contained in the specified collection.
ListScanResult<Object>	scanIterator(String name, RedisClient client, long startPos, String pattern, int count)
RFuture<ListScanResult<Object>>	scanIteratorAsync(String name, RedisClient client, long startPos, String pattern, int count)
int	size()	Returns the number of elements in cache.
RFuture<Integer>	sizeAsync()	Returns the number of elements in cache.
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class org.redisson.RedissonObject

await, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

copy, delete, dump, getCodec, getName, isExists, migrate, move, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Constructor Detail

RedissonSetCache

public RedissonSetCache(EvictionScheduler evictionScheduler,
                        CommandAsyncExecutor commandExecutor,
                        String name,
                        RedissonClient redisson)

RedissonSetCache

public RedissonSetCache(Codec codec,
                        EvictionScheduler evictionScheduler,
                        CommandAsyncExecutor commandExecutor,
                        String name,
                        RedissonClient redisson)

Method Detail

mapReduce

public <KOut,VOut> RCollectionMapReduce<V,KOut,VOut> mapReduce()

Description copied from interface: RSetCache

Returns RMapReduce object associated with this map

Specified by:

mapReduce in interface RSetCache<V>

Type Parameters:

KOut - output key

VOut - output value

Returns:

MapReduce instance

size

public int size()

Description copied from interface: RSetCache

Returns the number of elements in cache. This number can reflects expired elements too due to non realtime cleanup process.

Specified by:

size in interface Collection<V>

Specified by:

size in interface RSetCache<V>

Specified by:

size in interface Set<V>

Returns:

size of set

sizeAsync

public RFuture<Integer> sizeAsync()

Description copied from interface: RSetCacheAsync

Returns the number of elements in cache. This number can reflects expired elements too due to non realtime cleanup process.

Specified by:

sizeAsync in interface RCollectionAsync<V>

Specified by:

sizeAsync in interface RSetCacheAsync<V>

Returns:

size of set

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 encoded state of the specified element.

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 and false otherwise

scanIterator

public ListScanResult<Object> scanIterator(String name,
                                           RedisClient client,
                                           long startPos,
                                           String pattern,
                                           int count)

Specified by:

scanIterator in interface ScanIterator

scanIteratorAsync

public RFuture<ListScanResult<Object>> scanIteratorAsync(String name,
                                                         RedisClient client,
                                                         long startPos,
                                                         String pattern,
                                                         int count)

Specified by:

scanIteratorAsync in interface ScanIterator

iterator

public Iterator<V> iterator(int count)

Description copied from interface: RSetCache

Returns an iterator over elements in this set. Elements are loaded in batch. Batch size is defined by count param.

Specified by:

iterator in interface RSetCache<V>

Parameters:

count - - size of elements batch

Returns:

iterator

iterator

public Iterator<V> iterator(String pattern)

Description copied from interface: RSetCache

Returns values iterator matches pattern.

Specified by:

iterator in interface RSetCache<V>

Parameters:

pattern - - search pattern

Returns:

iterator

iterator

public Iterator<V> iterator(String pattern,
                            int count)

Description copied from interface: RSetCache

Returns an iterator over elements in this set. Elements are loaded in batch. Batch size is defined by count param. If pattern is not null then only elements match this pattern are loaded.

Specified by:

iterator in interface RSetCache<V>

Parameters:

pattern - - search pattern

count - - size of elements batch

Returns:

iterator

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Collection<V>

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Set<V>

readAll

public Set<V> readAll()

Description copied from interface: RSetCache

Read all elements at once

Specified by:

readAll in interface RSetCache<V>

Returns:

values

readAllAsync

public RFuture<Set<V>> readAllAsync()

Description copied from interface: RSetCacheAsync

Read all elements at once

Specified by:

readAllAsync in interface RSetCacheAsync<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>

add

public boolean add(V value,
                   long ttl,
                   TimeUnit unit)

Description copied from interface: RSetCache

Stores value with specified time to live. Value expires after specified time to live.

Specified by:

add in interface RSetCache<V>

Parameters:

value - to add

ttl - - time to live for key\value entry. If 0 then stores infinitely.

unit - - time unit

Returns:

true if value has been added. false if value already been in collection.

addAsync

public RFuture<Boolean> addAsync(V value,
                                 long ttl,
                                 TimeUnit unit)

Description copied from interface: RSetCacheAsync

Stores value with specified time to live. Value expires after specified time to live.

Specified by:

addAsync in interface RSetCacheAsync<V>

Parameters:

value - to add

ttl - - time to live for key\value entry. If 0 then stores infinitely.

unit - - time unit

Returns:

true if value has been added. false if value already been in collection.

addAsync

public RFuture<Boolean> addAsync(V value)

Description copied from interface: RCollectionAsync

Adds element into this collection.

Specified by:

addAsync in interface RCollectionAsync<V>

Parameters:

value - - element to add

Returns:

true if an element was added and false if it is already present

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.

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 ScanIterator

Specified by:

remove in interface Set<V>

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)

Description copied from interface: RCollectionAsync

Adds all elements contained in the specified collection

Specified by:

addAllAsync in interface RCollectionAsync<V>

Parameters:

c - - collection of elements to add

Returns:

true if at least one element was added and false if all elements are already present

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.

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.

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>

clear

public void clear()

Specified by:

clear in interface Collection<V>

Specified by:

clear in interface Set<V>

getLockName

public String getLockName(Object value)

getLock

public RLock getLock(V value)

Description copied from interface: RSetCache

Returns lock instance associated with value

Specified by:

getLock in interface RSetCache<V>

Parameters:

value - - set value

Returns:

lock

destroy

public void destroy()

Description copied from interface: RDestroyable

Destroys object when it's not necessary anymore.

Specified by:

destroy in interface RDestroyable

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 milliseconds (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

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

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