Class/Object

akka.cluster.ddata

ORMap

Related Docs: object ORMap | package ddata

Permalink

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
Type Hierarchy Learn more about scaladoc diagrams
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]

    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
    ORMapReplicatedData

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

    Permalink

    Adds an entry to the map

    Adds an entry to the map

    See also

    #put

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

    Permalink

    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.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0

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

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

    Permalink
  10. def ensuring(cond: (ORMap[A]) ⇒ Boolean, msg: ⇒ Any): ORMap[A]

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

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

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

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

    Permalink

    Scala API: All entries of the map.

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

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

    Permalink
    Definition Classes
    ORMap → AnyRef → Any
  17. def finalize(): Unit

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

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

    Permalink
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def getEntries(): Map[String, A]

    Permalink

    Java API: All entries of the map.

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

    Permalink

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

  23. def hashCode(): Int

    Permalink
    Definition Classes
    ORMap → AnyRef → Any
  24. def isEmpty: Boolean

    Permalink
  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. def merge(that: ORMap[A]): ORMap[A]

    Permalink

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    ORMapReplicatedData
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. 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
    ORMapRemovedNodePruning
  29. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  31. def prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): ORMap[A]

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

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

    Permalink

    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.

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

    Permalink

    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.

  35. def size: Int

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

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

    Permalink
    Definition Classes
    ORMap → AnyRef → Any
  38. def updated(node: Cluster, key: String, initial: A, modify: Function[A, A]): ORMap[A]

    Permalink

    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.

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

    Permalink

    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.

  40. final def wait(): Unit

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ORMap[A] to ArrowAssoc[ORMap[A]] 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 ORMap[A] to any2stringadd[ORMap[A]] 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:
    (oRMap: any2stringadd[ORMap[A]]).+(other)
    Definition Classes
    any2stringadd

Inherited from RemovedNodePruning

Inherited from Serializable

Inherited from Serializable

Inherited from ReplicatedData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ORMap[A] to any2stringadd[ORMap[A]]

Inherited by implicit conversion StringFormat from ORMap[A] to StringFormat[ORMap[A]]

Inherited by implicit conversion Ensuring from ORMap[A] to Ensuring[ORMap[A]]

Inherited by implicit conversion ArrowAssoc from ORMap[A] to ArrowAssoc[ORMap[A]]

Ungrouped