final class PNCounterMap[A] extends DeltaReplicatedData with ReplicatedDataSerialization with RemovedNodePruning
Map of named counters. Specialized ORMap with PNCounter values.
This class is immutable, i.e. "modifying" methods return a new instance.
- Annotations
- @SerialVersionUID()
- Source
- PNCounterMap.scala
- Alphabetic
- By Inheritance
- PNCounterMap
- RemovedNodePruning
- ReplicatedDataSerialization
- Serializable
- Serializable
- DeltaReplicatedData
- ReplicatedData
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
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 exampleGSet
uses the same type andORSet
uses different types.- Definition Classes
- PNCounterMap → DeltaReplicatedData
-
type
T = PNCounterMap[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
- PNCounterMap → ReplicatedData
Value Members
- def contains(key: A): Boolean
-
def
decrement(node: SelfUniqueAddress, key: A, delta: Long): PNCounterMap[A]
Decrement the counter with the delta specified.
Decrement the counter with the delta specified. If the delta is negative then it will increment instead of decrement. TODO add implicit after deprecated is EOL.
-
def
decrementBy(key: A, delta: Long = 1)(implicit node: SelfUniqueAddress): PNCounterMap[A]
Decrement the counter with the delta specified.
Decrement the counter with the delta specified. If the delta is negative then it will increment instead of decrement. TODO add implicit after deprecated is EOL.
-
def
delta: Option[D]
The accumulated delta of mutator operations since previous #resetDelta.
The accumulated delta of mutator operations since previous #resetDelta. When the
Replicator
invokes themodify
function of theUpdate
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 theReplicator
with the #delta accessor. Themodify
function shall still return the full state in the same way asReplicatedData
without support for deltas.- Definition Classes
- PNCounterMap → DeltaReplicatedData
-
def
entries: Map[A, BigInt]
Scala API
-
def
equals(o: Any): Boolean
- Definition Classes
- PNCounterMap → AnyRef → Any
-
def
get(key: A): Option[BigInt]
Scala API: The count for a key
-
def
getEntries: Map[A, BigInteger]
Java API
-
def
getValue(key: A): BigInteger
Java API: The count for a key, or
null
if it doesn't exist -
def
hashCode(): Int
- Definition Classes
- PNCounterMap → AnyRef → Any
-
def
increment(node: SelfUniqueAddress, key: A, delta: Long): PNCounterMap[A]
Increment the counter with the delta specified.
Increment the counter with the delta specified. If the delta is negative then it will decrement instead of increment.
-
def
increment(key: A, delta: Long = 1)(implicit node: Cluster): PNCounterMap[A]
Increment the counter with the delta specified.
Increment the counter with the delta specified. If the delta is negative then it will decrement instead of increment.
-
def
incrementBy(key: A, delta: Long)(implicit node: SelfUniqueAddress): PNCounterMap[A]
Increment the counter with the delta specified.
Increment the counter with the delta specified. If the delta is negative then it will decrement instead of increment.
- def isEmpty: Boolean
-
def
merge(that: PNCounterMap[A]): PNCounterMap[A]
Monotonic merge function.
Monotonic merge function.
- Definition Classes
- PNCounterMap → ReplicatedData
-
def
mergeDelta(thatDelta: D): PNCounterMap[A]
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 stateT
this method can be implemented by delegating tomerge
.- Definition Classes
- PNCounterMap → DeltaReplicatedData
-
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
- PNCounterMap → RemovedNodePruning
-
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
- PNCounterMap → RemovedNodePruning
-
def
prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): PNCounterMap[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
- PNCounterMap → RemovedNodePruning
-
def
pruningCleanup(removedNode: UniqueAddress): PNCounterMap[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
- PNCounterMap → RemovedNodePruning
-
def
remove(key: A)(implicit node: SelfUniqueAddress): PNCounterMap[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
resetDelta: PNCounterMap[A]
Reset collection of deltas from mutator operations.
Reset collection of deltas from mutator operations. When the
Replicator
invokes themodify
function of theUpdate
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 theReplicator
with the #delta accessor. When theReplicator
has grabbed thedelta
it will invoke this method to get a clean data instance without the delta.- Definition Classes
- PNCounterMap → DeltaReplicatedData
- def size: Int
-
def
toString(): String
- Definition Classes
- PNCounterMap → AnyRef → Any
Deprecated Value Members
-
def
-(key: A)(implicit node: Cluster): PNCounterMap[A]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
remove
that takes aSelfUniqueAddress
parameter instead.
-
def
decrement(node: Cluster, key: A, delta: Long): PNCounterMap[A]
Decrement the counter with the delta specified.
Decrement the counter with the delta specified. If the delta is negative then it will increment instead of decrement.
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
decrement
that takes aSelfUniqueAddress
parameter instead.
-
def
decrement(key: A, delta: Long = 1)(implicit node: Cluster): PNCounterMap[A]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
decrement
that takes aSelfUniqueAddress
parameter instead.
-
def
increment(node: Cluster, key: A, delta: Long): PNCounterMap[A]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
increment
that takes aSelfUniqueAddress
parameter instead.
-
def
remove(node: Cluster, key: A): PNCounterMap[A]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.20) Use
remove
that takes aSelfUniqueAddress
parameter instead.