akka.cluster.ddata

Class ORMap<A extends ReplicatedData>

java.lang.Object

akka.cluster.ddata.ORMap<A>

All Implemented Interfaces:

RemovedNodePruning, ReplicatedData, ReplicatedDataSerialization, java.io.Serializable

public final class ORMap<A extends ReplicatedData>
extends java.lang.Object
implements ReplicatedData, ReplicatedDataSerialization, RemovedNodePruning

Implements a 'Observed Remove Map' CRDT, also called a 'OR-Map'.

It has similar semantics as an ORSet, but in case of concurrent updates the values are merged, and must therefore be ReplicatedData types themselves.

This class is immutable, i.e. "modifying" methods return a new instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ORMap(ORSet<java.lang.String> keys, scala.collection.immutable.Map<java.lang.String,A> values)

Method Summary

Modifier and Type	Method and Description
static ORMap<ReplicatedData>	apply()
boolean	contains(java.lang.String key)
static <A extends ReplicatedData> ORMap<A>	create() Java API
static <A extends ReplicatedData> ORMap<A>	empty()
scala.collection.immutable.Map<java.lang.String,A>	entries() Scala API: All entries of the map.
boolean	equals(java.lang.Object o)
scala.Option<A>	get(java.lang.String key)
java.util.Map<java.lang.String,A>	getEntries() Java API: All entries of the map.
A	getOrElse(java.lang.String key, scala.Function0<A> default_) Scala API: Get the value associated with the key if there is one, else return the given default.
int	hashCode()
boolean	isEmpty()
ORSet<java.lang.String>	keys()
ORMap<A>	merge(ORMap<A> that)
boolean	needPruningFrom(UniqueAddress removedNode) Does it have any state changes from a specific node, which has been removed from the cluster.
ORMap<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.
ORMap<A>	pruningCleanup(UniqueAddress removedNode) Remove data entries from a node that has been removed from the cluster and already been pruned.
ORMap<A>	put(Cluster node, java.lang.String key, A value) Adds an entry to the map.
ORMap<A>	put(UniqueAddress node, java.lang.String key, A value) INTERNAL API
ORMap<A>	remove(Cluster node, java.lang.String key) Removes an entry from the map.
ORMap<A>	remove(UniqueAddress node, java.lang.String key) INTERNAL API
int	size()
java.lang.String	toString()
static <A extends ReplicatedData> scala.Option<scala.collection.immutable.Map<java.lang.String,A>>	unapply(ORMap<A> m) Extract the entries().
ORMap<A>	updated(Cluster node, java.lang.String key, A initial, java.util.function.Function<A,A> modify) Java API: Replace a value by applying the modify function on the existing value.
ORMap<A>	updated(Cluster node, java.lang.String key, A initial, scala.Function1<A,A> modify) Scala API: Replace a value by applying the modify function on the existing value.
ORMap<A>	updated(UniqueAddress node, java.lang.String key, A initial, scala.Function1<A,A> modify) INTERNAL API
scala.collection.immutable.Map<java.lang.String,A>	values()

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

ORMap

public ORMap(ORSet<java.lang.String> keys,
             scala.collection.immutable.Map<java.lang.String,A> values)

Method Detail

empty

public static <A extends ReplicatedData> ORMap<A> empty()

apply

public static ORMap<ReplicatedData> apply()

create

public static <A extends ReplicatedData> ORMap<A> create()

Java API

Returns:

(undocumented)

unapply

public static <A extends ReplicatedData> scala.Option<scala.collection.immutable.Map<java.lang.String,A>> unapply(ORMap<A> m)

Extract the entries().

Parameters:

m - (undocumented)

Returns:

(undocumented)

keys

public ORSet<java.lang.String> keys()

values

public scala.collection.immutable.Map<java.lang.String,A> values()

entries

public scala.collection.immutable.Map<java.lang.String,A> entries()

Scala API: All entries of the map.

Returns:

(undocumented)

getEntries

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

Java API: All entries of the map.

Returns:

(undocumented)

get

public scala.Option<A> get(java.lang.String key)

getOrElse

public A getOrElse(java.lang.String key,
                   scala.Function0<A> default_)

Scala API: Get the value associated with the key if there is one, else return the given default.

Parameters:

key - (undocumented)

default_ - (undocumented)

Returns:

(undocumented)

contains

public boolean contains(java.lang.String key)

isEmpty

public boolean isEmpty()

size

public int size()

put

public ORMap<A> put(Cluster node,
                    java.lang.String key,
                    A value)

Adds an entry to the map. Note that the new value will be merged with existing values on other nodes and the outcome depends on what ReplicatedData type that is used.

Consider using updated(akka.cluster.Cluster, java.lang.String, A, scala.Function1<A, A>) instead of put if you want modify existing entry.

IllegalArgumentException is thrown if you try to replace an existing ORSet value, because important history can be lost when replacing the ORSet and undesired effects of merging will occur. Use ORMultiMap or updated(akka.cluster.Cluster, java.lang.String, A, scala.Function1<A, A>) instead.

Parameters:

node - (undocumented)

key - (undocumented)

value - (undocumented)

Returns:

(undocumented)

put

public ORMap<A> put(UniqueAddress node,
                    java.lang.String key,
                    A value)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

value - (undocumented)

Returns:

(undocumented)

updated

public ORMap<A> updated(Cluster node,
                        java.lang.String key,
                        A initial,
                        scala.Function1<A,A> modify)

Scala API: Replace a value by applying the modify function on the existing value.

If there is no current value for the key the initial value will be passed to the modify function.

Parameters:

node - (undocumented)

key - (undocumented)

initial - (undocumented)

modify - (undocumented)

Returns:

(undocumented)

updated

public ORMap<A> updated(Cluster node,
                        java.lang.String key,
                        A initial,
                        java.util.function.Function<A,A> modify)

Java API: Replace a value by applying the modify function on the existing value.

If there is no current value for the key the initial value will be passed to the modify function.

Parameters:

node - (undocumented)

key - (undocumented)

initial - (undocumented)

modify - (undocumented)

Returns:

(undocumented)

updated

public ORMap<A> updated(UniqueAddress node,
                        java.lang.String key,
                        A initial,
                        scala.Function1<A,A> modify)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

initial - (undocumented)

modify - (undocumented)

Returns:

(undocumented)

remove

public ORMap<A> 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 ORMap<A> remove(UniqueAddress node,
                       java.lang.String key)

INTERNAL API

Parameters:

node - (undocumented)

key - (undocumented)

Returns:

(undocumented)

merge

public ORMap<A> merge(ORMap<A> 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 ORMap<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 ORMap<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