akka.cluster.ddata

Class ORMultiMap<A>

java.lang.Object

akka.cluster.ddata.ORMultiMap<A>

All Implemented Interfaces:

RemovedNodePruning, ReplicatedData, ReplicatedDataSerialization, java.io.Serializable

public final class ORMultiMap<A>
extends java.lang.Object
implements ReplicatedData, ReplicatedDataSerialization, RemovedNodePruning

An immutable multi-map implementation. This class wraps an ORMap with an ORSet for the map's value.

This class is immutable, i.e. "modifying" methods return a new instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ORMultiMap(ORMap<ORSet<A>> underlying)

Method Summary

Modifier and Type	Method and Description
static ORMultiMap<java.lang.Object>	_empty()
ORMultiMap<A>	addBinding(Cluster node, java.lang.String key, A element) Java API: Add an element to a set associated with a key.
ORMultiMap<A>	addBinding(java.lang.String key, A element, Cluster node) Scala API: Add an element to a set associated with a key.
ORMultiMap<A>	addBinding(UniqueAddress node, java.lang.String key, A element) INTERNAL API
static ORMultiMap<java.lang.Object>	apply()
boolean	contains(java.lang.String key)
static <A> ORMultiMap<A>	create() Java API
static <A> ORMultiMap<A>	empty() Provides an empty multimap.
scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.Set<A>>	entries() Scala API: All entries of a multimap where keys are strings and values are sets.
boolean	equals(java.lang.Object o)
scala.Option<scala.collection.immutable.Set<A>>	get(java.lang.String key) Get the set associated with the key if there is one.
java.util.Map<java.lang.String,java.util.Set<A>>	getEntries() Java API: All entries of a multimap where keys are strings and values are sets.
scala.collection.immutable.Set<A>	getOrElse(java.lang.String key, scala.Function0<scala.collection.immutable.Set<A>> default_) Scala API: Get the set associated with the key if there is one, else return the given default.
int	hashCode()
boolean	isEmpty()
ORMultiMap<A>	merge(ORMultiMap<A> that)
boolean	needPruningFrom(UniqueAddress removedNode) Does it have any state changes from a specific node, which has been removed from the cluster.
ORMultiMap<A>	prune(UniqueAddress removedNode, UniqueAddress collapseInto) When the removed node has been removed from the cluster the state changes from that node will be pruned by collapsing the data entries to another node.
ORMultiMap<A>	pruningCleanup(UniqueAddress removedNode) Remove data entries from a node that has been removed from the cluster and already been pruned.
ORMultiMap<A>	put(Cluster node, java.lang.String key, scala.collection.immutable.Set<A> value) Scala API: Associate an entire set with the key while retaining the history of the previous replicated data set.
ORMultiMap<A>	put(Cluster node, java.lang.String key, java.util.Set<A> value) Java API: Associate an entire set with the key while retaining the history of the previous replicated data set.
ORMultiMap<A>	put(UniqueAddress node, java.lang.String key, scala.collection.immutable.Set<A> value) INTERNAL API
ORMultiMap<A>	remove(Cluster node, java.lang.String key) Remove an entire set associated with the key.
ORMultiMap<A>	remove(UniqueAddress node, java.lang.String key) INTERNAL API
ORMultiMap<A>	removeBinding(Cluster node, java.lang.String key, A element) Java API: Remove an element of a set associated with a key.
ORMultiMap<A>	removeBinding(java.lang.String key, A element, Cluster node) Scala API: Remove an element of a set associated with a key.
ORMultiMap<A>	removeBinding(UniqueAddress node, java.lang.String key, A element) INTERNAL API
ORMultiMap<A>	replaceBinding(java.lang.String key, A oldElement, A newElement, Cluster node) Replace an element of a set associated with a key with a new one if it is different.
ORMultiMap<A>	replaceBinding(UniqueAddress node, java.lang.String key, A oldElement, A newElement) INTERNAL API
int	size()
java.lang.String	toString()
static scala.Option<scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.Set<java.lang.Object>>>	unapply(java.lang.Object value) Extract the entries() of an ORMultiMap.
static <A> scala.Option<scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.Set<A>>>	unapply(ORMultiMap<A> m) Extract the entries().
ORMap<ORSet<A>>	underlying()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface akka.cluster.ddata.ReplicatedData

merge

Constructor Detail

ORMultiMap

public ORMultiMap(ORMap<ORSet<A>> underlying)

Method Detail

_empty

public static ORMultiMap<java.lang.Object> _empty()

empty

public static <A> ORMultiMap<A> empty()

Provides an empty multimap.

Returns:

(undocumented)

apply

public static ORMultiMap<java.lang.Object> apply()

create

public static <A> ORMultiMap<A> create()

Java API

Returns:

(undocumented)

unapply

public static <A> scala.Option<scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.Set<A>>> unapply(ORMultiMap<A> m)

Extract the entries().

Parameters:

m - (undocumented)

Returns:

(undocumented)

unapply

public static scala.Option<scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.Set<java.lang.Object>>> unapply(java.lang.Object value)

Extract the entries() of an ORMultiMap.

Parameters:

value - (undocumented)

Returns:

(undocumented)

underlying

public ORMap<ORSet<A>> underlying()

merge

public ORMultiMap<A> merge(ORMultiMap<A> that)

entries

public scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.Set<A>> entries()

Scala API: All entries of a multimap where keys are strings and values are sets.

Returns:

(undocumented)

getEntries

