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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ORMultiMap
  2. RemovedNodePruning
  3. ReplicatedDataSerialization
  4. Serializable
  5. DeltaReplicatedData
  6. ReplicatedData
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

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

    Definition Classes
    ORMultiMapDeltaReplicatedData
  2. 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
    ORMultiMapReplicatedData

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. 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()
  4. def :+(entry: (A, Set[B]))(implicit node: SelfUniqueAddress): ORMultiMap[A, B]

    Convenience for put.

    Convenience for put. Requires an implicit SelfUniqueAddress.

    See also

    ORMultiMap#put(node:akka\.cluster\.ddata\.SelfUniqueAddress,key:A,value:Set*

  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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.

  7. def addBindingBy(key: A, element: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. def contains(key: A): Boolean
  11. 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 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.

    Definition Classes
    ORMultiMapDeltaReplicatedData
  12. 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
  13. 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
  14. 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
  15. 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
  16. def entries: Map[A, Set[B]]

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

  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(o: Any): Boolean
    Definition Classes
    ORMultiMap → AnyRef → Any
  19. 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
    @inline()
  20. def get(key: A): Option[Set[B]]

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

  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def getEntries(): Map[A, Set[B]]

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

  23. 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.

  24. def hashCode(): Int
    Definition Classes
    ORMultiMap → AnyRef → Any
  25. def isEmpty: Boolean
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def merge(that: T): T

    Monotonic merge function.

    Monotonic merge function.

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

    Definition Classes
    ORMultiMapDeltaReplicatedData
  29. 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
    ORMultiMapRemovedNodePruning
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. 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
    ORMultiMapRemovedNodePruning
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. 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
    ORMultiMapRemovedNodePruning
  35. 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
    ORMultiMapRemovedNodePruning
  36. 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.

  37. 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.

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

    Java API Remove an entire set associated with the key.

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

    Scala API Remove an entire set associated with the key.

  40. 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.

  41. def removeBindingBy(key: A, element: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]
  42. 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.

  43. def replaceBindingBy(key: A, oldElement: B, newElement: B)(implicit node: SelfUniqueAddress): ORMultiMap[A, B]
  44. def resetDelta: ORMultiMap[A, B]

    Reset collection of deltas from mutator operations.

    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.

    Definition Classes
    ORMultiMapDeltaReplicatedData
  45. def size: Int
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. def toString(): String
    Definition Classes
    ORMultiMap → AnyRef → Any
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Shadowed Implicit Value Members

  1. 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

  1. def +(entry: (A, Set[B]))(implicit node: Cluster): ORMultiMap[A, B]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.20) Use :+ that takes a SelfUniqueAddress parameter instead.

  2. def -(key: A)(implicit node: Cluster): ORMultiMap[A, B]

    Convenience for remove.

    Convenience for remove. Requires an implicit Cluster.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.20) Use remove that takes a SelfUniqueAddress parameter instead.

    See also

    ORMultiMap#remove(node:akka\.cluster\.ddata\.SelfUniqueAddress*

  3. def addBinding(node: Cluster, key: A, element: B): ORMultiMap[A, B]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.20) Use addBinding that takes a SelfUniqueAddress parameter instead.

  4. def addBinding(key: A, element: B)(implicit node: Cluster): ORMultiMap[A, B]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.20) Use addBinding that takes a SelfUniqueAddress parameter instead.

  5. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  6. def put(node: Cluster, key: A, value: Set[B]): ORMultiMap[A, B]
    Annotations
    @Deprecated @deprecated
    Deprecated

    (Since version 2.5.20) Use put that takes a SelfUniqueAddress parameter instead.

  7. def put(node: Cluster, key: A, value: Set[B]): ORMultiMap[A, B]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.20) Use put that takes a SelfUniqueAddress parameter instead.

  8. def remove(node: Cluster, key: A): ORMultiMap[A, B]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.20) Use remove that takes a SelfUniqueAddress parameter instead.

  9. def removeBinding(node: Cluster, key: A, element: B): ORMultiMap[A, B]
    Annotations
    @Deprecated @deprecated
    Deprecated

    (Since version 2.5.20) Use removeBinding that takes a SelfUniqueAddress parameter instead.

  10. def removeBinding(key: A, element: B)(implicit node: Cluster): ORMultiMap[A, B]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.20) Use removeBinding that takes a SelfUniqueAddress parameter instead.

  11. def replaceBinding(key: A, oldElement: B, newElement: B)(implicit node: Cluster): ORMultiMap[A, B]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.20) Use replaceBinding that takes a SelfUniqueAddress parameter instead.

  12. 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.

Inherited from RemovedNodePruning

Inherited from Serializable

Inherited from DeltaReplicatedData

Inherited from ReplicatedData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromORMultiMap[A, B] to any2stringadd[ORMultiMap[A, B]]

Inherited by implicit conversion StringFormat fromORMultiMap[A, B] to StringFormat[ORMultiMap[A, B]]

Inherited by implicit conversion Ensuring fromORMultiMap[A, B] to Ensuring[ORMultiMap[A, B]]

Inherited by implicit conversion ArrowAssoc fromORMultiMap[A, B] to ArrowAssoc[ORMultiMap[A, B]]

Ungrouped