Package akka.cluster.ddata
Class ORSet<A>
- java.lang.Object
-
- akka.cluster.ddata.ORSet<A>
-
- All Implemented Interfaces:
DeltaReplicatedData
,FastMerge
,RemovedNodePruning
,ReplicatedData
,ReplicatedDataSerialization
,java.io.Serializable
public final class ORSet<A> extends java.lang.Object implements DeltaReplicatedData, ReplicatedDataSerialization, RemovedNodePruning, FastMerge
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ORSet.AddDeltaOp$
static class
ORSet.DeltaGroup$
static interface
ORSet.DeltaOp
static class
ORSet.FullStateDeltaOp$
static class
ORSet.RemoveDeltaOp$
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ORSet<A>
$colon$plus(A element, SelfUniqueAddress node)
Adds an element to the set.ORSet<A>
$minus(A element, Cluster node)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead.ORSet<A>
$plus(A element, Cluster node)
Deprecated.Use `:+` that takes a `SelfUniqueAddress` parameter instead.ORSet<A>
add(Cluster node, A element)
Deprecated.Use `add` that takes a `SelfUniqueAddress` parameter instead.ORSet<A>
add(SelfUniqueAddress node, A element)
Adds an element to the set.static ORSet<java.lang.Object>
apply()
ORSet<A>
clear(Cluster node)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead.ORSet<A>
clear(SelfUniqueAddress node)
Removes all elements from the set, but keeps the history.boolean
contains(A a)
static <A> ORSet<A>
create()
Java APIscala.Option<ORSet.DeltaOp>
delta()
The accumulated delta of mutator operations since previousDeltaReplicatedData.resetDelta()
.scala.collection.immutable.Set<A>
elements()
Scala APIstatic <A> ORSet<A>
empty()
boolean
equals(java.lang.Object o)
java.util.Set<A>
getElements()
Java APIint
hashCode()
boolean
isEmpty()
ORSet<A>
merge(ORSet<A> that)
When element is in this Set but not in that Set: Compare the "birth dot" of the present element to the version vector in the Set it is absent from.ORSet<A>
mergeDelta(ORSet.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.ORSet<A>
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.ORSet<A>
pruningCleanup(UniqueAddress removedNode)
Remove data entries from a node that has been removed from the cluster and already been pruned.ORSet<A>
remove(Cluster node, A element)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead.ORSet<A>
remove(SelfUniqueAddress node, A element)
Java API Removes an element from the set.ORSet<A>
remove(A element, SelfUniqueAddress node)
Scala API Removes an element from the set.ORSet<A>
resetDelta()
Reset collection of deltas from mutator operations.int
size()
java.lang.String
toString()
static <A> scala.Option<scala.collection.immutable.Set<A>>
unapply(ORSet<A> s)
Extract theelements()
.static scala.Option<scala.collection.immutable.Set<java.lang.Object>>
unapply(ReplicatedData a)
Extract theelements()
of anORSet
.-
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.FastMerge
ancestor_$eq, assignAncestor, clearAncestor, isAncestorOf
-
Methods inherited from interface akka.cluster.ddata.ReplicatedData
merge
-
-
-
-
Method Detail
-
empty
public static <A> ORSet<A> empty()
-
apply
public static ORSet<java.lang.Object> apply()
-
create
public static <A> ORSet<A> create()
Java API
-
unapply
public static <A> scala.Option<scala.collection.immutable.Set<A>> unapply(ORSet<A> s)
Extract theelements()
.
-
unapply
public static scala.Option<scala.collection.immutable.Set<java.lang.Object>> unapply(ReplicatedData a)
Extract theelements()
of anORSet
.
-
delta
public scala.Option<ORSet.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
-
elements
public scala.collection.immutable.Set<A> elements()
Scala API
-
getElements
public java.util.Set<A> getElements()
Java API
-
contains
public boolean contains(A a)
-
isEmpty
public boolean isEmpty()
-
size
public int size()
-
$colon$plus
public ORSet<A> $colon$plus(A element, SelfUniqueAddress node)
Adds an element to the set.
-
$plus
public ORSet<A> $plus(A element, Cluster node)
Deprecated.Use `:+` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
add
public ORSet<A> add(SelfUniqueAddress node, A element)
Adds an element to the set.
-
add
public ORSet<A> add(Cluster node, A element)
Deprecated.Use `add` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
remove
public ORSet<A> remove(A element, SelfUniqueAddress node)
Scala API Removes an element from the set.
-
remove
public ORSet<A> remove(SelfUniqueAddress node, A element)
Java API Removes an element from the set.
-
$minus
public ORSet<A> $minus(A element, Cluster node)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.Removes an element from the set.
-
remove
public ORSet<A> remove(Cluster node, A element)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.Removes an element from the set.
-
clear
public ORSet<A> clear(SelfUniqueAddress node)
Removes all elements from the set, but keeps the history. This has the same result as using {@link ORSet#remove(node:akka\.cluster\.ddata\.SelfUniqueAddress*} for each element, but it is more efficient.
-
clear
public ORSet<A> clear(Cluster node)
Deprecated.Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
-
merge
public ORSet<A> merge(ORSet<A> that)
When element is in this Set but not in that Set: Compare the "birth dot" of the present element to the version vector in the Set it is absent from. If the element dot is not "seen" by other Set version vector, that means the other set has yet to see this add, and the element is to be in the merged Set. If the other Set version vector dominates the dot, that means the other Set has removed the element already, and the element is not to be in the merged Set.When element in both this Set and in that Set: Some dots may still need to be shed. If this Set has dots that the other Set does not have, and the other Set version vector dominates those dots, then we need to drop those dots. Keep only common dots, and dots that are not dominated by the other sides version vector
-
mergeDelta
public ORSet<A> mergeDelta(ORSet.DeltaOp thatDelta)
-
resetDelta
public ORSet<A> 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
-
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
-
prune
public ORSet<A> 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
-
pruningCleanup
public ORSet<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 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
-
-