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
- Alphabetic
- By Inheritance
- ORMap
- RemovedNodePruning
- ReplicatedDataSerialization
- Serializable
- Serializable
- ReplicatedData
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(entry: (String, A))(implicit node: Cluster): ORMap[A]
Adds an entry to the map
Adds an entry to the map
- See also
-
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.
- def ->[B](y: B): (ORMap[A], B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def contains(key: String): Boolean
- def ensuring(cond: (ORMap[A]) ⇒ Boolean, msg: ⇒ Any): ORMap[A]
- def ensuring(cond: (ORMap[A]) ⇒ Boolean): ORMap[A]
- def ensuring(cond: Boolean, msg: ⇒ Any): ORMap[A]
- def ensuring(cond: Boolean): ORMap[A]
-
def
entries: Map[String, A]
Scala API: All entries of the map.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(o: Any): Boolean
- Definition Classes
- ORMap → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
- def get(key: String): Option[A]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getEntries(): Map[String, A]
Java API: All entries of the map.
-
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.
-
def
hashCode(): Int
- Definition Classes
- ORMap → AnyRef → Any
- def isEmpty: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
merge(that: ORMap[A]): ORMap[A]
Monotonic merge function.
Monotonic merge function.
- Definition Classes
- ORMap → ReplicatedData
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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
-
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
-
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 whatReplicatedData
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 existingORSet
value, because important history can be lost when replacing theORSet
and undesired effects of merging will occur. Use ORMultiMap or #updated instead. -
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.
- def size: Int
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- ORMap → AnyRef → Any
-
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
theinitial
value will be passed to themodify
function. -
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
theinitial
value will be passed to themodify
function. -
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (ORMap[A], B)
Shadowed Implicit Value Members
-
def
+(other: String): String
- Implicit
- 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