final class ORMultiMap[A, B] extends DeltaReplicatedData with ReplicatedDataSerialization with 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.
Note that on concurrent adds and removals for the same key (on the same set), removals can be lost.
- Annotations
- @SerialVersionUID()
- Source
- ORMultiMap.scala
- Alphabetic
- By Inheritance
- ORMultiMap
- RemovedNodePruning
- ReplicatedDataSerialization
- Serializable
- DeltaReplicatedData
- ReplicatedData
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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
- ORMultiMap → DeltaReplicatedData
- type T = ORMultiMap[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
- ORMultiMap → ReplicatedData
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (ORMultiMap[A, B], B)
- Implicit
- This member is added by an implicit conversion from ORMultiMap[A, B] toArrowAssoc[ORMultiMap[A, B]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- def :+(entry: (A, Set[B]))(implicit node: SelfUniqueAddress): ORMultiMap[A, B]
Convenience for put.
Convenience for put. Requires an implicit SelfUniqueAddress.
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addBinding(node: SelfUniqueAddress, key: A, element: B): ORMultiMap[A, B]
Add an element to a set associated with a key.
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.
- def addBindingBy(key: A, element: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def contains(key: A): Boolean
- def delta: Option[D]
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
- ORMultiMap → DeltaReplicatedData
- def ensuring(cond: (ORMultiMap[A, B]) => Boolean, msg: => Any): ORMultiMap[A, B]
- Implicit
- This member is added by an implicit conversion from ORMultiMap[A, B] toEnsuring[ORMultiMap[A, B]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ORMultiMap[A, B]) => Boolean): ORMultiMap[A, B]
- Implicit
- This member is added by an implicit conversion from ORMultiMap[A, B] toEnsuring[ORMultiMap[A, B]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ORMultiMap[A, B]
- Implicit
- This member is added by an implicit conversion from ORMultiMap[A, B] toEnsuring[ORMultiMap[A, B]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ORMultiMap[A, B]
- Implicit
- This member is added by an implicit conversion from ORMultiMap[A, B] toEnsuring[ORMultiMap[A, B]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def entries: Map[A, Set[B]]
Scala API: All entries of a multimap where keys are strings and values are sets.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(o: Any): Boolean
- Definition Classes
- ORMultiMap → AnyRef → Any
- def get(key: A): Option[Set[B]]
Get the set associated with the key if there is one.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getEntries(): Map[A, Set[B]]
Java API: All entries of a multimap where keys are strings and values are sets.
- def getOrElse(key: A, default: => Set[B]): Set[B]
Scala API: Get the set associated with the key if there is one, else return the given default.
- def hashCode(): Int
- Definition Classes
- ORMultiMap → AnyRef → Any
- def isEmpty: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def merge(that: T): T
Monotonic merge function.
Monotonic merge function.
- Definition Classes
- ORMultiMap → ReplicatedData
- def mergeDelta(thatDelta: D): ORMultiMap[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
- ORMultiMap → 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
- ORMultiMap → 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
- ORMultiMap → RemovedNodePruning
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): T
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
- ORMultiMap → RemovedNodePruning
- def pruningCleanup(removedNode: UniqueAddress): T
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
- ORMultiMap → RemovedNodePruning
- def put(node: SelfUniqueAddress, key: A, value: Set[B]): ORMultiMap[A, B]
Java API: Associate an entire set with the key while retaining the history of the previous replicated data set.
- def put(node: SelfUniqueAddress, key: A, value: Set[B]): ORMultiMap[A, B]
Scala API: Associate an entire set with the key while retaining the history of the previous replicated data set.
- def remove(node: SelfUniqueAddress, key: A): ORMultiMap[A, B]
Java API Remove an entire set associated with the key.
- def remove(key: A)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]
Scala API Remove an entire set associated with the key.
- def removeBinding(node: SelfUniqueAddress, key: A, element: B): ORMultiMap[A, B]
Remove an element of a set associated with a key.
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.
- def removeBindingBy(key: A, element: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]
- def replaceBinding(node: SelfUniqueAddress, key: A, oldElement: B, newElement: B): ORMultiMap[A, B]
Replace an element of a set associated with a key with a new one if it is different.
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.
- def replaceBindingBy(key: A, oldElement: B, newElement: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]
- def resetDelta: ORMultiMap[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
- ORMultiMap → DeltaReplicatedData
- def size: Int
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ORMultiMap → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Shadowed Implicit Value Members
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ORMultiMap[A, B] toany2stringadd[ORMultiMap[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:(oRMultiMap: any2stringadd[ORMultiMap[A, B]]).+(other)
- Definition Classes
- any2stringadd
Deprecated Value Members
- def +(entry: (A, Set[B]))(implicit node: Cluster): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
:+
that takes aSelfUniqueAddress
parameter instead.
- def -(key: A)(implicit node: Cluster): ORMultiMap[A, B]
Convenience for remove.
Convenience for remove. Requires an implicit Cluster.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
remove
that takes aSelfUniqueAddress
parameter instead.- See also
ORMultiMap#remove(node:org\.apache\.pekko\.cluster\.ddata\.SelfUniqueAddress*
- def addBinding(node: Cluster, key: A, element: B): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
addBinding
that takes aSelfUniqueAddress
parameter instead.
- def addBinding(key: A, element: B)(implicit node: Cluster): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
addBinding
that takes aSelfUniqueAddress
parameter instead.
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ORMultiMap[A, B] toStringFormat[ORMultiMap[A, B]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def put(node: Cluster, key: A, value: Set[B]): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
put
that takes aSelfUniqueAddress
parameter instead.
- def put(node: Cluster, key: A, value: Set[B]): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
put
that takes aSelfUniqueAddress
parameter instead.
- def remove(node: Cluster, key: A): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
remove
that takes aSelfUniqueAddress
parameter instead.
- def removeBinding(node: Cluster, key: A, element: B): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
removeBinding
that takes aSelfUniqueAddress
parameter instead.
- def removeBinding(key: A, element: B)(implicit node: Cluster): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
removeBinding
that takes aSelfUniqueAddress
parameter instead.
- def replaceBinding(key: A, oldElement: B, newElement: B)(implicit node: Cluster): ORMultiMap[A, B]
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.20) Use
replaceBinding
that takes aSelfUniqueAddress
parameter instead.
- def →[B](y: B): (ORMultiMap[A, B], B)
- Implicit
- This member is added by an implicit conversion from ORMultiMap[A, B] toArrowAssoc[ORMultiMap[A, B]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.