Class/Object

akka.cluster.ddata

ORMultiMap

Related Docs: object ORMultiMap | package ddata

Permalink

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.

Annotations
@SerialVersionUID()
Source
ORMultiMap.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ORMultiMap
  2. RemovedNodePruning
  3. ReplicatedDataSerialization
  4. Serializable
  5. Serializable
  6. DeltaReplicatedData
  7. ReplicatedData
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type D = DeltaOp

    Permalink

    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]

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(entry: (A, Set[B]))(implicit node: Cluster): ORMultiMap[A, B]

    Permalink

    Convenience for put.

    Convenience for put. Requires an implicit Cluster.

    See also

    #put

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

    Permalink

    Convenience for remove.

    Convenience for remove. Requires an implicit Cluster.

    See also

    #remove

  5. def ->[B](y: B): (ORMultiMap[A, B], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMultiMap[A, B] to ArrowAssoc[ORMultiMap[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. def addBinding(node: Cluster, key: A, element: B): ORMultiMap[A, B]

    Permalink

    Java API: Add an element to a set associated with a key.

    Java API: Add an element to a set associated with a key. If there is no existing set then one will be initialised.

  8. def addBinding(key: A, element: B)(implicit node: Cluster): ORMultiMap[A, B]

    Permalink

    Scala API: Add an element to a set associated with a key.

    Scala API: Add an element to a set associated with a key. If there is no existing set then one will be initialised.

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def contains(key: A): Boolean

    Permalink
  12. def delta: Option[D]

    Permalink

    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
  13. def ensuring(cond: (ORMultiMap[A, B]) ⇒ Boolean, msg: ⇒ Any): ORMultiMap[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMultiMap[A, B] to Ensuring[ORMultiMap[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (ORMultiMap[A, B]) ⇒ Boolean): ORMultiMap[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMultiMap[A, B] to Ensuring[ORMultiMap[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): ORMultiMap[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMultiMap[A, B] to Ensuring[ORMultiMap[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): ORMultiMap[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMultiMap[A, B] to Ensuring[ORMultiMap[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def entries: Map[A, Set[B]]

    Permalink

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

  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. def equals(o: Any): Boolean

    Permalink
    Definition Classes
    ORMultiMap → AnyRef → Any
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMultiMap[A, B] to StringFormat[ORMultiMap[A, B]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. def get(key: A): Option[Set[B]]

    Permalink

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

  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  24. def getEntries(): Map[A, Set[B]]

    Permalink

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

  25. def getOrElse(key: A, default: ⇒ Set[B]): Set[B]

    Permalink

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

  26. def hashCode(): Int

    Permalink
    Definition Classes
    ORMultiMap → AnyRef → Any
  27. def isEmpty: Boolean

    Permalink
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def merge(that: T): T

    Permalink

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    ORMultiMapReplicatedData
  30. def mergeDelta(thatDelta: D): ORMultiMap[A, B]

    Permalink

    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
  31. def modifiedByNodes: Set[UniqueAddress]

    Permalink

    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
  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  33. def needPruningFrom(removedNode: UniqueAddress): Boolean

    Permalink

    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
  34. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. def prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): T

    Permalink

    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
  37. def pruningCleanup(removedNode: UniqueAddress): T

    Permalink

    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
  38. def put(node: Cluster, key: A, value: Set[B]): ORMultiMap[A, B]

    Permalink

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

  39. def put(node: Cluster, key: A, value: Set[B]): ORMultiMap[A, B]

    Permalink

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

  40. def remove(node: Cluster, key: A): ORMultiMap[A, B]

    Permalink

    Remove an entire set associated with the key.

  41. def removeBinding(node: Cluster, key: A, element: B): ORMultiMap[A, B]

    Permalink

    Java API: Remove an element of a set associated with a key.

    Java API: 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.

  42. def removeBinding(key: A, element: B)(implicit node: Cluster): ORMultiMap[A, B]

    Permalink

    Scala API: Remove an element of a set associated with a key.

    Scala API: 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.

  43. def replaceBinding(key: A, oldElement: B, newElement: B)(implicit node: Cluster): ORMultiMap[A, B]

    Permalink

    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.

  44. def resetDelta: ORMultiMap[A, B]

    Permalink

    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

    Permalink
  46. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  47. def toString(): String

    Permalink
    Definition Classes
    ORMultiMap → AnyRef → Any
  48. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. def [B](y: B): (ORMultiMap[A, B], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMultiMap[A, B] to ArrowAssoc[ORMultiMap[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMultiMap[A, B] to any2stringadd[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

Inherited from RemovedNodePruning

Inherited from Serializable

Inherited from Serializable

Inherited from DeltaReplicatedData

Inherited from ReplicatedData

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped