Package akka.cluster.ddata

Class LWWMap<A,B>

java.lang.Object

akka.cluster.ddata.LWWMap<A,B>

All Implemented Interfaces:

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

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

Scala API: All entries of the map.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LWWMap.LWWMapTag$

Constructor Summary

Constructors

Constructor	Description
LWWMap(ORMap<A,LWWRegister<B>> underlying)

Method Summary

Modifier and Type	Method	Description
LWWMap<A,B>	$colon$plus(scala.Tuple2<A,B> entry, SelfUniqueAddress node)	Adds an entry to the map
LWWMap<A,B>	$minus(A key, Cluster node)	Deprecated. Use `remove` that takes a `SelfUniqueAddress` parameter instead.
LWWMap<A,B>	$plus(scala.Tuple2<A,B> entry, Cluster node)	Deprecated. Use `:+` that takes a `SelfUniqueAddress` parameter instead.
static LWWMap<java.lang.Object,java.lang.Object>	apply()
boolean	contains(A key)
static <A,B> LWWMap<A,B>	create()	Java API
scala.Option<ORMap.DeltaOp>	delta()	The accumulated delta of mutator operations since previous DeltaReplicatedData.resetDelta().
static <A,B> LWWMap<A,B>	empty()
scala.collection.immutable.Map<A,B>	entries()	Scala API: All entries of the map.
boolean	equals(java.lang.Object o)
scala.Option<B>	get(A key)
java.util.Map<A,B>	getEntries()	Java API: All entries of the map.
int	hashCode()
boolean	isEmpty()
LWWMap<A,B>	merge(LWWMap<A,B> that)
LWWMap<A,B>	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.
LWWMap<A,B>	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.
LWWMap<A,B>	pruningCleanup(UniqueAddress removedNode)	Remove data entries from a node that has been removed from the cluster and already been pruned.
LWWMap<A,B>	put(Cluster node, A key, B value)	Deprecated. Use `put` that takes a `SelfUniqueAddress` parameter instead.
LWWMap<A,B>	put(Cluster node, A key, B value, LWWRegister.Clock<B> clock)	Deprecated. Use `put` that takes a `SelfUniqueAddress` parameter instead.
LWWMap<A,B>	put(SelfUniqueAddress node, A key, B value)	Adds an entry to the map
LWWMap<A,B>	put(SelfUniqueAddress node, A key, B value, LWWRegister.Clock<B> clock)	Adds an entry to the map.
LWWMap<A,B>	put(UniqueAddress node, A key, B value, LWWRegister.Clock<B> clock)	INTERNAL API
LWWMap<A,B>	put(A key, B value, Cluster node, LWWRegister.Clock<B> clock)	Deprecated. Use `put` that takes a `SelfUniqueAddress` parameter instead.
LWWRegister.Clock<B>	put$default$4(A key, B value)
LWWMap<A,B>	remove(Cluster node, A key)	Deprecated. Use `remove` that takes a `SelfUniqueAddress` parameter instead.
LWWMap<A,B>	remove(SelfUniqueAddress node, A key)	Removes an entry from the map.
LWWMap<A,B>	remove(UniqueAddress node, A key)	INTERNAL API
LWWMap<A,B>	resetDelta()	Reset collection of deltas from mutator operations.
int	size()
java.lang.String	toString()
static <A,B> scala.Option<scala.collection.immutable.Map<A,B>>	unapply(LWWMap<A,B> m)	Extract the entries().
ORMap<A,LWWRegister<B>>	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

LWWMap

public LWWMap(ORMap<A,LWWRegister<B>> underlying)

Method Detail

empty

public static <A,B> LWWMap<A,B> empty()

apply

public static LWWMap<java.lang.Object,java.lang.Object> apply()

create

public static <A,B> LWWMap<A,B> create()

Java API

Returns:

(undocumented)

unapply

public static <A,B> scala.Option<scala.collection.immutable.Map<A,B>> unapply(LWWMap<A,B> m)

Extract the entries().

Parameters:

m - (undocumented)

Returns:

(undocumented)

underlying

public ORMap<A,LWWRegister<B>> underlying()

entries

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

Scala API: All entries of the map.

Returns:

(undocumented)

getEntries

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

Java API: All entries of the map.

Returns:

(undocumented)

get

public scala.Option<B> get(A key)

contains

public boolean contains(A key)

isEmpty

public boolean isEmpty()

size

public int size()

$colon$plus

public LWWMap<A,B> $colon$plus(scala.Tuple2<A,B> entry,
                                     SelfUniqueAddress node)

Adds an entry to the map

Parameters:

entry - (undocumented)

node - (undocumented)

Returns:

(undocumented)

$plus

public LWWMap<A,B> $plus(scala.Tuple2<A,B> entry,
                               Cluster node)

Deprecated.

Use `:+` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.

put

public LWWMap<A,B> put(SelfUniqueAddress node,
                             A key,
                             B value)

Adds an entry to the map

Parameters:

node - (undocumented)

key - (undocumented)

value - (undocumented)

Returns:

(undocumented)

put

public LWWMap<A,B> put(Cluster node,
                             A key,
                             B value)

Deprecated.

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

put

public LWWMap<A,B> put(SelfUniqueAddress node,
                             A key,
                             B value,
                             LWWRegister.Clock<B> clock)

Adds an entry to the map.

You can provide your clock implementation instead of using timestamps based on System.currentTimeMillis() time. The timestamp can for example be an increasing version number from a database record that is used for optimistic concurrency control.

Parameters:

node - (undocumented)

key - (undocumented)

value - (undocumented)

clock - (undocumented)

Returns:

(undocumented)

put

public LWWMap<A,B> put(Cluster node,
                             A key,
                             B value,
                             LWWRegister.Clock<B> clock)

Deprecated.

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

put

public LWWMap<A,B> put(A key,
                             B value,
                             Cluster node,
                             LWWRegister.Clock<B> clock)

Deprecated.

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

Adds an entry to the map.

You can provide your clock implementation instead of using timestamps based on System.currentTimeMillis() time. The timestamp can for example be an increasing version number from a database record that is used for optimistic concurrency control.

Parameters:

key - (undocumented)

value - (undocumented)

node - (undocumented)

clock - (undocumented)

Returns:

(undocumented)

put

public LWWMap<A,B> put(UniqueAddress node,
                             A key,
                             B value,
                             LWWRegister.Clock<B> clock)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

value - (undocumented)

clock - (undocumented)

Returns:

(undocumented)

put$default$4

public LWWRegister.Clock<B> put$default$4(A key,
                                          B value)

$minus

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

Deprecated.

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

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 LWWMap<A,B> remove(SelfUniqueAddress node,
                                A 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 LWWMap<A,B> remove(Cluster node,
                                A key)

Deprecated.

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

remove

public LWWMap<A,B> remove(UniqueAddress node,
                                A key)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

Returns:

(undocumented)

resetDelta

public LWWMap<A,B> 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 LWWMap<A,B> mergeDelta(ORMap.DeltaOp thatDelta)

merge

public LWWMap<A,B> merge(LWWMap<A,B> that)

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 LWWMap<A,B> 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 LWWMap<A,B> 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