org.redisson.reactive

Class RedissonSetMultimapReactive<K,V>

java.lang.Object

org.redisson.reactive.RedissonSetMultimapReactive<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

RExpirableReactive, RMultimapReactive<K,V>, RObjectReactive, RSetMultimapReactive<K,V>

public class RedissonSetMultimapReactive<K,V>
extends Object
implements RSetMultimapReactive<K,V>

Author:

Nikita Koksharov

Field Summary

Fields

Modifier and Type	Field and Description
protected RMultimap<K,V>	instance

Constructor Summary

Constructors

Constructor and Description
RedissonSetMultimapReactive(UUID id, Codec codec, CommandReactiveExecutor commandExecutor, String name)
RedissonSetMultimapReactive(UUID id, CommandReactiveExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Boolean>	clearExpire() Clear an expire timeout or expire date for object in mode.
org.reactivestreams.Publisher<Boolean>	containsEntry(Object key, Object value) Returns true if this multimap contains at least one key-value pair with the key key and the value value.
org.reactivestreams.Publisher<Boolean>	containsKey(Object key) Returns true if this multimap contains at least one key-value pair with the key key.
org.reactivestreams.Publisher<Boolean>	containsValue(Object value) Returns true if this multimap contains at least one key-value pair with the value value.
org.reactivestreams.Publisher<Boolean>	delete() Delete object in mode
protected void	encode(Collection<Object> params, Collection<?> values)
protected io.netty.buffer.ByteBuf	encode(Object value)
protected io.netty.buffer.ByteBuf	encodeMapKey(Object value)
protected io.netty.buffer.ByteBuf	encodeMapValue(Object value)
org.reactivestreams.Publisher<Boolean>	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object in mode.
org.reactivestreams.Publisher<Boolean>	expireAt(Date timestamp) Set an expire date for object in mode.
org.reactivestreams.Publisher<Boolean>	expireAt(long timestamp) Set an expire date for object in mode.
org.reactivestreams.Publisher<Long>	fastRemove(K... keys) Removes keys from map by one operation Works faster than RMultimap.remove but not returning the value associated with key
RSetReactive<V>	get(K key) Returns a view Set of the values associated with key in this multimap, if any.
org.reactivestreams.Publisher<Set<V>>	getAll(K key) Returns all elements at once.
Codec	getCodec()
String	getName()
org.reactivestreams.Publisher<Boolean>	isExists() Check object existence
org.reactivestreams.Publisher<Integer>	keySize() Returns the number of key-value pairs in this multimap.
org.reactivestreams.Publisher<Void>	migrate(String host, int port, int database, long timeout) Transfer a object from a source Redis instance to a destination Redis instance in mode
org.reactivestreams.Publisher<Boolean>	move(int database) Move object to another database in mode
protected <V> reactor.core.publisher.Mono<V>	newSucceeded(V result)
org.reactivestreams.Publisher<Boolean>	put(K key, V value) Stores a key-value pair in this multimap.
org.reactivestreams.Publisher<Boolean>	putAll(K key, Iterable<? extends V> values) Stores a key-value pair in this multimap for each of values, all using the same key, key.
<R> org.reactivestreams.Publisher<R>	reactive(Supplier<RFuture<R>> supplier)
org.reactivestreams.Publisher<Set<K>>	readAllKeySet() Read all keys at once
org.reactivestreams.Publisher<Long>	remainTimeToLive() Get remaining time to live of object in milliseconds.
org.reactivestreams.Publisher<Boolean>	remove(Object key, Object value) Removes a single key-value pair with the key key and the value value from this multimap, if such exists.
org.reactivestreams.Publisher<Set<V>>	removeAll(Object key) Removes all values associated with the key key.
org.reactivestreams.Publisher<Void>	rename(String newName) Rename current object key to newName in mode
org.reactivestreams.Publisher<Boolean>	renamenx(String newName) Rename current object key to newName in mode only if new key is not exists
org.reactivestreams.Publisher<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.
org.reactivestreams.Publisher<Integer>	size() Returns the number of key-value pairs in this multimap.

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

containsEntry, containsKey, containsValue, fastRemove, keySize, put, putAll, readAllKeySet, remove, size

Methods inherited from interface org.redisson.api.RExpirableReactive

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObjectReactive

delete, getCodec, getName, isExists, migrate, move, rename, renamenx

Field Detail

instance

protected final RMultimap<K,V> instance

Constructor Detail

RedissonSetMultimapReactive

public RedissonSetMultimapReactive(UUID id,
                                   CommandReactiveExecutor commandExecutor,
                                   String name)

RedissonSetMultimapReactive

public RedissonSetMultimapReactive(UUID id,
                                   Codec codec,
                                   CommandReactiveExecutor commandExecutor,
                                   String name)

Method Detail

get

public RSetReactive<V> get(K key)

Description copied from interface: RSetMultimapReactive

Returns a view Set 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.

Specified by:

get in interface RSetMultimapReactive<K,V>

Parameters:

key - - map key

Returns:

set of values

getAll

public org.reactivestreams.Publisher<Set<V>> getAll(K key)

Description copied from interface: RSetMultimapReactive

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

Specified by:

getAll in interface RSetMultimapReactive<K,V>

Parameters:

key - - map key

Returns:

set of values

removeAll

public org.reactivestreams.Publisher<Set<V>> removeAll(Object key)

Description copied from interface: RSetMultimapReactive

Removes all values associated with the key key.

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

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

Specified by:

removeAll in interface RSetMultimapReactive<K,V>

Parameters:

key - - map key

Returns:

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

replaceValues

public org.reactivestreams.Publisher<Set<V>> replaceValues(K key,
                                                           Iterable<? extends V> values)

Description copied from interface: RSetMultimapReactive

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

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

Specified by:

replaceValues in interface RSetMultimapReactive<K,V>

Parameters:

key - - map key

values - - map values

Returns:

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

size

public org.reactivestreams.Publisher<Integer> size()

Description copied from interface: RMultimapReactive

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

Specified by:

size in interface RMultimapReactive<K,V>

Returns:

size of multimap

containsKey

public org.reactivestreams.Publisher<Boolean> containsKey(Object key)

Description copied from interface: RMultimapReactive

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

Specified by:

containsKey in interface RMultimapReactive<K,V>

Parameters:

key - - map key

Returns:

true if contains a key

containsValue

public org.reactivestreams.Publisher<Boolean> containsValue(Object value)

Description copied from interface: RMultimapReactive

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

Specified by:

containsValue in interface RMultimapReactive<K,V>

Parameters:

value - - map value

Returns:

true if contains a value

containsEntry

public org.reactivestreams.Publisher<Boolean> containsEntry(Object key,
                                                            Object value)

Description copied from interface: RMultimapReactive

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

Specified by:

containsEntry in interface RMultimapReactive<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if contains an entry

put

public org.reactivestreams.Publisher<Boolean> put(K key,
                                                  V value)

Description copied from interface: RMultimapReactive

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:

put in interface RMultimapReactive<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

remove

public org.reactivestreams.Publisher<Boolean> remove(Object key,
                                                     Object value)

Description copied from interface: RMultimapReactive

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:

remove in interface RMultimapReactive<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if the multimap changed

putAll

public org.reactivestreams.Publisher<Boolean> putAll(K key,
                                                     Iterable<? extends V> values)

Description copied from interface: RMultimapReactive

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:

putAll in interface RMultimapReactive<K,V>

Parameters:

key - - map key

values - - map values

Returns:

true if the multimap changed

keySize

public org.reactivestreams.Publisher<Integer> keySize()

Description copied from interface: RMultimapReactive

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

Specified by:

keySize in interface RMultimapReactive<K,V>

Returns:

keys amount

fastRemove

public org.reactivestreams.Publisher<Long> fastRemove(K... keys)

Description copied from interface: RMultimapReactive

Removes keys from map by one operation Works faster than RMultimap.remove but not returning the value associated with key

Specified by:

fastRemove in interface RMultimapReactive<K,V>

Parameters:

keys - - map keys

Returns:

the number of keys that were removed from the hash, not including specified but non existing keys

readAllKeySet

public org.reactivestreams.Publisher<Set<K>> readAllKeySet()

Description copied from interface: RMultimapReactive

Read all keys at once

Specified by:

readAllKeySet in interface RMultimapReactive<K,V>

Returns:

keys

delete

public org.reactivestreams.Publisher<Boolean> delete()

Description copied from interface: RObjectReactive

Delete object in mode

Specified by:

delete in interface RObjectReactive

Returns:

true if object was deleted false if not

expire

public org.reactivestreams.Publisher<Boolean> expire(long timeToLive,
                                                     TimeUnit timeUnit)

Description copied from interface: RExpirableReactive

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

Specified by:

expire in interface RExpirableReactive

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 org.reactivestreams.Publisher<Boolean> expireAt(long timestamp)

Description copied from interface: RExpirableReactive

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

Specified by:

expireAt in interface RExpirableReactive

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

clearExpire

public org.reactivestreams.Publisher<Boolean> clearExpire()

Description copied from interface: RExpirableReactive

Clear an expire timeout or expire date for object in mode. Object will not be deleted.

Specified by:

clearExpire in interface RExpirableReactive

Returns:

true if the timeout was cleared and false if not

expireAt

public org.reactivestreams.Publisher<Boolean> expireAt(Date timestamp)

Description copied from interface: RExpirableReactive

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

Specified by:

expireAt in interface RExpirableReactive

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

remainTimeToLive

public org.reactivestreams.Publisher<Long> remainTimeToLive()

Description copied from interface: RExpirableReactive

Get remaining time to live of object in milliseconds.

Specified by:

remainTimeToLive in interface RExpirableReactive

Returns:

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

reactive

public <R> org.reactivestreams.Publisher<R> reactive(Supplier<RFuture<R>> supplier)

newSucceeded

protected <V> reactor.core.publisher.Mono<V> newSucceeded(V result)

getName

public String getName()

Specified by:

getName in interface RObjectReactive

getCodec

public Codec getCodec()

Specified by:

getCodec in interface RObjectReactive

encode

protected void encode(Collection<Object> params,
                      Collection<?> values)

encode

protected io.netty.buffer.ByteBuf encode(Object value)

encodeMapKey

protected io.netty.buffer.ByteBuf encodeMapKey(Object value)

encodeMapValue

protected io.netty.buffer.ByteBuf encodeMapValue(Object value)

rename

public org.reactivestreams.Publisher<Void> rename(String newName)

Description copied from interface: RObjectReactive

Rename current object key to newName in mode

Specified by:

rename in interface RObjectReactive

Parameters:

newName - - new name of object

Returns:

void

migrate

public org.reactivestreams.Publisher<Void> migrate(String host,
                                                   int port,
                                                   int database,
                                                   long timeout)

Description copied from interface: RObjectReactive

Transfer a object from a source Redis instance to a destination Redis instance in mode

Specified by:

migrate in interface RObjectReactive

Parameters:

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

Returns:

void

move

public org.reactivestreams.Publisher<Boolean> move(int database)

Description copied from interface: RObjectReactive

Move object to another database in mode

Specified by:

move in interface RObjectReactive

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

renamenx

public org.reactivestreams.Publisher<Boolean> renamenx(String newName)

Description copied from interface: RObjectReactive

Rename current object key to newName in mode only if new key is not exists

Specified by:

renamenx in interface RObjectReactive

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

isExists

public org.reactivestreams.Publisher<Boolean> isExists()

Description copied from interface: RObjectReactive

Check object existence

Specified by:

isExists in interface RObjectReactive

Returns:

true if object exists and false otherwise