Package org.redisson

Class RedissonSetMultimap<K,V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonMultimap<K,V>

org.redisson.RedissonSetMultimap<K,V>

Type Parameters:

K - key

V - value

All Implemented Interfaces:

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

Direct Known Subclasses:

RedissonSetMultimapCache

public class RedissonSetMultimap<K,V>
extends RedissonMultimap<K,V>
implements RSetMultimap<K,V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Constructor	Description
RedissonSetMultimap(Codec codec, CommandAsyncExecutor connectionManager, String name)
RedissonSetMultimap(CommandAsyncExecutor connectionManager, String name)

Method Summary

Modifier and Type	Method	Description
boolean	clearExpire()	Clear an expire timeout or expire date for object.
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.
Set<Map.Entry<K,V>>	entries()	Returns a view collection of all key-value pairs contained in this multimap, as Map.Entry instances.
boolean	expire(long timeToLive, TimeUnit timeUnit)	Set a timeout for object.
boolean	expireAt(long timestamp)	Set an expire date for object.
boolean	expireAt(Date timestamp)	Set an expire date for object.
RFuture<Boolean>	expireAtAsync(Date timestamp)	Set an expire date for object in async mode.
RSet<V>	get(K key)	Returns a view collection of the values associated with key in this multimap, if any.
Set<V>	getAll(K key)	Returns all elements at once.
RFuture<Collection<V>>	getAllAsync(K key)
RFuture<Boolean>	putAllAsync(K key, Iterable<? extends V> values)	Stores a key-value pair in this multimap for each of values, all using the same key, key.
RFuture<Boolean>	putAsync(K key, V value)	Stores a key-value pair in this multimap.
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
Set<V>	removeAll(Object key)	Removes all values associated with the key key.
RFuture<Collection<V>>	removeAllAsync(Object key)	Removes all values associated with the key key.
RFuture<Boolean>	removeAsync(Object key, Object value)	Removes a single key-value pair with the key key and the value value from this multimap, if such exists.
Set<V>	replaceValues(K key, Iterable<? extends V> values)	Stores a collection of values with the same key, replacing any existing values for that key.
RFuture<Collection<V>>	replaceValuesAsync(K key, Iterable<? extends V> values)	Stores a collection of values with the same key, replacing any existing values for that key.
RFuture<Integer>	sizeAsync()	Returns the number of key-value pairs in this multimap.

Methods inherited from class org.redisson.RedissonMultimap

clear, clearExpireAsync, containsEntry, containsKey, containsValue, deleteAsync, expireAsync, expireAtAsync, fastRemove, fastRemoveAsync, fastRemoveAsync, getLock, getReadWriteLock, hash, hashAndRelease, isEmpty, 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, 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 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.RMultimap

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

Methods inherited from interface org.redisson.api.RMultimapAsync

fastRemoveAsync, keySizeAsync, readAllKeySetAsync

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

Constructor Detail

RedissonSetMultimap

public RedissonSetMultimap(CommandAsyncExecutor connectionManager,
                           String name)

RedissonSetMultimap

public RedissonSetMultimap(Codec codec,
                           CommandAsyncExecutor connectionManager,
                           String name)

Method Detail

sizeAsync

public RFuture<Integer> sizeAsync()

Description copied from interface: RMultimapAsync

Returns the number of key-value pairs in this multimap.

Specified by:

sizeAsync in interface RMultimapAsync<K,V>

Returns:

size of multimap

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>

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>

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>

Parameters:

key - - map key

value - - map value

Returns:

true if contains an entry

putAsync

public RFuture<Boolean> putAsync(K key,
                                 V value)

Description copied from interface: RMultimapAsync

Stores a key-value pair in this multimap.

Some multimap implementations allow duplicate key-value pairs, in which case put always adds a new key-value pair and increases the multimap size by 1. Other implementations prohibit duplicates, and storing a key-value pair that's already in the multimap has no effect.

Specified by:

putAsync in interface RMultimapAsync<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if the method increased the size of the multimap, or false if the multimap already contained the key-value pair and doesn't allow duplicates

removeAsync

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

Description copied from interface: RMultimapAsync

Removes a single key-value pair with the key key and the value value from this multimap, if such exists. If multiple key-value pairs in the multimap fit this description, which one is removed is unspecified.

Specified by:

removeAsync in interface RMultimapAsync<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if the multimap changed

putAllAsync

public RFuture<Boolean> putAllAsync(K key,
                                    Iterable<? extends V> values)

Description copied from interface: RMultimapAsync

Stores a key-value pair in this multimap for each of values, all using the same key, key. Equivalent to (but expected to be more efficient than):

   

   for (V value : values) {
     put(key, value);
   }

In particular, this is a no-op if values is empty.

Specified by:

putAllAsync in interface RMultimapAsync<K,V>

Parameters:

key - - map key

values - - map values

Returns:

true if the multimap changed

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>

Parameters:

key - - map key

Returns:

collection of values

getAll

public Set<V> getAll(K key)

Description copied from interface: RMultimap

Returns all elements at once. Result collection is NOT backed by map, so changes are not reflected in map.

Specified by:

getAll in interface RMultimap<K,V>

Specified by:

getAll in interface RSetMultimap<K,V>

Overrides:

getAll in class RedissonMultimap<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>

removeAll

public Set<V> removeAll(Object key)

Description copied from interface: RMultimap

Removes all values associated with the key key.

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

Use RMultimap.fastRemove(K...) if values are not needed.

Specified by:

removeAll in interface RMultimap<K,V>

Specified by:

removeAll in interface RSetMultimap<K,V>

Overrides:

removeAll in class RedissonMultimap<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.

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>

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.

entries

public Set<Map.Entry<K,V>> entries()

Description copied from interface: RMultimap

Returns a view collection of all key-value pairs contained in this multimap, as Map.Entry instances.

Changes to the returned collection or the entries it contains will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.

Specified by:

entries in interface RMultimap<K,V>

Specified by:

entries in interface RSetMultimap<K,V>

Overrides:

entries in class RedissonMultimap<K,V>

Returns:

collection of entries

replaceValues

public Set<V> replaceValues(K key,
                            Iterable<? extends V> values)

Description copied from interface: RMultimap

Stores a collection of values with the same key, replacing any existing values for that key.

If values is empty, this is equivalent to removeAll(key).

Specified by:

replaceValues in interface RMultimap<K,V>

Specified by:

replaceValues in interface RSetMultimap<K,V>

Overrides:

replaceValues in class RedissonMultimap<K,V>

Parameters:

key - - map key

values - - map values

Returns:

the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.

replaceValuesAsync

public RFuture<Collection<V>> replaceValuesAsync(K key,
                                                 Iterable<? extends V> values)

Description copied from interface: RMultimapAsync

Stores a collection of values with the same key, replacing any existing values for that key.

If values is empty, this is equivalent to RMultimapAsync.removeAllAsync(Object).

Specified by:

replaceValuesAsync in interface RMultimapAsync<K,V>

Parameters:

key - - map key

values - - map values

Returns:

the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.

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.