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
Linear Supertypes
RemovedNodePruning, ReplicatedDataSerialization, Serializable, DeltaReplicatedData, ReplicatedData, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PNCounterMap
  2. RemovedNodePruning
  3. ReplicatedDataSerialization
  4. Serializable
  5. DeltaReplicatedData
  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. Protected

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
    PNCounterMap → DeltaReplicatedData
  2. 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

  1. def contains(key: A): Boolean
  2. 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.

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

  4. 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 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
    PNCounterMap → DeltaReplicatedData
  5. def entries: Map[A, BigInt]

    Scala API

  6. def equals(o: Any): Boolean
    Definition Classes
    PNCounterMap → AnyRef → Any
  7. def get(key: A): Option[BigInt]

    Scala API: The count for a key

  8. def getEntries: Map[A, BigInteger]

    Java API

  9. def getValue(key: A): BigInteger

    Java API: The count for a key, or null if it doesn't exist

  10. def hashCode(): Int
    Definition Classes
    PNCounterMap → AnyRef → Any
  11. 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.

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

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

  14. def isEmpty: Boolean
  15. def merge(that: PNCounterMap[A]): PNCounterMap[A]

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    PNCounterMap → ReplicatedData
  16. 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 state T this method can be implemented by delegating to merge.

    Definition Classes
    PNCounterMap → DeltaReplicatedData
  17. 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
  18. 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
  19. 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
  20. 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
  21. 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.

  22. def resetDelta: PNCounterMap[A]

    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
    PNCounterMap → DeltaReplicatedData
  23. def size: Int
  24. def toString(): String
    Definition Classes
    PNCounterMap → AnyRef → Any

Deprecated Value Members

  1. def -(key: A)(implicit node: Cluster): PNCounterMap[A]
    Annotations
    @deprecated
    Deprecated

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

  2. 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 a SelfUniqueAddress parameter instead.

  3. def decrement(key: A, delta: Long = 1)(implicit node: Cluster): PNCounterMap[A]
    Annotations
    @deprecated
    Deprecated

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

  4. def increment(node: Cluster, key: A, delta: Long): PNCounterMap[A]
    Annotations
    @deprecated
    Deprecated

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

  5. def remove(node: Cluster, key: A): PNCounterMap[A]
    Annotations
    @deprecated
    Deprecated

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