public java.util.Map<java.lang.String,java.util.Set<A>> getEntries()

Java API: All entries of a multimap where keys are strings and values are sets.

Returns:

(undocumented)

get

public scala.Option<scala.collection.immutable.Set<A>> get(java.lang.String key)

Get the set associated with the key if there is one.

Parameters:

key - (undocumented)

Returns:

(undocumented)

getOrElse

public scala.collection.immutable.Set<A> getOrElse(java.lang.String key,
                                                   scala.Function0<scala.collection.immutable.Set<A>> default_)

Scala API: Get the set associated with the key if there is one, else return the given default.

Parameters:

key - (undocumented)

default_ - (undocumented)

Returns:

(undocumented)

contains

public boolean contains(java.lang.String key)

isEmpty

public boolean isEmpty()

size

public int size()

put

public ORMultiMap<A> put(Cluster node,
                         java.lang.String key,
                         scala.collection.immutable.Set<A> value)

Scala API: Associate an entire set with the key while retaining the history of the previous replicated data set.

Parameters:

node - (undocumented)

key - (undocumented)

value - (undocumented)

Returns:

(undocumented)

put

public ORMultiMap<A> put(Cluster node,
                         java.lang.String key,
                         java.util.Set<A> value)

Java API: Associate an entire set with the key while retaining the history of the previous replicated data set.

Parameters:

node - (undocumented)

key - (undocumented)

value - (undocumented)

Returns:

(undocumented)

put

public ORMultiMap<A> put(UniqueAddress node,
                         java.lang.String key,
                         scala.collection.immutable.Set<A> value)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

value - (undocumented)

Returns:

(undocumented)

remove

public ORMultiMap<A> remove(Cluster node,
                            java.lang.String key)

Remove an entire set associated with the key.

Parameters:

node - (undocumented)

key - (undocumented)

Returns:

(undocumented)

remove

public ORMultiMap<A> remove(UniqueAddress node,
                            java.lang.String key)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

Returns:

(undocumented)

addBinding

public ORMultiMap<A> addBinding(java.lang.String key,
                                A element,
                                Cluster node)

Scala API: Add an element to a set associated with a key. If there is no existing set then one will be initialised.

Parameters:

key - (undocumented)

element - (undocumented)

node - (undocumented)

Returns:

(undocumented)

addBinding

public ORMultiMap<A> addBinding(Cluster node,
                                java.lang.String key,
                                A element)

Java API: Add an element to a set associated with a key. If there is no existing set then one will be initialised.

Parameters:

node - (undocumented)

key - (undocumented)

element - (undocumented)

Returns:

(undocumented)

addBinding

public ORMultiMap<A> addBinding(UniqueAddress node,
                                java.lang.String key,
                                A element)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

element - (undocumented)

Returns:

(undocumented)

removeBinding

public ORMultiMap<A> removeBinding(java.lang.String key,
                                   A element,
                                   Cluster node)

Scala API: Remove an element of a set associated with a key. If there are no more elements in the set then the entire set will be removed.

Parameters:

key - (undocumented)

element - (undocumented)

node - (undocumented)

Returns:

(undocumented)

removeBinding

public ORMultiMap<A> removeBinding(Cluster node,
                                   java.lang.String key,
                                   A element)

Java API: Remove an element of a set associated with a key. If there are no more elements in the set then the entire set will be removed.

Parameters:

node - (undocumented)

key - (undocumented)

element - (undocumented)

Returns:

(undocumented)

removeBinding

public ORMultiMap<A> removeBinding(UniqueAddress node,
                                   java.lang.String key,
                                   A element)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

element - (undocumented)

Returns:

(undocumented)

replaceBinding

public ORMultiMap<A> replaceBinding(java.lang.String key,
                                    A oldElement,
                                    A newElement,
                                    Cluster node)

Replace an element of a set associated with a key with a new one if it is different. This is useful when an element is removed and another one is added within the same Update. The order of addition and removal is important in order to retain history for replicated data.

Parameters:

key - (undocumented)

oldElement - (undocumented)

newElement - (undocumented)

node - (undocumented)

Returns:

(undocumented)

replaceBinding

public ORMultiMap<A> replaceBinding(UniqueAddress node,
                                    java.lang.String key,
                                    A oldElement,
                                    A newElement)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

oldElement - (undocumented)

newElement - (undocumented)

Returns:

(undocumented)

needPruningFrom

public boolean needPruningFrom(UniqueAddress removedNode)

Description copied from interface: RemovedNodePruning

Does it have any state changes from a specific node, which has been removed from the cluster.

Specified by:

needPruningFrom in interface RemovedNodePruning

Parameters:

removedNode - (undocumented)

Returns:

(undocumented)

pruningCleanup

public ORMultiMap<A> pruningCleanup(UniqueAddress removedNode)

Description copied from interface: RemovedNodePruning

Remove data entries from a node that has been removed from the cluster and already been pruned.

Specified by:

pruningCleanup in interface RemovedNodePruning

Parameters:

removedNode - (undocumented)

Returns:

(undocumented)

prune

public ORMultiMap<A> prune(UniqueAddress removedNode,
                           UniqueAddress collapseInto)

Description copied from interface: RemovedNodePruning

When the removed node has been removed from the cluster the state changes from that node will be pruned by collapsing the data entries to another node.

Specified by:

prune in interface RemovedNodePruning

Parameters:

removedNode - (undocumented)

collapseInto - (undocumented)

Returns:

(undocumented)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object