Package akka.cluster.ddata

Class PNCounterMap<A>

java.lang.Object

akka.cluster.ddata.PNCounterMap<A>

All Implemented Interfaces:

DeltaReplicatedData, RemovedNodePruning, ReplicatedData, ReplicatedDataSerialization, java.io.Serializable, scala.Serializable

public final class PNCounterMap<A>
extends java.lang.Object
implements DeltaReplicatedData, ReplicatedDataSerialization, RemovedNodePruning

Scala API

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PNCounterMap.PNCounterMapTag$

Constructor Summary

Constructors

Constructor	Description
PNCounterMap(ORMap<A,PNCounter> underlying)

Method Summary

Modifier and Type	Method	Description
PNCounterMap<A>	$minus(A key, Cluster node)	Deprecated. Use `remove` that takes a `SelfUniqueAddress` parameter instead.
static <A> PNCounterMap<A>	apply()
boolean	contains(A key)
static <A> PNCounterMap<A>	create()	Java API
PNCounterMap<A>	decrement(Cluster node, A key, long delta)	Deprecated. Use `decrement` that takes a `SelfUniqueAddress` parameter instead.
PNCounterMap<A>	decrement(SelfUniqueAddress node, A key, long delta)	Decrement the counter with the delta specified.
PNCounterMap<A>	decrement(UniqueAddress node, A key, long delta)	INTERNAL API
PNCounterMap<A>	decrement(A key, long delta, Cluster node)	Deprecated. Use `decrement` that takes a `SelfUniqueAddress` parameter instead.
long	decrement$default$2()	Decrement the counter with the delta specified.
PNCounterMap<A>	decrementBy(A key, long delta, SelfUniqueAddress node)	Decrement the counter with the delta specified.
long	decrementBy$default$2()
scala.Option<ORMap.DeltaOp>	delta()	The accumulated delta of mutator operations since previous DeltaReplicatedData.resetDelta().
static <A> PNCounterMap<A>	empty()
scala.collection.immutable.Map<A,scala.math.BigInt>	entries()	Scala API
boolean	equals(java.lang.Object o)
scala.Option<scala.math.BigInt>	get(A key)	Scala API: The count for a key
java.util.Map<A,java.math.BigInteger>	getEntries()	Java API
java.math.BigInteger	getValue(A key)	Java API: The count for a key, or null if it doesn't exist
int	hashCode()
PNCounterMap<A>	increment(Cluster node, A key, long delta)	Deprecated. Use `increment` that takes a `SelfUniqueAddress` parameter instead.
PNCounterMap<A>	increment(SelfUniqueAddress node, A key, long delta)	Increment the counter with the delta specified.
PNCounterMap<A>	increment(UniqueAddress node, A key, long delta)	INTERNAL API
PNCounterMap<A>	increment(A key, long delta, Cluster node)	Increment the counter with the delta specified.
long	increment$default$2()
PNCounterMap<A>	incrementBy(A key, long delta, SelfUniqueAddress node)	Increment the counter with the delta specified.
boolean	isEmpty()
PNCounterMap<A>	merge(PNCounterMap<A> that)
PNCounterMap<A>	mergeDelta(ORMap.DeltaOp thatDelta)
scala.collection.immutable.Set<UniqueAddress>	modifiedByNodes()
boolean	needPruningFrom(UniqueAddress removedNode)	Does it have any state changes from a specific node, which has been removed from the cluster.
PNCounterMap<A>	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<A>	pruningCleanup(UniqueAddress removedNode)	Remove data entries from a node that has been removed from the cluster and already been pruned.
PNCounterMap<A>	remove(Cluster node, A key)	Deprecated. Use `remove` that takes a `SelfUniqueAddress` parameter instead.
PNCounterMap<A>	remove(UniqueAddress node, A key)	INTERNAL API
PNCounterMap<A>	remove(A key, SelfUniqueAddress node)	Removes an entry from the map.
PNCounterMap<A>	resetDelta()	Reset collection of deltas from mutator operations.
int	size()
java.lang.String	toString()
static <A> scala.Option<scala.collection.immutable.Map<A,scala.math.BigInt>>	unapply(PNCounterMap<A> m)	Extract the entries().
ORMap<A,PNCounter>	underlying()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface akka.cluster.ddata.DeltaReplicatedData

mergeDelta

Methods inherited from interface akka.cluster.ddata.ReplicatedData

merge

