org.redisson

Class RedissonSetMultimapCache<K,V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonMultimap<K,V>

org.redisson.RedissonSetMultimap<K,V>

org.redisson.RedissonSetMultimapCache<K,V>

Type Parameters:

K - key

V - value

All Implemented Interfaces:

RExpirable, RExpirableAsync, RMultimap<K,V>, RMultimapAsync<K,V>, RMultimapCache<K,V>, RMultimapCacheAsync<K,V>, RObject, RObjectAsync, RSetMultimap<K,V>, RSetMultimapCache<K,V>

public class RedissonSetMultimapCache<K,V>
extends RedissonSetMultimap<K,V>
implements RSetMultimapCache<K,V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Method Summary

Modifier and Type	Method and 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.
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) 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.
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.
RSet<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	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 size of object in Redis memory

Methods inherited from class org.redisson.RedissonSetMultimap

entries, getAll, putAllAsync, putAsync, removeAll, removeAsync, replaceValues, replaceValuesAsync, sizeAsync

Methods inherited from class org.redisson.RedissonMultimap

clear, containsEntry, containsKey, containsValue, fastRemove, fastRemoveAsync, fastRemoveAsync, getLock, getReadWriteLock, hash, isEmpty, keyHash, keySet, keySize, keySizeAsync, put, putAll, readAllKeySet, readAllKeySetAsync, remove, size, values

Methods inherited from class org.redisson.RedissonObject

await, copy, copyAsync, delete, 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, 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.RSetMultimap

entries, getAll, removeAll, replaceValues

Methods inherited from interface org.redisson.api.RMultimap

clear, containsEntry, containsKey, containsValue, fastRemove, getLock, getReadWriteLock, isEmpty, keySet, keySize, put, putAll, readAllKeySet, remove, size, values

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

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

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

Methods inherited from interface org.redisson.api.RExpirableAsync

expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

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

Method Detail

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 RedissonSetMultimap<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 RedissonSetMultimap<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 RedissonSetMultimap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if contains an entry

get

public RSet<V> get(K key)

Description copied from interface: RSetMultimap

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 RSetMultiMap has unique values for a given key, this method returns a Set, instead of the Collection specified in the RMultimap interface.

Specified by:

get in interface RMultimap<K,V>

Specified by:

get in interface RSetMultimap<K,V>

Overrides:

get in class RedissonSetMultimap<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 RedissonSetMultimap<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 RedissonSetMultimap<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 size of object in Redis memory

Specified by:

sizeInMemoryAsync in interface RObjectAsync

Overrides:

sizeInMemoryAsync in class RedissonObject

Returns:

size of object

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)

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

Overrides:

expireAsync in class RedissonMultimap<K,V>

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

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

Overrides:

expireAtAsync in class RedissonMultimap<K,V>

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

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

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

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

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

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.