DistributedMultiMap (Atomix API Reference (1.0.8))

Nested Classes
Modifier and Type	Class and Description
`static class`	`DistributedMultiMap.Config` Multimap configuration.
`static class`	`DistributedMultiMap.Order` Represents the order of values in a multimap.

Constructors
Constructor and Description
`DistributedMultiMap(CopycatClient client, Properties options)`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<Void>`	`clear()` Removes all entries from the map.
`io.atomix.resource.Resource.Config`	`config()`
`CompletableFuture<Boolean>`	`containsEntry(K key, V value)` Checks whether the map contains an entry.
`CompletableFuture<Boolean>`	`containsEntry(K key, V value, io.atomix.resource.ReadConsistency consistency)` Checks whether the map contains an entry.
`CompletableFuture<Boolean>`	`containsKey(K key)` Checks whether the map contains a key.
`CompletableFuture<Boolean>`	`containsKey(K key, io.atomix.resource.ReadConsistency consistency)` Checks whether the map contains a key.
`CompletableFuture<Boolean>`	`containsValue(V value)` Checks whether the map contains a value.
`CompletableFuture<Boolean>`	`containsValue(V value, io.atomix.resource.ReadConsistency consistency)` Checks whether the map contains a value.
`CompletableFuture<Collection<V>>`	`get(K key)` Gets a value from the map.
`CompletableFuture<Collection<V>>`	`get(K key, io.atomix.resource.ReadConsistency consistency)` Gets a value from the map.
`CompletableFuture<Boolean>`	`isEmpty()` Checks whether the map is empty.
`CompletableFuture<Boolean>`	`isEmpty(io.atomix.resource.ReadConsistency consistency)` Checks whether the map is empty.
`CompletableFuture<Boolean>`	`put(K key, V value)` Puts a value in the map.
`CompletableFuture<Boolean>`	`put(K key, V value, Duration ttl)` Puts a value in the map.
`CompletableFuture<Collection<V>>`	`remove(Object key)` Removes a value from the map.
`CompletableFuture<Boolean>`	`remove(Object key, Object value)` Removes a key and value from the map.
`CompletableFuture<Void>`	`removeValue(Object value)` Removes all instances of a value from the map.
`CompletableFuture<Integer>`	`size()` Gets the number of key-value pairs in the map.
`CompletableFuture<Integer>`	`size(K key)` Gets the number of values for the given key.
`CompletableFuture<Integer>`	`size(K key, io.atomix.resource.ReadConsistency consistency)` Gets the number of values for the given key.
`CompletableFuture<Integer>`	`size(io.atomix.resource.ReadConsistency consistency)` Gets the number of key-value pairs in the map.

java.lang.Object
- io.atomix.resource.AbstractResource<DistributedMultiMap<K,V>>
- - io.atomix.collections.DistributedMultiMap<K,V>

All Implemented Interfaces:

Managed<DistributedMultiMap<K,V>>, io.atomix.resource.Resource<DistributedMultiMap<K,V>>
```
public class DistributedMultiMap<K,V>
extends io.atomix.resource.AbstractResource<DistributedMultiMap<K,V>>
```
Stores a map of keys to multiple values.
The multi-map resource stores a map of keys that allows multiple values to be associated with each key. Multimap entries are stored in memory on each stateful node and backed by disk, thus the size of a multi-map is limited by the available memory on the smallest node in the cluster.
To create a multimap, use the getMultiMap factory method on an Atomix instance:
```
   
   DistributedMultiMap<String, String> multiMap = atomix.getMultiMap("foo").get();
   
 
```
The multi-map interface closely simulates that of Map except that values are Collections rather than V.
Value order
By default, the values associated with each key are stored in insertion order. However, this behavior can be configured via the map configuration by setting the value DistributedMultiMap.Order. To set the order of values in a multi-map, create a configuration and provide the configuration at the creation of the map.
```
   
   DistributedMultiMap.Config config = DistributedMultiMap.config()
     .withValueOrder(DistributedMultiMap.Order.NATURAL);
   DistributedMultiMap<String, String> multiMap = atomix.getMultiMap("foo", config).get();
   
 
