Class 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
    Specialized ORMap with LWWRegister values.

    LWWRegister relies on synchronized clocks and should only be used when the choice of value is not important for concurrent updates occurring within the clock skew.

    Instead of using timestamps based on System.currentTimeMillis() time it is possible to use a timestamp value based on something else, for example an increasing version number from a database record that is used for optimistic concurrency control.

    The defaultClock is using max value of System.currentTimeMillis() and currentTimestamp + 1. This means that the timestamp is increased for changes on the same node that occurs within the same millisecond. It also means that it is safe to use the LWWMap without synchronized clocks when there is only one active writer, e.g. a Cluster Singleton. Such a single writer should then first read current value with ReadMajority (or more) before changing and writing the value with WriteMajority (or more).

    For first-write-wins semantics you can use the LWWRegister.reverseClock() instead of the LWWRegister.defaultClock()

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

    See Also:
    Serialized Form
    • 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)
      • 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)
      • $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)
      • modifiedByNodes

        public scala.collection.immutable.Set<UniqueAddress> modifiedByNodes()
        Description copied from interface: RemovedNodePruning
        The nodes that have changed the state for this data and would need pruning when such node is no longer part of the cluster.
        Specified by:
        modifiedByNodes in interface RemovedNodePruning
        Returns:
        (undocumented)
      • 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