RemoteMultimapCacheImpl (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

java.lang.Object
- org.infinispan.client.hotrod.impl.multimap.RemoteMultimapCacheImpl<K,V>

All Implemented Interfaces:

RemoteMultimapCache<K,V>, BasicMultimapCache<K,V>
```
public class RemoteMultimapCacheImpl<K,V>
extends Object
implements RemoteMultimapCache<K,V>
```
Remote implementation of RemoteMultimapCache

Since:

9.2

Author:

karesti@redhat.com

Constructor Summary

Constructors
Constructor and Description

RemoteMultimapCacheImpl(RemoteCacheManager rcm, RemoteCache<K,Collection<V>> cache)

Constructors
Constructor and Description
`RemoteMultimapCacheImpl(RemoteCacheManager rcm, RemoteCache<K,Collection<V>> cache)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<Boolean>`	`containsEntry(K key, V value)` Returns `Boolean.TRUE` if this multimap cache contains the key-value pair.
`CompletableFuture<Boolean>`	`containsKey(K key)` Returns `Boolean.TRUE` if this multimap cache contains the key.
`CompletableFuture<Boolean>`	`containsValue(V value)` Asynchronous method that returns `Boolean.TRUE` if this multimap cache contains the value at any key.
`CompletableFuture<Collection<V>>`	`get(K key)` Returns a view collection of the values associated with key in this multimap cache, if any.
`CompletableFuture<MetadataCollection<V>>`	`getWithMetadata(K key)` Returns a `MetadataCollection` of the values associated with key in this multimap cache, if any.
`void`	`init()`
`CompletableFuture<Void>`	`put(K key, V value)` Puts a key-value pair in this multimap cache.
`CompletableFuture<Boolean>`	`remove(K key)` Removes all the key-value pairs associated with the key from this multimap cache, if such exists.
`CompletableFuture<Boolean>`	`remove(K key, V value)` Removes a key-value pair from this multimap cache, if such exists.
`CompletableFuture<Long>`	`size()` Returns the number of key-value pairs in this multimap cache.
`boolean`	`supportsDuplicates()` Multimap can support duplicates on the same key k → ['a', 'a', 'b'] or not k → ['a', 'b'] depending on configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RemoteMultimapCacheImpl
```
public RemoteMultimapCacheImpl(RemoteCacheManager rcm,
                               RemoteCache<K,Collection<V>> cache)
```
- Method Detail
  - init
```
public void init()
```
  - put
```
public CompletableFuture<Void> put(K key,
                                   V value)
```
    Description copied from interface: BasicMultimapCache
    Puts a key-value pair in this multimap cache.
    - If this multimap cache supports duplicates, the value will be always added.
    - If this multimap cache does not support duplicates and the value exists on the key, nothing will be done.
    Specified by:
    
    put in interface BasicMultimapCache<K,V>
    
    Parameters:
    
    key - the key to be put
    
    value - the value to added
    
    Returns:
    
    CompletableFuture containing a Void
  - get
```
public CompletableFuture<Collection<V>> get(K key)
```
    Description copied from interface: BasicMultimapCache
    
    Returns a view collection of the values associated with key in this multimap cache, if any. Any changes to the retrieved collection won't change the values in this multimap cache. When this method returns an empty collection, it means the key was not found.
    
    Specified by:
    
    get in interface BasicMultimapCache<K,V>
    
    Parameters:
    
    key - to be retrieved
    
    Returns:
    
    a CompletableFuture containing which is a view of the underlying values.
  - getWithMetadata
```
public CompletableFuture<MetadataCollection<V>> getWithMetadata(K key)
```
    Description copied from interface: RemoteMultimapCache
    
    Returns a MetadataCollection of the values associated with key in this multimap cache, if any. Any changes to the retrieved collection won't change the values in this multimap cache. When this method returns an empty metadata collection, it means the key was not found.
    
    Specified by:
    
    getWithMetadata in interface RemoteMultimapCache<K,V>
    
    Parameters:
    
    key - to be retrieved
    
    Returns:
    
    the collection with the metadata of the given key
  - remove
```
public CompletableFuture<Boolean> remove(K key)
```
    Description copied from interface: BasicMultimapCache
    
    Removes all the key-value pairs associated with the key from this multimap cache, if such exists.
    
    Specified by:
    
    remove in interface BasicMultimapCache<K,V>
    
    Parameters:
    
    key - to be removed
    
    Returns:
    
    a CompletableFuture containing Boolean.TRUE if the entry was removed, and Boolean.FALSE when the entry was not removed
  - remove
```
public CompletableFuture<Boolean> remove(K key,
                                         V value)
```
    Description copied from interface: BasicMultimapCache
    Removes a key-value pair from this multimap cache, if such exists. Returns true when the key-value pair has been removed from the key.
    - In the case where duplicates are not supported, only one the key-value pair will be removed, if such exists.
    - In the case where duplicates are supported, all the key-value pairs will be removed.
    - If the values remaining after the remove call are empty, the whole entry will be removed.
    Specified by:
    
    remove in interface BasicMultimapCache<K,V>
    
    Parameters:
    
    key - key to be removed
    
    value - value to be removed
    
    Returns:
    
    CompletableFuture containing Boolean.TRUE if the key-value pair was removed, and Boolean.FALSE when the key-value pair was not removed
  - containsKey
```
public CompletableFuture<Boolean> containsKey(K key)
```
    Description copied from interface: BasicMultimapCache
    
    Returns Boolean.TRUE if this multimap cache contains the key.
    
    Specified by:
    
    containsKey in interface BasicMultimapCache<K,V>
    
    Parameters:
    
    key - the key that might exists in this multimap cache
    
    Returns:
    
    CompletableFuture containing a Boolean
  - containsValue
```
public CompletableFuture<Boolean> containsValue(V value)
```
    Description copied from interface: BasicMultimapCache
    
    Asynchronous method that returns Boolean.TRUE if this multimap cache contains the value at any key.
    
    Specified by:
    
    containsValue in interface BasicMultimapCache<K,V>
    
    Parameters:
    
    value - the value that might exists in any entry
    
    Returns:
    
    CompletableFuture containing a Boolean
  - containsEntry
```
public CompletableFuture<Boolean> containsEntry(K key,
                                                V value)
```
    Description copied from interface: BasicMultimapCache
    
    Returns Boolean.TRUE if this multimap cache contains the key-value pair.
    
    Specified by:
    
    containsEntry in interface BasicMultimapCache<K,V>
    
    Parameters:
    
    key - the key of the key-value pair
    
    value - the value of the key-value pair
    
    Returns:
    
    CompletableFuture containing a Boolean
  - size
```
public CompletableFuture<Long> size()
```
    Description copied from interface: BasicMultimapCache
    
    Returns the number of key-value pairs in this multimap cache. It doesn't return the distinct number of keys.
    This method is blocking in a explicit transaction context.
    The CompletableFuture is a
    
    Specified by:
    
    size in interface BasicMultimapCache<K,V>
    
    Returns:
    
    CompletableFuture containing the size as Long
  - supportsDuplicates
```
public boolean supportsDuplicates()
```
    Description copied from interface: BasicMultimapCache
    
    Multimap can support duplicates on the same key k → ['a', 'a', 'b'] or not k → ['a', 'b'] depending on configuration.
    Returns duplicates are supported or not in this multimap cache.
    
    Specified by:
    
    supportsDuplicates in interface BasicMultimapCache<K,V>
    
    Returns:
    
    true if this multimap supports duplicate values for a given key.

Class RemoteMultimapCacheImpl<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RemoteMultimapCacheImpl

Method Detail

init

put

get

getWithMetadata

remove

remove

containsKey

containsValue

containsEntry

size

supportsDuplicates