final class ORMap[A <: ReplicatedData] extends ReplicatedData 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, ReplicatedData, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ORMap
  2. RemovedNodePruning
  3. ReplicatedDataSerialization
  4. Serializable
  5. Serializable
  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. All

Type Members

  1. type T = ORMap[A]

    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: (String, A))(implicit node: Cluster): ORMap[A]

    Adds an entry to the map

    Adds an entry to the map

    See also

    #put

  2. def -(key: String)(implicit node: Cluster): ORMap[A]

    Removes an entry from the map.

    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.

  3. def contains(key: String): Boolean
  4. def entries: Map[String, A]

    Scala API: All entries of the map.

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

    Java API: All entries of the map.

  8. def getOrElse(key: String, default: ⇒ A): A

    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]): ORMap[A]

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    ORMap → ReplicatedData
  12. 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
  13. def prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): ORMap[A]

    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
  14. def pruningCleanup(removedNode: UniqueAddress): ORMap[A]

    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
  15. def put(node: Cluster, key: String, value: A): ORMap[A]

    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.

  16. def remove(node: Cluster, key: String): ORMap[A]

    Removes an entry from the map.

    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.

  17. def size: Int
  18. def toString(): String
    Definition Classes
    ORMap → AnyRef → Any
  19. def updated(node: Cluster, key: String, initial: A, modify: Function[A, A]): ORMap[A]

    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.

  20. def updated(node: Cluster, key: String, initial: A)(modify: (A) ⇒ A): ORMap[A]

    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.