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, Serializable, DeltaReplicatedData, ReplicatedData, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ORMap
  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

    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. def :+(entry: (A, B))(implicit node: SelfUniqueAddress): ORMap[A, B]

    Adds an entry to the map

    Adds an entry to the map

    See also

    #put

  2. def contains(key: A): Boolean
  3. 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
  4. def entries: Map[A, B]

    Scala API: All entries of the map.

  5. def equals(o: Any): Boolean
    Definition Classes
    ORMap → AnyRef → Any
  6. def get(key: A): Option[B]
  7. def getEntries(): Map[A, B]

    Java API: All entries of the map.

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

  9. def hashCode(): Int
    Definition Classes
    ORMap → AnyRef → Any
  10. def isEmpty: Boolean
  11. def merge(that: ORMap[A, B]): ORMap[A, B]

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    ORMap → ReplicatedData
  12. 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
  13. 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
  14. 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
  15. 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
  16. 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
  17. 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 #updated 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 #updated instead.

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

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

  20. 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
  21. def size: Int
  22. def toString(): String
    Definition Classes
    ORMap → AnyRef → Any
  23. 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.

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

Deprecated Value Members

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

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

  2. def -(key: A)(implicit node: Cluster): ORMap[A, B]
    Annotations
    @deprecated
    Deprecated

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

  3. def put(node: Cluster, key: A, value: B): ORMap[A, B]
    Annotations
    @deprecated
    Deprecated

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

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

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

  5. def update(node: Cluster, key: A, initial: B, modify: Function[B, B]): ORMap[A, B]
    Annotations
    @Deprecated @deprecated
    Deprecated

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

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

  7. def updated(node: Cluster, key: A, initial: B)(modify: (B) ⇒ B): ORMap[A, B]
    Annotations
    @deprecated
    Deprecated

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