Package akka.cluster.ddata
Class ORMultiMap<A,B>
- java.lang.Object
-
- akka.cluster.ddata.ORMultiMap<A,B>
-
- All Implemented Interfaces:
DeltaReplicatedData
,RemovedNodePruning
,ReplicatedData
,ReplicatedDataSerialization
,java.io.Serializable
public final class ORMultiMap<A,B> extends java.lang.Object implements DeltaReplicatedData, ReplicatedDataSerialization, RemovedNodePruning
An immutable multi-map implementation. This class wraps anORMap
with anORSet
for the map's value.This class is immutable, i.e. "modifying" methods return a new instance.
Note that on concurrent adds and removals for the same key (on the same set), removals can be lost.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ORMultiMap.ORMultiMapTag$
INTERNAL APIstatic class
ORMultiMap.ORMultiMapWithValueDeltasTag$
INTERNAL API
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static ORMultiMap<java.lang.Object,java.lang.Object>
_empty()
static ORMultiMap<java.lang.Object,java.lang.Object>
_emptyWithValueDeltas()
ORMultiMap<A,B>
$colon$plus(scala.Tuple2<A,scala.collection.immutable.Set<B>> entry, SelfUniqueAddress node)
Convenience for put.ORMultiMap<A,B>
$minus(A key, Cluster node)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
$plus(scala.Tuple2<A,scala.collection.immutable.Set<B>> entry, Cluster node)
Deprecated.Use `:+` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
addBinding(Cluster node, A key, B element)
Deprecated.Use `addBinding` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
addBinding(SelfUniqueAddress node, A key, B element)
Add an element to a set associated with a key.ORMultiMap<A,B>
addBinding(A key, B element, Cluster node)
Deprecated.Use `addBinding` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
addBindingBy(A key, B element, SelfUniqueAddress node)
static ORMultiMap<java.lang.Object,java.lang.Object>
apply()
boolean
contains(A key)
static <A,B>
ORMultiMap<A,B>create()
Java APIscala.Option<ORMap.DeltaOp>
delta()
The accumulated delta of mutator operations since previousDeltaReplicatedData.resetDelta()
.static <A,B>
ORMultiMap<A,B>empty()
Provides an empty multimap.static <A,B>
ORMultiMap<A,B>emptyWithValueDeltas()
scala.collection.immutable.Map<A,scala.collection.immutable.Set<B>>
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<B>>
get(A key)
Get the set associated with the key if there is one.java.util.Map<A,java.util.Set<B>>
getEntries()
Java API: All entries of a multimap where keys are strings and values are sets.scala.collection.immutable.Set<B>
getOrElse(A key, scala.Function0<scala.collection.immutable.Set<B>> 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,B>
merge(ORMultiMap<A,B> that)
ORMultiMap<A,B>
mergeDelta(ORMap.DeltaOp thatDelta)
scala.collection.immutable.Set<UniqueAddress>
modifiedByNodes()
The nodes that have changed the state for this data and would need pruning when such node is no longer part of the cluster.boolean
needPruningFrom(UniqueAddress removedNode)
Does it have any state changes from a specific node, which has been removed from the cluster.ORMultiMap<A,B>
prune(UniqueAddress removedNode, UniqueAddress collapseInto)
When theremoved
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,B>
pruningCleanup(UniqueAddress removedNode)
Remove data entries from a node that has been removed from the cluster and already been pruned.ORMultiMap<A,B>
put(Cluster node, A key, java.util.Set<B> value)
Deprecated.Use `put` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
put(Cluster node, A key, scala.collection.immutable.Set<B> value)
Deprecated.Use `put` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
put(SelfUniqueAddress node, A key, java.util.Set<B> value)
Java API: Associate an entire set with the key while retaining the history of the previous replicated data set.ORMultiMap<A,B>
put(SelfUniqueAddress node, A key, scala.collection.immutable.Set<B> value)
Scala API: Associate an entire set with the key while retaining the history of the previous replicated data set.ORMultiMap<A,B>
remove(Cluster node, A key)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
remove(SelfUniqueAddress node, A key)
Java API Remove an entire set associated with the key.ORMultiMap<A,B>
remove(A key, SelfUniqueAddress node)
Scala API Remove an entire set associated with the key.ORMultiMap<A,B>
removeBinding(Cluster node, A key, B element)
Deprecated.Use `removeBinding` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
removeBinding(SelfUniqueAddress node, A key, B element)
Remove an element of a set associated with a key.ORMultiMap<A,B>
removeBinding(A key, B element, Cluster node)
Deprecated.Use `removeBinding` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
removeBindingBy(A key, B element, SelfUniqueAddress node)
ORMultiMap<A,B>
replaceBinding(SelfUniqueAddress node, A key, B oldElement, B newElement)
Replace an element of a set associated with a key with a new one if it is different.ORMultiMap<A,B>
replaceBinding(A key, B oldElement, B newElement, Cluster node)
Deprecated.Use `replaceBinding` that takes a `SelfUniqueAddress` parameter instead.ORMultiMap<A,B>
replaceBindingBy(A key, B oldElement, B newElement, SelfUniqueAddress node)
ORMultiMap<A,B>
resetDelta()
Reset collection of deltas from mutator operations.int
size()
java.lang.String
toString()
static <A,B>
scala.Option<scala.collection.immutable.Map<A,scala.collection.immutable.Set<B>>>unapply(ORMultiMap<A,B> m)
Extract theentries()
.static <A,B extends ReplicatedData>
scala.Option<scala.collection.immutable.Map<A,scala.collection.immutable.Set<B>>>unapply(java.lang.Object value)
Extract theentries()
of anORMultiMap
.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface akka.cluster.ddata.DeltaReplicatedData
mergeDelta
-
Methods inherited from interface akka.cluster.ddata.ReplicatedData
merge
-
-
-
-
Method Detail
-
_empty
public static ORMultiMap<java.lang.Object,java.lang.Object> _empty()
-
_emptyWithValueDeltas
public static ORMultiMap<java.lang.Object,java.lang.Object> _emptyWithValueDeltas()
-
empty
public static <A,B> ORMultiMap<A,B> empty()
Provides an empty multimap.
-
emptyWithValueDeltas
public static <A,B> ORMultiMap<A,B> emptyWithValueDeltas()
-
apply
public static ORMultiMap<java.lang.Object,java.lang.Object> apply()
-
create
public static <A,B> ORMultiMap<A,B> create()
Java API
-
unapply
public static <A,B> scala.Option<scala.collection.immutable.Map<A,scala.collection.immutable.Set<B>>> unapply(ORMultiMap<A,B> m)
Extract theentries()
.
-
unapply
public static <A,B extends ReplicatedData> scala.Option<scala.collection.immutable.Map<A,scala.collection.immutable.Set<B>>> unapply(java.lang.Object value)
Extract theentries()
of anORMultiMap
.
-
merge
public ORMultiMap<A,B> merge(ORMultiMap<A,B> that)
-
entries
public scala.collection.immutable.Map<A,scala.collection.immutable.Set<B>> entries()
Scala API: All entries of a multimap where keys are strings and values are sets.
-
getEntries
public java.util.Map<A,java.util.Set<B>> getEntries()
Java API: All entries of a multimap where keys are strings and values are sets.
-
get
public scala.Option<scala.collection.immutable.Set<B>> get(A key)
Get the set associated with the key if there is one.
-
getOrElse
public scala.collection.immutable.Set<B> getOrElse(A key, scala.Function0<scala.collection.immutable.Set<B>> default_)
Scala API: Get the set associated with the key if there is one, else return the given default.
-
contains
public boolean contains(A key)
-
isEmpty
public boolean isEmpty()
-
size
public int size()
-
$colon$plus
public ORMultiMap<A,B> $colon$plus(scala.Tuple2<A,scala.collection.immutable.Set<B>> entry, SelfUniqueAddress node)
Convenience for put. Requires an implicit SelfUniqueAddress.
-
$plus
public ORMultiMap<A,B> $plus(scala.Tuple2<A,scala.collection.immutable.Set<B>> entry, Cluster node)
Deprecated.Use `:+` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
put
public ORMultiMap<A,B> put(SelfUniqueAddress node, A key, scala.collection.immutable.Set<B> value)
Scala API: Associate an entire set with the key while retaining the history of the previous replicated data set.
-
put
public ORMultiMap<A,B> put(Cluster node, A key, scala.collection.immutable.Set<B> value)
Deprecated.Use `put` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
put
public ORMultiMap<A,B> put(SelfUniqueAddress node, A key, java.util.Set<B> value)
Java API: Associate an entire set with the key while retaining the history of the previous replicated data set.
-
put
public ORMultiMap<A,B> put(Cluster node, A key, java.util.Set<B> value)
Deprecated.Use `put` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
remove
public ORMultiMap<A,B> remove(A key, SelfUniqueAddress node)
Scala API Remove an entire set associated with the key.
-
$minus
public ORMultiMap<A,B> $minus(A key, Cluster node)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.Convenience for remove. Requires an implicit Cluster.
-
remove
public ORMultiMap<A,B> remove(SelfUniqueAddress node, A key)
Java API Remove an entire set associated with the key.
-
remove
public ORMultiMap<A,B> remove(Cluster node, A key)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
addBinding
public ORMultiMap<A,B> addBinding(SelfUniqueAddress node, A key, B element)
Add an element to a set associated with a key. If there is no existing set then one will be initialised. TODO add implicit after deprecated is EOL.
-
addBindingBy
public ORMultiMap<A,B> addBindingBy(A key, B element, SelfUniqueAddress node)
-
addBinding
public ORMultiMap<A,B> addBinding(A key, B element, Cluster node)
Deprecated.Use `addBinding` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
addBinding
public ORMultiMap<A,B> addBinding(Cluster node, A key, B element)
Deprecated.Use `addBinding` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
removeBinding
public ORMultiMap<A,B> removeBinding(SelfUniqueAddress node, A key, B element)
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. TODO add implicit after deprecated is EOL.
-
removeBindingBy
public ORMultiMap<A,B> removeBindingBy(A key, B element, SelfUniqueAddress node)
-
removeBinding
public ORMultiMap<A,B> removeBinding(A key, B element, Cluster node)
Deprecated.Use `removeBinding` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
removeBinding
public ORMultiMap<A,B> removeBinding(Cluster node, A key, B element)
Deprecated.Use `removeBinding` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
replaceBinding
public ORMultiMap<A,B> replaceBinding(SelfUniqueAddress node, A key, B oldElement, B newElement)
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.
-
replaceBindingBy
public ORMultiMap<A,B> replaceBindingBy(A key, B oldElement, B newElement, SelfUniqueAddress node)
-
replaceBinding
public ORMultiMap<A,B> replaceBinding(A key, B oldElement, B newElement, Cluster node)
Deprecated.Use `replaceBinding` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
resetDelta
public ORMultiMap<A,B> resetDelta()
Description copied from interface:DeltaReplicatedData
Reset collection of deltas from mutator operations. When theReplicator
invokes themodify
function of theUpdate
message the delta is always "reset" and when the user code is invoking one or more mutator operations the data is collecting the delta of the operations and makes it available for theReplicator
with theDeltaReplicatedData.delta()
accessor. When theReplicator
has grabbed thedelta
it will invoke this method to get a clean data instance without the delta.- Specified by:
resetDelta
in interfaceDeltaReplicatedData
-
delta
public scala.Option<ORMap.DeltaOp> delta()
Description copied from interface:DeltaReplicatedData
The accumulated delta of mutator operations since previousDeltaReplicatedData.resetDelta()
. When theReplicator
invokes themodify
function of theUpdate
message and the user code is invoking one or more mutator operations the data is collecting the delta of the operations and makes it available for theReplicator
with theDeltaReplicatedData.delta()
accessor. Themodify
function shall still return the full state in the same way asReplicatedData
without support for deltas.- Specified by:
delta
in interfaceDeltaReplicatedData
-
mergeDelta
public ORMultiMap<A,B> mergeDelta(ORMap.DeltaOp thatDelta)
-
modifiedByNodes
public scala.collection.immutable.Set<UniqueAddress> modifiedByNodes()
Description copied from interface:RemovedNodePruning
The nodes that have changed the state for this data and would need pruning when such node is no longer part of the cluster.- Specified by:
modifiedByNodes
in interfaceRemovedNodePruning
-
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 interfaceRemovedNodePruning
-
pruningCleanup
public ORMultiMap<A,B> 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 interfaceRemovedNodePruning
-
prune
public ORMultiMap<A,B> prune(UniqueAddress removedNode, UniqueAddress collapseInto)
Description copied from interface:RemovedNodePruning
When theremoved
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 interfaceRemovedNodePruning
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-