final class ORMap[A, B <: ReplicatedData] extends DeltaReplicatedData with ReplicatedDataSerialization with RemovedNodePruning
Implements a 'Observed Remove Map' CRDT, also called a 'OR-Map'.
It has similar semantics as an ORSet, but in case of concurrent updates the values are merged, and must therefore be ReplicatedData types themselves.
This class is immutable, i.e. "modifying" methods return a new instance.
- Annotations
- @SerialVersionUID()
- Source
- ORMap.scala
- Alphabetic
- By Inheritance
- ORMap
- RemovedNodePruning
- ReplicatedDataSerialization
- Serializable
- Serializable
- DeltaReplicatedData
- ReplicatedData
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
type
D = DeltaOp
The type of the delta.
The type of the delta. To be specified by subclass. It may be the same type as
T
or a different type if needed. For exampleGSet
uses the same type andORSet
uses different types.- Definition Classes
- ORMap → DeltaReplicatedData
-
type
T = ORMap[A, B]
The type of the concrete implementation, e.g.
The type of the concrete implementation, e.g.
GSet[A]
. To be specified by subclass.- Definition Classes
- ORMap → ReplicatedData
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (ORMap[A, B], B)
-
def
:+(entry: (A, B))(implicit node: SelfUniqueAddress): ORMap[A, B]
Adds an entry to the map
Adds an entry to the map
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
- def contains(key: A): Boolean
-
val
delta: Option[DeltaOp]
The accumulated delta of mutator operations since previous #resetDelta.
The accumulated delta of mutator operations since previous #resetDelta. When the
Replicator
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 the #delta accessor. Themodify
function shall still return the full state in the same way asReplicatedData
without support for deltas.- Definition Classes
- ORMap → DeltaReplicatedData
- def ensuring(cond: (ORMap[A, B]) ⇒ Boolean, msg: ⇒ Any): ORMap[A, B]
- def ensuring(cond: (ORMap[A, B]) ⇒ Boolean): ORMap[A, B]
- def ensuring(cond: Boolean, msg: ⇒ Any): ORMap[A, B]
- def ensuring(cond: Boolean): ORMap[A, B]
-
def
entries: Map[A, B]
Scala API: All entries of the map.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(o: Any): Boolean
- Definition Classes
- ORMap → AnyRef → Any
- def formatted(fmtstr: String): String
- def get(key: A): Option[B]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getEntries(): Map[A, B]
Java API: All entries of the map.
-
def
getOrElse(key: A, default: ⇒ B): B
Scala API: Get the value associated with the key if there is one, else return the given default.
-
def
hashCode(): Int
- Definition Classes
- ORMap → AnyRef → Any
- def isEmpty: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
merge(that: ORMap[A, B]): ORMap[A, B]
Monotonic merge function.
Monotonic merge function.
- Definition Classes
- ORMap → ReplicatedData
-
def
mergeDelta(thatDelta: DeltaOp): ORMap[A, B]
When delta is merged into the full state this method is used.
When delta is merged into the full state this method is used. When the type
D
of the delta is of the same type as the full stateT
this method can be implemented by delegating tomerge
.- Definition Classes
- ORMap → DeltaReplicatedData
-
def
modifiedByNodes: Set[UniqueAddress]
The nodes that have changed the state for this data and would need pruning when such node is no longer part of the cluster.
The nodes that have changed the state for this data and would need pruning when such node is no longer part of the cluster.
- Definition Classes
- ORMap → RemovedNodePruning
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
needPruningFrom(removedNode: UniqueAddress): Boolean
Does it have any state changes from a specific node, which has been removed from the cluster.
Does it have any state changes from a specific node, which has been removed from the cluster.
- Definition Classes
- ORMap → RemovedNodePruning
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): ORMap[A, B]
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.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.- Definition Classes
- ORMap → RemovedNodePruning
-
def
pruningCleanup(removedNode: UniqueAddress): ORMap[A, B]
Remove data entries from a node that has been removed from the cluster and already been pruned.
Remove data entries from a node that has been removed from the cluster and already been pruned.
- Definition Classes
- ORMap → RemovedNodePruning
-
def
put(node: SelfUniqueAddress, key: A, value: B): ORMap[A, B]
Adds an entry to the map.
Adds an entry to the map. Note that the new
value
will be merged with existing values on other nodes and the outcome depends on whatReplicatedData
type that is used.Consider using ORMap#updated(node:akka\.cluster\.ddata\.SelfUniqueAddress* instead of
put
if you want modify existing entry.IllegalArgumentException
is thrown if you try to replace an existingORSet
value, because important history can be lost when replacing theORSet
and undesired effects of merging will occur. Use ORMultiMap or ORMap#updated(node:akka\.cluster\.ddata\.SelfUniqueAddress* instead. -
def
remove(node: SelfUniqueAddress, key: A): ORMap[A, B]
Java API Removes an entry from the map.
Java API Removes an entry from the map. Note that if there is a conflicting update on another node the entry will not be removed after merge.
-
def
remove(key: A)(implicit node: SelfUniqueAddress): ORMap[A, B]
Scala API Removes an entry from the map.
Scala API Removes an entry from the map. Note that if there is a conflicting update on another node the entry will not be removed after merge.
-
def
resetDelta: ORMap[A, B]
Reset collection of deltas from mutator operations.
Reset collection of deltas from mutator operations. When the
Replicator
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 the #delta accessor. When theReplicator
has grabbed thedelta
it will invoke this method to get a clean data instance without the delta.- Definition Classes
- ORMap → DeltaReplicatedData
- def size: Int
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- ORMap → AnyRef → Any
-
def
update(node: SelfUniqueAddress, key: A, initial: B, modify: Function[B, B]): ORMap[A, B]
Java API: Replace a value by applying the
modify
function on the existing value.Java API: Replace a value by applying the
modify
function on the existing value.If there is no current value for the
key
theinitial
value will be passed to themodify
function. -
def
updated(node: SelfUniqueAddress, key: A, initial: B)(modify: (B) ⇒ B): ORMap[A, B]
Scala API: Replace a value by applying the
modify
function on the existing value.Scala API: Replace a value by applying the
modify
function on the existing value.If there is no current value for the
key
theinitial
value will be passed to themodify
function. -
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (ORMap[A, B], B)
Shadowed Implicit Value Members
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from ORMap[A, B] to any2stringadd[ORMap[A, B]] performed by method any2stringadd in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(oRMap: any2stringadd[ORMap[A, B]]).+(other)
- Definition Classes
- any2stringadd
Deprecated Value Members
-
def
+(entry: (A, B))(implicit node: Cluster): ORMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
:+
that takes aSelfUniqueAddress
parameter instead.
-
def
-(key: A)(implicit node: Cluster): ORMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
remove
that takes aSelfUniqueAddress
parameter instead.
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
- Deprecated
(Since version ) see corresponding Javadoc for more information.
-
def
put(node: Cluster, key: A, value: B): ORMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
put
that takes aSelfUniqueAddress
parameter instead.
-
def
remove(node: Cluster, key: A): ORMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
remove
that takes aSelfUniqueAddress
parameter instead.
-
def
update(node: Cluster, key: A, initial: B, modify: Function[B, B]): ORMap[A, B]
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.20) Use
update
that takes aSelfUniqueAddress
parameter instead.
-
def
updated(node: Cluster, key: A, initial: B, modify: Function[B, B]): ORMap[A, B]
Java API: Replace a value by applying the
modify
function on the existing value.Java API: Replace a value by applying the
modify
function on the existing value.If there is no current value for the
key
theinitial
value will be passed to themodify
function.- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.20) use update for the Java API as updated is ambiguous with the Scala API
-
def
updated(node: Cluster, key: A, initial: B)(modify: (B) ⇒ B): ORMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
updated
that takes aSelfUniqueAddress
parameter instead.