Package org.redisson

Class RedissonListMultimapCache<K,V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonMultimap<K,V>

org.redisson.RedissonListMultimap<K,V>

org.redisson.RedissonListMultimapCache<K,V>

Type Parameters:

K - key

V - value

All Implemented Interfaces:

RExpirable, RExpirableAsync, RListMultimap<K,V>, RListMultimapCache<K,V>, RMultimap<K,V>, RMultimapAsync<K,V>, RMultimapCache<K,V>, RMultimapCacheAsync<K,V>, RObject, RObjectAsync

public class RedissonListMultimapCache<K,V>
extends RedissonListMultimap<K,V>
implements RListMultimapCache<K,V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonListMultimapCache(EvictionScheduler evictionScheduler, Codec codec, CommandAsyncExecutor connectionManager, String name)
RedissonListMultimapCache(EvictionScheduler evictionScheduler, CommandAsyncExecutor connectionManager, String name)

Method Summary

Modifier and Type	Method	Description
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.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
RFuture<Boolean>	containsEntryAsync(Object key, Object value)	Returns true if this multimap contains at least one key-value pair with the key key and the value value.
RFuture<Boolean>	containsKeyAsync(Object key)	Returns true if this multimap contains at least one key-value pair with the key key.
RFuture<Boolean>	containsValueAsync(Object value)	Returns true if this multimap contains at least one key-value pair with the value value.
RFuture<Boolean>	deleteAsync()	Delete object in async mode
boolean	expire(long timeToLive, TimeUnit timeUnit)	Use RExpirable.expire(Duration) instead
boolean	expire(Duration duration)	Sets a timeout for this object.
boolean	expire(Instant instant)	Sets an expiration date for this object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Use RExpirableAsync.expireAsync(Duration) instead
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)
RFuture<Boolean>	expireAsync(Duration duration)	Set a timeout for object.
RFuture<Boolean>	expireAsync(Instant instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	expireAt(Date timestamp)	Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected RFuture<Boolean>	expireAtAsync(long timestamp, String param, String... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
boolean	expireIfGreater(Duration duration)	Sets a timeout for this object only if it's greater than timeout set before.
boolean	expireIfGreater(Instant time)	Sets an expiration date for this object only if it's greater than expiration date set before.
RFuture<Boolean>	expireIfGreaterAsync(Duration duration)
RFuture<Boolean>	expireIfGreaterAsync(Instant time)
boolean	expireIfLess(Duration duration)	Sets a timeout for this object only if it's less than timeout set before.
boolean	expireIfLess(Instant time)	Sets an expiration date for this object only if it's less than expiration date set before.
RFuture<Boolean>	expireIfLessAsync(Duration duration)
RFuture<Boolean>	expireIfLessAsync(Instant time)
boolean	expireIfNotSet(Duration duration)	Sets a timeout for this object only if it hasn't been set before.
boolean	expireIfNotSet(Instant time)	Sets an expiration date for this object only if it hasn't been set before.
RFuture<Boolean>	expireIfNotSetAsync(Duration duration)
RFuture<Boolean>	expireIfNotSetAsync(Instant time)
boolean	expireIfSet(Duration duration)	Sets a timeout for this object only if it has been already set.
boolean	expireIfSet(Instant time)	Sets an expiration date for this object only if it has been already set.
RFuture<Boolean>	expireIfSetAsync(Duration duration)
RFuture<Boolean>	expireIfSetAsync(Instant time)
boolean	expireKey(K key, long timeToLive, TimeUnit timeUnit)	Set a timeout for key.
RFuture<Boolean>	expireKeyAsync(K key, long timeToLive, TimeUnit timeUnit)	Set a timeout for key in async mode.
RList<V>	get(K key)	Returns a view collection of the values associated with key in this multimap, if any.
RFuture<Collection<V>>	getAllAsync(K key)
long	getExpireTime()	Expiration time of Redisson object that has a timeout
RFuture<Long>	getExpireTimeAsync()	Expiration time of Redisson object that has a timeout
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
RFuture<Collection<V>>	removeAllAsync(Object key)	Removes all values associated with the key key.
RFuture<Long>	sizeInMemoryAsync()	Returns bytes amount used by object in Redis memory.

Methods inherited from class org.redisson.RedissonListMultimap

containsEntry, getAll, put, putAllAsync, putAsync, removeAll, removeAsync, replaceValues, replaceValuesAsync, sizeAsync

Methods inherited from class org.redisson.RedissonMultimap

clear, containsKey, containsValue, entries, fastRemove, fastRemoveAsync, fastRemoveAsync, getCountDownLatch, getFairLock, getLock, getPermitExpirableSemaphore, getReadWriteLock, getSemaphore, hash, isEmpty, keyHash, keySet, keySize, keySizeAsync, putAll, readAllKeySet, readAllKeySetAsync, remove, renameAsync, renamenxAsync, size, values

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, 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, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, 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 org.redisson.api.RExpirable

clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RListMultimap

getAll, removeAll, replaceValues

Methods inherited from interface org.redisson.api.RMultimap

clear, containsEntry, containsKey, containsValue, entries, fastRemove, getCountDownLatch, getFairLock, getLock, getPermitExpirableSemaphore, getReadWriteLock, getSemaphore, isEmpty, keySet, keySize, put, putAll, readAllKeySet, remove, size, values

Methods inherited from interface org.redisson.api.RMultimapAsync

fastRemoveAsync, keySizeAsync, putAllAsync, putAsync, readAllKeySetAsync, removeAsync, replaceValuesAsync, sizeAsync

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, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Constructor Details

RedissonListMultimapCache

public RedissonListMultimapCache(EvictionScheduler evictionScheduler,
 CommandAsyncExecutor connectionManager,
 String name)

RedissonListMultimapCache

public RedissonListMultimapCache(EvictionScheduler evictionScheduler,
 Codec codec,
 CommandAsyncExecutor connectionManager,
 String name)

Method Details

containsKeyAsync

public RFuture<Boolean> containsKeyAsync(Object key)

Description copied from interface: RMultimapAsync

Returns true if this multimap contains at least one key-value pair with the key key.

Specified by:

containsKeyAsync in interface RMultimapAsync<K,V>

Overrides:

containsKeyAsync in class RedissonListMultimap<K,V>

Parameters:

key - - map key

Returns:

true if contains a key

containsValueAsync

public RFuture<Boolean> containsValueAsync(Object value)

Description copied from interface: RMultimapAsync

Returns true if this multimap contains at least one key-value pair with the value value.

Specified by:

containsValueAsync in interface RMultimapAsync<K,V>

Overrides:

containsValueAsync in class RedissonListMultimap<K,V>

Parameters:

value - - map value

Returns:

true if contains a value

containsEntryAsync

public RFuture<Boolean> containsEntryAsync(Object key,
 Object value)

Description copied from interface: RMultimapAsync

Returns true if this multimap contains at least one key-value pair with the key key and the value value.

Specified by:

containsEntryAsync in interface RMultimapAsync<K,V>

Overrides:

containsEntryAsync in class RedissonListMultimap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if contains an entry

get

public RList<V> get(K key)

Description copied from interface: RListMultimap

Returns a view collection of the values associated with key in this multimap, if any. Note that when containsKey(key) is false, this returns an empty collection, not null.

Changes to the returned collection will update the underlying multimap, and vice versa.

Because a RListMultimap may has duplicates among values mapped by key and stores insertion order method returns a List, instead of the Collection specified in the RMultimap interface.

Specified by:

get in interface RListMultimap<K,V>

Specified by:

get in interface RMultimap<K,V>

Overrides:

get in class RedissonListMultimap<K,V>

Parameters:

key - - map key

Returns:

collection of values

getAllAsync

public RFuture<Collection<V>> getAllAsync(K key)

Specified by:

getAllAsync in interface RMultimapAsync<K,V>

Overrides:

getAllAsync in class RedissonListMultimap<K,V>

removeAllAsync

public RFuture<Collection<V>> removeAllAsync(Object key)

Description copied from interface: RMultimapAsync

Removes all values associated with the key key.

Once this method returns, key will not be mapped to any values.

Specified by:

removeAllAsync in interface RMultimapAsync<K,V>

Overrides:

removeAllAsync in class RedissonListMultimap<K,V>

Parameters:

key - - map key

Returns:

the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.

expireKey

public boolean expireKey(K key,
 long timeToLive,
 TimeUnit timeUnit)

Description copied from interface: RMultimapCache

Set a timeout for key. After the timeout has expired, the key and its values will automatically be deleted.

Specified by:

expireKey in interface RMultimapCache<K,V>

Parameters:

key - - map key

timeToLive - - timeout before key will be deleted

timeUnit - - timeout time unit

Returns:

true if key exists and the timeout was set and false if key not exists

expireKeyAsync

public RFuture<Boolean> expireKeyAsync(K key,
 long timeToLive,
 TimeUnit timeUnit)

Description copied from interface: RMultimapCacheAsync

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

Specified by:

expireKeyAsync in interface RMultimapCacheAsync<K,V>

Parameters:

key - - map key

timeToLive - - timeout before key will be deleted

timeUnit - - timeout time unit

Returns:

true if key exists and the timeout was set and false if key not exists

sizeInMemoryAsync

public RFuture<Long> sizeInMemoryAsync()

Description copied from interface: RObjectAsync

Returns bytes amount used by object in Redis memory.

Specified by:

sizeInMemoryAsync in interface RObjectAsync

Overrides:

sizeInMemoryAsync in class RedissonMultimap<K,V>

Returns:

size in bytes

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonMultimap<K,V>

Returns:

true if object was deleted false if not

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
 TimeUnit timeUnit,
 String param,
 String... keys)

Overrides:

expireAsync in class RedissonMultimap<K,V>

expireAtAsync

protected RFuture<Boolean> expireAtAsync(long timestamp,
 String param,
 String... keys)

Overrides:

expireAtAsync in class RedissonMultimap<K,V>

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

Overrides:

clearExpireAsync in class RedissonMultimap<K,V>

Returns:

true if the timeout was cleared and false if not

expire

public boolean expire(long timeToLive,
 TimeUnit timeUnit)

Description copied from interface: RExpirable

Use RExpirable.expire(Duration) instead

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

Use RExpirableAsync.expireAsync(Duration) instead

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 RFuture<Boolean> 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 instant)