Constructor Detail

PNCounterMap

public PNCounterMap(ORMap<A,PNCounter> underlying)

Method Detail

empty

public static <A> PNCounterMap<A> empty()

apply

public static <A> PNCounterMap<A> apply()

create

public static <A> PNCounterMap<A> create()

Java API

Returns:

(undocumented)

unapply

public static <A> scala.Option<scala.collection.immutable.Map<A,scala.math.BigInt>> unapply(PNCounterMap<A> m)

Extract the entries().

Parameters:

m - (undocumented)

Returns:

(undocumented)

underlying

public ORMap<A,PNCounter> underlying()

entries

public scala.collection.immutable.Map<A,scala.math.BigInt> entries()

Scala API

getEntries

public java.util.Map<A,java.math.BigInteger> getEntries()

Java API

get

public scala.Option<scala.math.BigInt> get(A key)

Scala API: The count for a key

Parameters:

key - (undocumented)

Returns:

(undocumented)

getValue

public java.math.BigInteger getValue(A key)

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

Parameters:

key - (undocumented)

Returns:

(undocumented)

contains

public boolean contains(A key)

isEmpty

public boolean isEmpty()

size

public int size()

incrementBy

public PNCounterMap<A> incrementBy(A key,
                                   long delta,
                                   SelfUniqueAddress 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<A> increment(A 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<A> increment(SelfUniqueAddress node,
                                 A 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<A> increment(Cluster node,
                                 A key,
                                 long delta)

Deprecated.

Use `increment` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.

increment

public PNCounterMap<A> increment(UniqueAddress node,
                                 A key,
                                 long delta)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

delta - (undocumented)

Returns:

(undocumented)

increment$default$2

public long increment$default$2()

decrementBy

public PNCounterMap<A> decrementBy(A key,
                                   long delta,
                                   SelfUniqueAddress node)

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.

Parameters:

key - (undocumented)

delta - (undocumented)

node - (undocumented)

Returns:

(undocumented)

decrement

public PNCounterMap<A> decrement(SelfUniqueAddress node,
                                 A key,
                                 long delta)

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.

Parameters:

node - (undocumented)

key - (undocumented)

delta - (undocumented)

Returns:

(undocumented)

decrement

public PNCounterMap<A> decrement(A key,
                                 long delta,
                                 Cluster node)

Deprecated.

Use `decrement` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.

decrement

public PNCounterMap<A> decrement(Cluster node,
                                 A key,
                                 long delta)

Deprecated.

Use `decrement` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.

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<A> decrement(UniqueAddress node,
                                 A key,
                                 long delta)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

delta - (undocumented)

Returns:

(undocumented)

decrementBy$default$2

public long decrementBy$default$2()

decrement$default$2

public long decrement$default$2()

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.

Returns:

(undocumented)

remove

public PNCounterMap<A> remove(A key,
                              SelfUniqueAddress node)

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:

key - (undocumented)

node - (undocumented)

Returns:

(undocumented)

remove

public PNCounterMap<A> remove(Cluster node,
                              A key)

Deprecated.

Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.

$minus

public PNCounterMap<A> $minus(A key,
                              Cluster node)

Deprecated.

Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.

remove

public PNCounterMap<A> remove(UniqueAddress node,
                              A key)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

Returns:

(undocumented)

merge

public PNCounterMap<A> merge(PNCounterMap<A> that)

resetDelta

public PNCounterMap<A> resetDelta()

Description copied from interface: DeltaReplicatedData

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 DeltaReplicatedData.delta() accessor. When the Replicator has grabbed the delta it will invoke this method to get a clean data instance without the delta.

Specified by:

resetDelta in interface DeltaReplicatedData

Returns:

(undocumented)

delta

public scala.Option<ORMap.DeltaOp> delta()

Description copied from interface: DeltaReplicatedData

The accumulated delta of mutator operations since previous DeltaReplicatedData.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 DeltaReplicatedData.delta() accessor. The modify function shall still return the full state in the same way as ReplicatedData without support for deltas.

Specified by:

delta in interface DeltaReplicatedData

Returns:

(undocumented)

mergeDelta

public PNCounterMap<A> mergeDelta(ORMap.DeltaOp thatDelta)

modifiedByNodes

public scala.collection.immutable.Set<UniqueAddress> modifiedByNodes()

Specified by:

modifiedByNodes in interface RemovedNodePruning

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<A> 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<A> 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