PNCounterMap

java.lang.Object
- akka.cluster.ddata.PNCounterMap

All Implemented Interfaces:

RemovedNodePruning, ReplicatedData, ReplicatedDataSerialization, java.io.Serializable
```
public final class PNCounterMap
extends java.lang.Object
implements ReplicatedData, ReplicatedDataSerialization, RemovedNodePruning
```
Map of named counters. Specialized ORMap with PNCounter values.
This class is immutable, i.e. "modifying" methods return a new instance.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PNCounterMap(ORMap<PNCounter> underlying)

Constructors
Constructor and Description
`PNCounterMap(ORMap<PNCounter> underlying)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PNCounterMap`	`apply()`
`boolean`	`contains(java.lang.String key)`
`static PNCounterMap`	`create()` Java API
`PNCounterMap`	`decrement(Cluster node, java.lang.String key, long delta)` Decrement the counter with the delta specified.
`PNCounterMap`	`decrement(java.lang.String key, long delta, Cluster node)` Decrement the counter with the delta specified.
`PNCounterMap`	`decrement(UniqueAddress node, java.lang.String key, long delta)` INTERNAL API
`static PNCounterMap`	`empty()`
`scala.collection.immutable.Map<java.lang.String,scala.math.BigInt>`	`entries()` Scala API
`boolean`	`equals(java.lang.Object o)`
`scala.Option<scala.math.BigInt>`	`get(java.lang.String key)` Scala API: The count for a key
`java.util.Map<java.lang.String,java.math.BigInteger>`	`getEntries()` Java API
`java.math.BigInteger`	`getValue(java.lang.String key)` Java API: The count for a key, or `null` if it doesn't exist
`int`	`hashCode()`
`PNCounterMap`	`increment(Cluster node, java.lang.String key, long delta)` Increment the counter with the delta specified.
`PNCounterMap`	`increment(java.lang.String key, long delta, Cluster node)` Increment the counter with the delta specified.
`PNCounterMap`	`increment(UniqueAddress node, java.lang.String key, long delta)` INTERNAL API
`boolean`	`isEmpty()`
`PNCounterMap`	`merge(PNCounterMap that)`
`boolean`	`needPruningFrom(UniqueAddress removedNode)` Does it have any state changes from a specific node, which has been removed from the cluster.
`PNCounterMap`	`prune(UniqueAddress removedNode, UniqueAddress collapseInto)` 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.
`PNCounterMap`	`pruningCleanup(UniqueAddress removedNode)` Remove data entries from a node that has been removed from the cluster and already been pruned.
`PNCounterMap`	`remove(Cluster node, java.lang.String key)` Removes an entry from the map.
`PNCounterMap`	`remove(UniqueAddress node, java.lang.String key)` INTERNAL API
`int`	`size()`
`java.lang.String`	`toString()`
`static scala.Option<scala.collection.immutable.Map<java.lang.String,scala.math.BigInt>>`	`unapply(PNCounterMap m)` Extract the `entries()`.
`ORMap<PNCounter>`	`underlying()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface akka.cluster.ddata.ReplicatedData
merge

- Constructor Detail
  - PNCounterMap
```
public PNCounterMap(ORMap<PNCounter> underlying)
```
- Method Detail
  - empty
```
public static PNCounterMap empty()
```
  - apply
```
public static PNCounterMap apply()
```
  - create
```
public static PNCounterMap create()
```
    Java API
    
    Returns:
    
    (undocumented)
  - unapply
```
public static scala.Option<scala.collection.immutable.Map<java.lang.String,scala.math.BigInt>> unapply(PNCounterMap m)
```
    Extract the entries().
    
    Parameters:
    
    m - (undocumented)
    
    Returns:
    
    (undocumented)
  - underlying
```
public ORMap<PNCounter> underlying()
```
  - entries
```
public scala.collection.immutable.Map<java.lang.String,scala.math.BigInt> entries()
```
    Scala API
  - getEntries
```
public java.util.Map<java.lang.String,java.math.BigInteger> getEntries()
```
    Java API
  - get
```
public scala.Option<scala.math.BigInt> get(java.lang.String key)
```
    Scala API: The count for a key
    
    Parameters:
    
    key - (undocumented)
    
    Returns:
    
    (undocumented)
  - getValue
```
public java.math.BigInteger getValue(java.lang.String key)
```
    Java API: The count for a key, or null if it doesn't exist
    
    Parameters:
    
    key - (undocumented)
    
    Returns:
    
    (undocumented)
  - contains
```
public boolean contains(java.lang.String key)
```
  - isEmpty
```
public boolean isEmpty()
```
  - size
```
public int size()
```
  - increment
```
public PNCounterMap increment(java.lang.String key,
                              long delta,
                              Cluster node)