```
Multi-maps support relaxed consistency levels for some read operations line size(ReadConsistency) and containsKey(Object, ReadConsistency). By default, read operations on a queue are linearizable but require some level of communication between nodes.
Author:
- Nested Class Summary
  
  Nested Classes
  Modifier and Type Class and Description
  
  static class DistributedMultiMap.Config
  Multimap configuration.
  
  static class DistributedMultiMap.Order
  Represents the order of values in a multimap.
  
  Nested classes/interfaces inherited from interface io.atomix.resource.Resource
  io.atomix.resource.Resource.Event, io.atomix.resource.Resource.EventType, io.atomix.resource.Resource.Options, io.atomix.resource.Resource.State
  
  Constructor Summary
  
  Constructors
  Constructor and Description
  
  DistributedMultiMap(CopycatClient client, Properties options)
  
  Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  
  CompletableFuture<Void> clear()
  Removes all entries from the map.
  
  io.atomix.resource.Resource.Config config()
  
  CompletableFuture<Boolean> containsEntry(K key, V value)
  Checks whether the map contains an entry.
  
  CompletableFuture<Boolean> containsEntry(K key, V value, io.atomix.resource.ReadConsistency consistency)
  Checks whether the map contains an entry.
  
  CompletableFuture<Boolean> containsKey(K key)
  Checks whether the map contains a key.
  
  CompletableFuture<Boolean> containsKey(K key, io.atomix.resource.ReadConsistency consistency)
  Checks whether the map contains a key.
  
  CompletableFuture<Boolean> containsValue(V value)
  Checks whether the map contains a value.
  
  CompletableFuture<Boolean> containsValue(V value, io.atomix.resource.ReadConsistency consistency)
  Checks whether the map contains a value.
  
  CompletableFuture<Collection<V>> get(K key)
  Gets a value from the map.
  
  CompletableFuture<Collection<V>> get(K key, io.atomix.resource.ReadConsistency consistency)
  Gets a value from the map.
  
  CompletableFuture<Boolean> isEmpty()
  Checks whether the map is empty.
  
  CompletableFuture<Boolean> isEmpty(io.atomix.resource.ReadConsistency consistency)
  Checks whether the map is empty.
  
  CompletableFuture<Boolean> put(K key, V value)
  Puts a value in the map.
  
  CompletableFuture<Boolean> put(K key, V value, Duration ttl)
  Puts a value in the map.
  
  CompletableFuture<Collection<V>> remove(Object key)
  Removes a value from the map.
  
  CompletableFuture<Boolean> remove(Object key, Object value)
  Removes a key and value from the map.
  
  CompletableFuture<Void> removeValue(Object value)
  Removes all instances of a value from the map.
  
  CompletableFuture<Integer> size()
  Gets the number of key-value pairs in the map.
  
  CompletableFuture<Integer> size(K key)
  Gets the number of values for the given key.
  
  CompletableFuture<Integer> size(K key, io.atomix.resource.ReadConsistency consistency)
  Gets the number of values for the given key.
  
  CompletableFuture<Integer> size(io.atomix.resource.ReadConsistency consistency)
  Gets the number of key-value pairs in the map.
  
  Methods inherited from class io.atomix.resource.AbstractResource
  close, context, delete, equals, hashCode, isClosed, isOpen, onRecovery, onStateChange, open, options, serializer, state, toString, type
  
  Methods inherited from class java.lang.Object
  getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DistributedMultiMap
```
public DistributedMultiMap(CopycatClient client,
                           Properties options)
