io.atomix.core.multimap

Interface DistributedMultimap<K,V>

All Superinterfaces:

DistributedPrimitive, com.google.common.collect.Multimap<K,V>, SyncPrimitive

public interface DistributedMultimap<K,V>
extends SyncPrimitive, com.google.common.collect.Multimap<K,V>

This provides a synchronous version of the functionality provided by AsyncAtomicMultimap. Instead of returning futures this map blocks until the future completes then returns the result.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
default void	addListener(MultimapEventListener<K,V> listener) Registers the specified listener to be notified whenever the map is updated.
void	addListener(MultimapEventListener<K,V> listener, Executor executor) Registers the specified listener to be notified whenever the map is updated.
DistributedMap<K,Collection<V>>	asMap()
AsyncDistributedMultimap<K,V>	async() Returns the underlying asynchronous primitive.
DistributedCollection<Map.Entry<K,V>>	entries() Returns a collection of each key-value pair in this map.
DistributedMultiset<K>	keys() Returns a multiset of the keys present in this multimap with one or more associated values each.
DistributedSet<K>	keySet() Returns a set of the keys contained in this multimap with one or more associated values.
void	removeListener(MultimapEventListener<K,V> listener) Unregisters the specified listener such that it will no longer receive map change notifications.
DistributedMultiset<V>	values() Returns a collection of values in the set with duplicates permitted, the size of this collection will equal the size of the map at the time of creation.

Methods inherited from interface io.atomix.primitive.SyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Methods inherited from interface com.google.common.collect.Multimap

clear, containsEntry, containsKey, containsValue, equals, forEach, get, hashCode, isEmpty, put, putAll, putAll, remove, removeAll, replaceValues, size

Method Detail

keySet

DistributedSet<K> keySet()

Returns a set of the keys contained in this multimap with one or more associated values.

Specified by:

keySet in interface com.google.common.collect.Multimap<K,V>

Returns:

the collection of all keys with one or more associated values, this may be empty

keys

DistributedMultiset<K> keys()

Returns a multiset of the keys present in this multimap with one or more associated values each. Keys will appear once for each key-value pair in which they participate.

Specified by:

keys in interface com.google.common.collect.Multimap<K,V>

Returns:

a multiset of the keys, this may be empty

values

DistributedMultiset<V> values()

Returns a collection of values in the set with duplicates permitted, the size of this collection will equal the size of the map at the time of creation.

Specified by:

values in interface com.google.common.collect.Multimap<K,V>

Returns:

a collection of values, this may be empty

entries

DistributedCollection<Map.Entry<K,V>> entries()

Returns a collection of each key-value pair in this map.

Specified by:

entries in interface com.google.common.collect.Multimap<K,V>

Returns:

a collection of all entries in the map, this may be empty

asMap

DistributedMap<K,Collection<V>> asMap()

Specified by:

asMap in interface com.google.common.collect.Multimap<K,V>

addListener

default void addListener(MultimapEventListener<K,V> listener)

Registers the specified listener to be notified whenever the map is updated.

Parameters:

listener - listener to notify about map events

addListener

void addListener(MultimapEventListener<K,V> listener,
                 Executor executor)

Registers the specified listener to be notified whenever the map is updated.

Parameters:

listener - listener to notify about map events

executor - executor to use for handling incoming map events

removeListener

void removeListener(MultimapEventListener<K,V> listener)

Unregisters the specified listener such that it will no longer receive map change notifications.

Parameters:

listener - listener to unregister

async

AsyncDistributedMultimap<K,V> async()

Description copied from interface: SyncPrimitive

Returns the underlying asynchronous primitive.

Specified by:

async in interface SyncPrimitive

Returns:

the underlying asynchronous primitive