Apache Pekko
1.0.1
API
Generated with
Apache Pekko/org.apache.pekko.cluster.ddata/ORMultiMap

ORMultiMap

org.apache.pekko.cluster.ddata.ORMultiMap
See theORMultiMap companion object
final class ORMultiMap[A, B] extends DeltaReplicatedData, 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.

Note that on concurrent adds and removals for the same key (on the same set), removals can be lost.

Attributes

Companion
object
Source
ORMultiMap.scala
Graph
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

override type D = DeltaOp

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 example GSet uses the same type and ORSet uses different types.

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 example GSet uses the same type and ORSet uses different types.

Attributes

Source
ORMultiMap.scala
override type T = ORMultiMap[A, B]

The type of the concrete implementation, e.g. GSet[A]. To be specified by subclass.

The type of the concrete implementation, e.g. GSet[A]. To be specified by subclass.

Attributes

Source
ORMultiMap.scala

Value members

Concrete methods

def :+(entry: (A, Set[B]))(implicit node: SelfUniqueAddress): ORMultiMap[A, B]

Convenience for put. Requires an implicit SelfUniqueAddress.

Convenience for put. Requires an implicit SelfUniqueAddress.

Attributes

See also

ORMultiMap#put

Source
ORMultiMap.scala
def addBinding(node: SelfUniqueAddress, key: A, element: B): ORMultiMap[A, B]

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.

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.

Attributes

Source
ORMultiMap.scala
def addBindingBy(key: A, element: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]

Attributes

Source
ORMultiMap.scala
def contains(key: A): Boolean

Attributes

Source
ORMultiMap.scala
override def delta: Option[D]

The accumulated delta of mutator operations since previous resetDelta. When the Replicator invokes the modify function of the Update 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 the Replicator with the delta accessor. The modify function shall still return the full state in the same way as ReplicatedData without support for deltas.

The accumulated delta of mutator operations since previous resetDelta. When the Replicator invokes the modify function of the Update 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 the Replicator with the delta accessor. The modify function shall still return the full state in the same way as ReplicatedData without support for deltas.

Attributes

Definition Classes
Source
ORMultiMap.scala
def entries: Map[A, Set[B]]

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

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

Attributes

Source
ORMultiMap.scala
override def equals(o: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
Source
ORMultiMap.scala
def get(key: A): Option[Set[B]]

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

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

Attributes

Source
ORMultiMap.scala
def getEntries(): Map[A, Set[B]]

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

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

Attributes

Source
ORMultiMap.scala
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.

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

Attributes

Source
ORMultiMap.scala
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
Source
ORMultiMap.scala
def isEmpty: Boolean

Attributes

Source
ORMultiMap.scala
override def merge(that: T): T

Monotonic merge function.

Monotonic merge function.

Attributes

Definition Classes
Source
ORMultiMap.scala
override def mergeDelta(thatDelta: D): ORMultiMap[A, B]

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 state T this method can be implemented by delegating to merge.

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 state T this method can be implemented by delegating to merge.

Attributes

Definition Classes
Source
ORMultiMap.scala
override 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.

Attributes

Definition Classes
Source
ORMultiMap.scala
override 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.

Attributes

Definition Classes
Source
ORMultiMap.scala
override 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.

Attributes

Definition Classes
Source
ORMultiMap.scala
override 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.

Attributes

Definition Classes
Source
ORMultiMap.scala
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.

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

Attributes

Source
ORMultiMap.scala
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.

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

Attributes

Source
ORMultiMap.scala
def remove(key: A)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]

Scala API Remove an entire set associated with the key.

Scala API Remove an entire set associated with the key.

Attributes

Source
ORMultiMap.scala
def remove(node: SelfUniqueAddress, key: A): ORMultiMap[A, B]

Java API Remove an entire set associated with the key.

Java API Remove an entire set associated with the key.

Attributes

Source
ORMultiMap.scala
def removeBinding(node: SelfUniqueAddress, key: A, element: B): ORMultiMap[A, B]

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.

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.

Attributes

Source
ORMultiMap.scala
def removeBindingBy(key: A, element: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]

Attributes

Source
ORMultiMap.scala
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. 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.

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.

Attributes

Source
ORMultiMap.scala
def replaceBindingBy(key: A, oldElement: B, newElement: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]

Attributes

Source
ORMultiMap.scala
override def resetDelta: ORMultiMap[A, B]

Reset collection of deltas from mutator operations. When the Replicator invokes the modify function of the Update 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 the Replicator with the delta accessor. When the Replicator has grabbed the delta it will invoke this method to get a clean data instance without the delta.

Reset collection of deltas from mutator operations. When the Replicator invokes the modify function of the Update 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 the Replicator with the delta accessor. When the Replicator has grabbed the delta it will invoke this method to get a clean data instance without the delta.

Attributes

Definition Classes
Source
ORMultiMap.scala
def size: Int

Attributes

Source
ORMultiMap.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
ORMultiMap.scala

Deprecated methods

def +(entry: (A, Set[B]))(implicit node: Cluster): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def -(key: A)(implicit node: Cluster): ORMultiMap[A, B]

Convenience for remove. Requires an implicit Cluster.

Convenience for remove. Requires an implicit Cluster.

Attributes

See also

ORMultiMap#remove

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def addBinding(key: A, element: B)(implicit node: Cluster): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def addBinding(node: Cluster, key: A, element: B): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def put(node: Cluster, key: A, value: Set[B]): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def put(node: Cluster, key: A, value: Set[B]): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def remove(node: Cluster, key: A): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def removeBinding(key: A, element: B)(implicit node: Cluster): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def removeBinding(node: Cluster, key: A, element: B): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
def replaceBinding(key: A, oldElement: B, newElement: B)(implicit node: Cluster): ORMultiMap[A, B]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
ORMultiMap.scala
Generated with