```
    Increment the counter with the delta specified. If the delta is negative then it will decrement instead of increment.
    
    Parameters:
    
    key - (undocumented)
    
    delta - (undocumented)
    
    node - (undocumented)
    
    Returns:
    
    (undocumented)
  - increment
```
public PNCounterMap increment(Cluster node,
                              java.lang.String key,
                              long delta)
```
    Increment the counter with the delta specified. If the delta is negative then it will decrement instead of increment.
    
    Parameters:
    
    node - (undocumented)
    
    key - (undocumented)
    
    delta - (undocumented)
    
    Returns:
    
    (undocumented)
  - increment
```
public PNCounterMap increment(UniqueAddress node,
                              java.lang.String key,
                              long delta)
```
    INTERNAL API
    
    Parameters:
    
    node - (undocumented)
    
    key - (undocumented)
    
    delta - (undocumented)
    
    Returns:
    
    (undocumented)
  - decrement
```
public PNCounterMap decrement(java.lang.String key,
                              long delta,
                              Cluster node)
```
    Decrement the counter with the delta specified. If the delta is negative then it will increment instead of decrement.
    
    Parameters:
    
    key - (undocumented)
    
    delta - (undocumented)
    
    node - (undocumented)
    
    Returns:
    
    (undocumented)
  - decrement
```
public PNCounterMap decrement(Cluster node,
                              java.lang.String key,
                              long delta)
```
    Decrement the counter with the delta specified. If the delta is negative then it will increment instead of decrement.
    
    Parameters:
    
    node - (undocumented)
    
    key - (undocumented)
    
    delta - (undocumented)
    
    Returns:
    
    (undocumented)
  - decrement
```
public PNCounterMap decrement(UniqueAddress node,
                              java.lang.String key,
                              long delta)
```
    INTERNAL API
    
    Parameters:
    
    node - (undocumented)
    
    key - (undocumented)
    
    delta - (undocumented)
    
    Returns:
    
    (undocumented)
  - remove
```
public PNCounterMap remove(Cluster node,
                           java.lang.String key)
```
    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.
    
    Parameters:
    
    node - (undocumented)
    
    key - (undocumented)
    
    Returns:
    
    (undocumented)
  - remove
```
public PNCounterMap remove(UniqueAddress node,
                           java.lang.String key)
```
    INTERNAL API
    
    Parameters:
    
    node - (undocumented)
    
    key - (undocumented)
    
    Returns:
    
    (undocumented)
  - merge
```
public PNCounterMap merge(PNCounterMap that)
```
  - needPruningFrom
```
public boolean needPruningFrom(UniqueAddress removedNode)
```
    Description copied from interface: RemovedNodePruning
    
    Does it have any state changes from a specific node, which has been removed from the cluster.
    
    Specified by:
    
    needPruningFrom in interface RemovedNodePruning
    
    Parameters:
    
    removedNode - (undocumented)
    
    Returns:
    
    (undocumented)
  - prune
```
public PNCounterMap prune(UniqueAddress removedNode,
                          UniqueAddress collapseInto)
```
    Description copied from interface: RemovedNodePruning
    
    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.
    
    Specified by:
    
    prune in interface RemovedNodePruning
    
    Parameters:
    
    removedNode - (undocumented)
    
    collapseInto - (undocumented)
    
    Returns:
    
    (undocumented)
  - pruningCleanup
```
public PNCounterMap pruningCleanup(UniqueAddress removedNode)
```
    Description copied from interface: RemovedNodePruning
    
    Remove data entries from a node that has been removed from the cluster and already been pruned.
    
    Specified by:
    
    pruningCleanup in interface RemovedNodePruning
    
    Parameters:
    
    removedNode - (undocumented)
    
    Returns:
    
    (undocumented)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class PNCounterMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface akka.cluster.ddata.ReplicatedData

Constructor Detail

PNCounterMap

Method Detail

empty

apply

create

unapply

underlying

entries

getEntries

get

getValue

contains

isEmpty

size

increment

increment

increment

decrement

decrement

decrement

remove

remove

merge

needPruningFrom

prune

pruningCleanup

toString

equals

hashCode