AsyncMultiMapProxy (Copycat Collections 0.5.0.onos API)

All Known Subinterfaces:

AsyncMultiMap<K,V>

All Known Implementing Classes:

DefaultAsyncMultiMap
```
public interface AsyncMultiMapProxy<K,V>
```
Asynchronous multimap proxy.

Author:

Jordan Halterman

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<Void>`	`clear()` Clears the map.
`CompletableFuture<Boolean>`	`containsEntry(K key, V value)` Checks whether the map contains an entry.
`CompletableFuture<Boolean>`	`containsKey(K key)` Checks whether the map contains a key.
`CompletableFuture<Boolean>`	`containsValue(V value)` Checks whether the map contains a value.
`CompletableFuture<Set<Map.Entry<K,V>>>`	`entrySet()` Gets a set of entries in the map.
`CompletableFuture<Collection<V>>`	`get(K key)` Gets a value from the map.
`CompletableFuture<Collection<V>>`	`getOrDefault(K key, Collection<V> defaultValue)` Gets the value of a key or the given default value if the key does not exist.
`CompletableFuture<Boolean>`	`isEmpty()` Checks whether the map is empty.
`CompletableFuture<Set<K>>`	`keySet()` Gets a set of keys in the map.
`CompletableFuture<Collection<V>>`	`put(K key, V value)` Puts a value in the map.
`CompletableFuture<Void>`	`putAll(Map<? extends K,? extends Collection<V>> m)` Puts a map of values in the map.
`CompletableFuture<Collection<V>>`	`remove(K key)` Removes a value from the map.
`CompletableFuture<Boolean>`	`remove(K key, V value)` Removes a key and value from the map.
`CompletableFuture<Collection<V>>`	`replace(K key, Collection<V> value)` Replaces a key with the given value.
`CompletableFuture<Boolean>`	`replace(K key, V oldValue, V newValue)` Replaces a key and value in the map.
`CompletableFuture<Void>`	`replaceAll(java.util.function.BiFunction<? super K,? super Collection<V>,? extends Collection<V>> function)` Replaces values in the map.
`CompletableFuture<Integer>`	`size()` Gets the map size.
`CompletableFuture<Collection<V>>`	`values()` Gets a collection of values in the map.

- Method Detail
  - size
```
CompletableFuture<Integer> size()
```
    Gets the map size.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - isEmpty
```
CompletableFuture<Boolean> isEmpty()
```
    Checks whether the map is empty.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - containsKey
```
CompletableFuture<Boolean> containsKey(K key)
```
    Checks whether the map contains a key.
    
    Parameters:
    
    key - The key to check.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - containsValue
```
CompletableFuture<Boolean> containsValue(V value)
```
    Checks whether the map contains a value.
    
    Parameters:
    
    value - The value to check.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - containsEntry
```
CompletableFuture<Boolean> containsEntry(K key,
                                         V value)
```
    Checks whether the map contains an entry.
    
    Parameters:
    
    key - The key to check.
    
    value - The value to check.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - get
```
CompletableFuture<Collection<V>> get(K key)
```
    Gets a value from the map.
    
    Parameters:
    
    key - The key to get.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - put
```
CompletableFuture<Collection<V>> put(K key,
                                     V value)
```
    Puts a value in the map.
    
    Parameters:
    
    key - The key to set.
    
    value - The value to set.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - remove
```
CompletableFuture<Collection<V>> remove(K key)
```
    Removes a value from the map.
    
    Parameters:
    
    key - The key to remove.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - remove
```
CompletableFuture<Boolean> remove(K key,
                                  V value)
```
    Removes a key and value from the map.
    
    Parameters:
    
    key - The key to remove.
    
    value - The value to remove.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - putAll
```
CompletableFuture<Void> putAll(Map<? extends K,? extends Collection<V>> m)
```
    Puts a map of values in the map.
    
    Parameters:
    
    m - The put to put.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - clear
```
CompletableFuture<Void> clear()
```
    Clears the map.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - keySet
```
CompletableFuture<Set<K>> keySet()
```
    Gets a set of keys in the map.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - values
```
CompletableFuture<Collection<V>> values()
```
    Gets a collection of values in the map.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - entrySet
```
CompletableFuture<Set<Map.Entry<K,V>>> entrySet()
```
    Gets a set of entries in the map.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - getOrDefault
```
CompletableFuture<Collection<V>> getOrDefault(K key,
                                              Collection<V> defaultValue)
```
    Gets the value of a key or the given default value if the key does not exist.
    
    Parameters:
    
    key - The key to get.
    
    defaultValue - The default value to return if the key does not exist.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - replaceAll
```
CompletableFuture<Void> replaceAll(java.util.function.BiFunction<? super K,? super Collection<V>,? extends Collection<V>> function)
```
    Replaces values in the map.
    
    Parameters:
    
    function - The serializable function with which to replace values.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - replace
```
CompletableFuture<Boolean> replace(K key,
                                   V oldValue,
                                   V newValue)
```
    Replaces a key and value in the map.
    
    Parameters:
    
    key - The key to replace.
    
    oldValue - The value to replace.
    
    newValue - The value with which to replace the given key and value.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - replace
```
CompletableFuture<Collection<V>> replace(K key,
                                         Collection<V> value)
```
    Replaces a key with the given value.
    
    Parameters:
    
    key - The key to replace.
    
    value - The value with which to replace the given key.
    
    Returns:
    
    A completable future to be completed with the result once complete.

Interface AsyncMultiMapProxy<K,V>

Method Summary

Method Detail

size

isEmpty

containsKey

containsValue

containsEntry

get

put

remove

remove

putAll

clear

keySet

values

entrySet

getOrDefault

replaceAll

replace

replace