```
- Method Detail
  - config
```
public io.atomix.resource.Resource.Config config()
```
    Specified by:
    
    config in interface io.atomix.resource.Resource<DistributedMultiMap<K,V>>
    
    Overrides:
    
    config in class io.atomix.resource.AbstractResource<DistributedMultiMap<K,V>>
  - isEmpty
```
public CompletableFuture<Boolean> isEmpty()
```
    Checks whether the map is empty.
    
    Returns:
    
    A completable future to be completed with a boolean value indicating whether the map is empty.
  - isEmpty
```
public CompletableFuture<Boolean> isEmpty(io.atomix.resource.ReadConsistency consistency)
```
    Checks whether the map is empty.
    
    Returns:
    
    A completable future to be completed with a boolean value indicating whether the map is empty.
  - size
```
public CompletableFuture<Integer> size()
```
    Gets the number of key-value pairs in the map.
    
    Returns:
    
    A completable future to be completed with the number of entries in the map.
  - size
```
public CompletableFuture<Integer> size(io.atomix.resource.ReadConsistency consistency)
```
    Gets the number of key-value pairs in the map.
    
    Parameters:
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with the number of entries in the map.
  - size
```
public CompletableFuture<Integer> size(K key)
```
    Gets the number of values for the given key.
    
    Parameters:
    
    key - The key to check.
    
    Returns:
    
    A completable future to be completed with the number of entries in the map.
  - size
```
public CompletableFuture<Integer> size(K key,
                                       io.atomix.resource.ReadConsistency consistency)
```
    Gets the number of values for the given key.
    
    Parameters:
    
    key - The key to check.
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with the number of entries in the map.
  - containsKey
```
public 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.
  - containsKey
```
public CompletableFuture<Boolean> containsKey(K key,
                                              io.atomix.resource.ReadConsistency consistency)
```
    Checks whether the map contains a key.
    
    Parameters:
    
    key - The key to check.
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - containsEntry
```
public 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.
  - containsEntry
```
public CompletableFuture<Boolean> containsEntry(K key,
                                                V value,
                                                io.atomix.resource.ReadConsistency consistency)
```
    Checks whether the map contains an entry.
    
    Parameters:
    
    key - The key to check.
    
    value - The value to check.
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - containsValue
```
public 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.
  - containsValue
```
public CompletableFuture<Boolean> containsValue(V value,
                                                io.atomix.resource.ReadConsistency consistency)
```
    Checks whether the map contains a value.
    
    Parameters:
    
    value - The value to check.
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - get
```
public 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.
  - get
```
public CompletableFuture<Collection<V>> get(K key,
                                            io.atomix.resource.ReadConsistency consistency)
```
    Gets a value from the map.
    
    Parameters:
    
    key - The key to get.
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - put
```
public CompletableFuture<Boolean> 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.
  - put
```
public CompletableFuture<Boolean> put(K key,
                                      V value,
                                      Duration ttl)
```
    Puts a value in the map.
    
    Parameters:
    
    key - The key to set.
    
    value - The value to set.
    
    ttl - The duration after which to expire the key.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - remove
```
public CompletableFuture<Collection<V>> remove(Object 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
```
public CompletableFuture<Boolean> remove(Object key,
                                         Object 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.
  - removeValue
```
public CompletableFuture<Void> removeValue(Object value)
```
    Removes all instances of a value from the map.
    
    Parameters:
    
    value - The value to remove.
    
    Returns:
    
    A completable future to be completed once the value has been removed.
  - clear
```
public CompletableFuture<Void> clear()
```
    Removes all entries from the map.
    
    Returns:
    
    A completable future to be completed once the operation is complete.

Class DistributedMultiMap<K,V>

Value order

Nested Class Summary

Nested classes/interfaces inherited from interface io.atomix.resource.Resource

Constructor Summary

Method Summary

Methods inherited from class io.atomix.resource.AbstractResource

Methods inherited from class java.lang.Object

Constructor Detail

DistributedMultiMap

Method Detail

config

isEmpty

isEmpty

size

size

size

size

containsKey

containsKey

containsEntry

containsEntry

containsValue

containsValue

get

get

put

put

remove

remove

removeValue

clear