Description copied from interface: RExpirable

Sets an expiration date for this 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

expireIfSet

public boolean expireIfSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Instant time)

Specified by:

expireIfSetAsync in interface RExpirableAsync

expireIfNotSet

public boolean expireIfNotSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Instant time)

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

expireIfGreater

public boolean expireIfGreater(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Instant time)

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

expireIfLess

public boolean expireIfLess(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Instant time)

Specified by:

expireIfLessAsync in interface RExpirableAsync

expireAsync

public RFuture<Boolean> expireAsync(Instant 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

expire

public boolean expire(Duration duration)

Description copied from interface: RExpirable

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

Specified by:

expire in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Duration duration)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date 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 RFuture<Boolean> expireAtAsync(Date 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

expireIfSet

public boolean expireIfSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Duration duration)

Specified by:

expireIfSetAsync in interface RExpirableAsync

expireIfNotSet

public boolean expireIfNotSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Duration duration)

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

expireIfGreater

public boolean expireIfGreater(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Duration duration)

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

expireIfLess

public boolean expireIfLess(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Duration duration)

Specified by:

expireIfLessAsync in interface RExpirableAsync

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

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.

getExpireTime

public long getExpireTime()

Description copied from interface: RExpirable

Expiration time of Redisson object that has a timeout

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTime in interface RExpirable

Returns:

expiration time

getExpireTimeAsync

public RFuture<Long> getExpireTimeAsync()

Description copied from interface: RExpirableAsync

Expiration time of Redisson object that has a timeout

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTimeAsync in interface RExpirableAsync

Returns:

expiration time

clearExpireAsync

protected RFuture<Boolean> clearExpireAsync(String... keys)