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
Linear Supertypes
RemovedNodePruning, ReplicatedDataSerialization, Serializable, DeltaReplicatedData, ReplicatedData, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ORMap
  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
    ORMap → DeltaReplicatedData
  2. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ORMap[A, B] toany2stringadd[ORMap[A, B]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ORMap[A, B], B)
    Implicit
    This member is added by an implicit conversion from ORMap[A, B] toArrowAssoc[ORMap[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def :+(entry: (A, B))(implicit node: SelfUniqueAddress): ORMap[A, B]

    Adds an entry to the map

    Adds an entry to the map

    See also

    ORMap#put(node:akka\.cluster\.ddata\.SelfUniqueAddress*

  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def contains(key: A): Boolean
  10. 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 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
    ORMap → DeltaReplicatedData
  11. def ensuring(cond: (ORMap[A, B]) => Boolean, msg: => Any): ORMap[A, B]
    Implicit
    This member is added by an implicit conversion from ORMap[A, B] toEnsuring[ORMap[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ORMap[A, B]) => Boolean): ORMap[A, B]
    Implicit
    This member is added by an implicit conversion from ORMap[A, B] toEnsuring[ORMap[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): ORMap[A, B]
    Implicit
    This member is added by an implicit conversion from ORMap[A, B] toEnsuring[ORMap[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ORMap[A, B]
    Implicit
    This member is added by an implicit conversion from ORMap[A, B] toEnsuring[ORMap[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def entries: Map[A, B]

    Scala API: All entries of the map.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(o: Any): Boolean
    Definition Classes
    ORMap → AnyRef → Any
  18. def get(key: A): Option[B]
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def getEntries(): Map[A, B]

    Java API: All entries of the map.

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

  22. def hashCode(): Int
    Definition Classes
    ORMap → AnyRef → Any
  23. def isEmpty: Boolean
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def merge(that: ORMap[A, B]): ORMap[A, B]

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    ORMap → ReplicatedData
  26. 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 state T this method can be implemented by delegating to merge.

    Definition Classes
    ORMap → DeltaReplicatedData
  27. 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
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. 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
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. 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
  33. 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
  34. 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 what ReplicatedData 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 existing ORSet value, because important history can be lost when replacing the ORSet and undesired effects of merging will occur. Use ORMultiMap or ORMap#updated(node:akka\.cluster\.ddata\.SelfUniqueAddress* instead.

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

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

  37. def resetDelta: ORMap[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
    ORMap → DeltaReplicatedData
  38. def size: Int
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    ORMap → AnyRef → Any
  41. 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 the initial value will be passed to the modify function.

  42. 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 the initial value will be passed to the modify function.

  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ORMap[A, B] toStringFormat[ORMap[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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. 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 the initial value will be passed to the modify function.

    Annotations
    @Deprecated @deprecated
    Deprecated

    (Since version 2.5.20) use update for the Java API as updated is ambiguous with the Scala API

  4. def →[B](y: B): (ORMap[A, B], B)
    Implicit
    This member is added by an implicit conversion from ORMap[A, B] toArrowAssoc[ORMap[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 ReplicatedDataSerialization

Inherited from Serializable

Inherited from DeltaReplicatedData

Inherited from ReplicatedData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromORMap[A, B] to any2stringadd[ORMap[A, B]]

Inherited by implicit conversion StringFormat fromORMap[A, B] to StringFormat[ORMap[A, B]]

Inherited by implicit conversion Ensuring fromORMap[A, B] to Ensuring[ORMap[A, B]]

Inherited by implicit conversion ArrowAssoc fromORMap[A, B] to ArrowAssoc[ORMap[A, B]]

Ungrouped