Package org.redisson

Class RedissonSetCache<V>

org.redisson.RedissonObject

org.redisson.RedissonSetCache<V>

Type Parameters:

V - value

All Implemented Interfaces:

<V>, <V>, <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, name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	add(V e)
boolean	add(V value, long ttl, unit)	Stores value with specified time to live.
boolean	<? extends V> c)
>	<? extends V> c)	Adds all elements contained in the specified collection
>	addAsync(V value)	Adds element into this collection.
>	addAsync(V value, long ttl, unit)	Stores value with specified time to live.
void	clear()
boolean	clearExpire()	Clear an expire timeout or expire date for object.
>	clearExpireAsync()	Clear an expire timeout or expire date for object in async mode.
protected >	... keys)
boolean	o)
boolean	<?> c)
>	<?> c)	Returns true if this collection contains all of the elements in the specified collection.
>	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)	Set a timeout for object.
boolean	instant)	Set an expire date for object.
>	expireAsync(long timeToLive, timeUnit)	Set a timeout for object in async mode.
protected >	expireAsync(long timeToLive, timeUnit, ... keys)
>	instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	timestamp)	Use RExpirable.expire(Instant) instead
>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected >	expireAtAsync(long timestamp, ... keys)
>	timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
RCountDownLatch	getCountDownLatch(V value)	Returns RCountDownLatch instance associated with value
RLock	getFairLock(V value)	Returns RLock instance associated with value
RLock	getLock(V value)	Returns lock instance associated with value
RPermitExpirableSemaphore	getPermitExpirableSemaphore(V value)	Returns RPermitExpirableSemaphore instance associated with value
RReadWriteLock	getReadWriteLock(V value)	Returns RReadWriteLock instance associated with value
RSemaphore	getSemaphore(V value)	Returns RSemaphore instance associated with value
boolean	isEmpty()
<V>	iterator()
<V>	iterator(int count)	Returns an iterator over elements in this set.
<V>	pattern)	Returns values iterator matches pattern.
<V>	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
<V>	readAll()	Read all elements at once
<V>>	readAllAsync()	Read all elements at once
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
boolean	value)
boolean	<?> c)
>	<?> c)	Removes all of this collection's elements that are also contained in the specified collection.
>	o)	Removes a single instance of the specified element from this collection, if it is present.
boolean	<?> c)
>	<?> c)	Retains only the elements in this collection that are contained in the specified collection.
>	name, RedisClient client, long startPos, pattern, int count)
>>	name, RedisClient client, long startPos, pattern, int count)
int	size()	Returns the number of elements in cache.
>	sizeAsync()	Returns the number of elements in cache.
<V>	stream(int count)	Returns stream of elements in this set.
<V>	pattern)	Returns stream of elements in this set matches pattern.
<V>	pattern, int count)	Returns stream of elements in this set.
[]	toArray()
<T> T[]	toArray(T[] a)
boolean	tryAdd(long ttl, unit, V... values)	Tries to add elements only if none of them in set.
boolean	tryAdd(V... values)	Tries to add elements only if none of them in set.
>	tryAddAsync(long ttl, unit, V... values)	Tries to add elements only if none of them in set.
>	tryAddAsync(V... values)	Tries to add elements only if none of them in set.

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.

, , , , , , , , , ,

Methods inherited from interface java.util.

, , ,

Methods inherited from interface java.lang.

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

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

Methods inherited from interface org.redisson.api.RObjectAsync

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

Methods inherited from interface java.util.

, ,

Constructor Detail

RedissonSetCache

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

RedissonSetCache

public RedissonSetCache(Codec codec,
                        EvictionScheduler evictionScheduler,
                        CommandAsyncExecutor commandExecutor,
                         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:

in interface <V>

Specified by:

size in interface RSetCache<V>

Specified by:

in interface <V>

Returns:

size of set

sizeAsync

public > 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:

in interface <V>

Specified by:

in interface <V>

contains

public boolean contains( o)

Specified by:

in interface <V>

Specified by:

in interface <V>

containsAsync

public > containsAsync( 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 > scanIterator( name,
                                       RedisClient client,
                                       long startPos,
                                        pattern,
                                       int count)

Specified by:

scanIterator in interface ScanIterator

scanIteratorAsync

public >> scanIteratorAsync( name,
                                                     RedisClient client,
                                                     long startPos,
                                                      pattern,
                                                     int count)

Specified by:

scanIteratorAsync in interface ScanIterator

iterator

public <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 < 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 < 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 <V> iterator()

Specified by:

in interface <V>

Specified by:

in interface <V>

Specified by:

in interface <V>

readAll

public <V> readAll()

Description copied from interface: RSetCache

Read all elements at once

Specified by:

readAll in interface RSetCache<V>

Returns:

values

readAllAsync

public <V>> readAllAsync()

Description copied from interface: RSetCacheAsync

Read all elements at once

Specified by:

readAllAsync in interface RSetCacheAsync<V>

Returns:

values

toArray

public [] toArray()

Specified by:

in interface <V>

Specified by:

in interface <V>

toArray

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

Specified by:

in interface <V>

Specified by:

in interface <V>

add

public boolean add(V e)

Specified by:

in interface <V>

Specified by:

in interface <V>

add

public boolean add(V value,
                   long ttl,
                    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 > addAsync(V value,
                                 long ttl,
                                  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.

tryAdd

public boolean tryAdd(V... values)

Description copied from interface: RSetCache

Tries to add elements only if none of them in set.

Specified by:

tryAdd in interface RSetCache<V>

Parameters:

values - - values to add

Returns:

true if elements successfully added, otherwise false.

tryAddAsync

public > tryAddAsync(V... values)

Description copied from interface: RSetCacheAsync

Tries to add elements only if none of them in set.

Specified by:

tryAddAsync in interface RSetCacheAsync<V>

Parameters:

values - - values to add

Returns:

true if elements successfully added, otherwise false.

tryAdd

public boolean tryAdd(long ttl,
                       unit,
                      V... values)

Description copied from interface: RSetCache

Tries to add elements only if none of them in set.

Specified by:

tryAdd in interface RSetCache<V>

Parameters:

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

unit - - time unit

values - - values to add

Returns:

true if elements successfully added, otherwise false.

tryAddAsync

public > tryAddAsync(long ttl,
                                     unit,
                                    V... values)

Description copied from interface: RSetCacheAsync

Tries to add elements only if none of them in set.

Specified by:

tryAddAsync in interface RSetCacheAsync<V>

Parameters:

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

unit - - time unit

values - - values to add

Returns:

true if elements successfully added, otherwise false.

addAsync

public > 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 > removeAsync( 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( value)

Specified by:

in interface <V>

Specified by:

remove in interface ScanIterator

Specified by:

in interface <V>

containsAll

public boolean containsAll(<?> c)

Specified by:

in interface <V>

Specified by:

in interface <V>

containsAllAsync

public > containsAllAsync(<?> 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(<? extends V> c)

Specified by:

in interface <V>

Specified by:

in interface <V>

addAllAsync

public > addAllAsync(<? 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(<?> c)

Specified by:

in interface <V>

Specified by:

in interface <V>

retainAllAsync

public > retainAllAsync(<?> 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 > removeAllAsync(<?> 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(<?> c)

Specified by:

in interface <V>

Specified by:

in interface <V>

clear

public void clear()

Specified by:

in interface <V>

Specified by:

in interface <V>

getPermitExpirableSemaphore

public RPermitExpirableSemaphore getPermitExpirableSemaphore(V value)

Description copied from interface: RSetCache

Returns RPermitExpirableSemaphore instance associated with value

Specified by:

getPermitExpirableSemaphore in interface RSetCache<V>

Parameters:

value - - set value

Returns:

RPermitExpirableSemaphore object

getSemaphore

public RSemaphore getSemaphore(V value)

Description copied from interface: RSetCache

Returns RSemaphore instance associated with value

Specified by:

getSemaphore in interface RSetCache<V>

Parameters:

value - - set value

Returns:

RSemaphore object

getCountDownLatch

public RCountDownLatch getCountDownLatch(V value)

Description copied from interface: RSetCache

Returns RCountDownLatch instance associated with value

Specified by:

getCountDownLatch in interface RSetCache<V>

Parameters:

value - - set value

Returns:

RCountDownLatch object

getFairLock

public RLock getFairLock(V value)

Description copied from interface: RSetCache

Returns RLock instance associated with value

Specified by:

getFairLock in interface RSetCache<V>

Parameters:

value - - set value

Returns:

RLock object

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:

RLock object

getReadWriteLock

public RReadWriteLock getReadWriteLock(V value)

Description copied from interface: RSetCache

Returns RReadWriteLock instance associated with value

Specified by:

getReadWriteLock in interface RSetCache<V>

Parameters:

value - - set value

Returns:

RReadWriteLock object

destroy

public void destroy()

Description copied from interface: RDestroyable

Destroys object when it's not necessary anymore.

Specified by:

destroy in interface RDestroyable

stream

public <V> stream(int count)

Description copied from interface: RSetCache

Returns stream of elements in this set. Elements are loaded in batch. Batch size is defined by count param.

Specified by:

stream in interface RSetCache<V>

Parameters:

count - - size of elements batch

Returns:

stream of elements

stream

public < pattern,
                        int count)

Description copied from interface: RSetCache

Returns stream of 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:

stream in interface RSetCache<V>

Parameters:

pattern - - search pattern

count - - size of elements batch

Returns:

stream of elements

stream

public < pattern)

Description copied from interface: RSetCache

Returns stream of elements in this set matches pattern.

Specified by:

stream in interface RSetCache<V>

Parameters:

pattern - - search pattern

Returns:

stream of elements

expire

public boolean expire(long timeToLive,
                       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 > expireAsync(long timeToLive,
                                     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

Use RExpirable.expire(Instant) instead

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 > expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

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

expire

public boolean expire( instant)

Description copied from interface: RExpirable

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

Specified by:

expire in interface RExpirable

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAsync

public > expireAsync( instant)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt( timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public > expireAtAsync( timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

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 > 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 > 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.

expireAsync

protected > expireAsync(long timeToLive,
                                        timeUnit,
                                       ... keys)

expireAtAsync

protected > expireAtAsync(long timestamp,
                                         ... keys)

clearExpireAsync

protected > clearExpireAsync(... keys)