Class ORMap<A,​B extends ReplicatedData>

    • Method Detail

      • $lessinit$greater$default$4

        public static <A,​B extends ReplicatedData> scala.Option<ORMap.DeltaOp> $lessinit$greater$default$4()
        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.

        Returns:
        (undocumented)
      • create

        public static <A,​B extends ReplicatedDataORMap<A,​B> create()
        Java API
        Returns:
        (undocumented)
      • unapply

        public static <A,​B extends ReplicatedData> scala.Option<scala.collection.immutable.Map<A,​B>> unapply​(ORMap<A,​B> m)
        Extract the entries().
        Parameters:
        m - (undocumented)
        Returns:
        (undocumented)
      • keys

        public ORSet<A> keys()
      • values

        public scala.collection.immutable.Map<A,​B> values()
      • 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)
      • 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)
      • getOrElse

        public B getOrElse​(A key,
                           scala.Function0<B> 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​(A key)
      • isEmpty

        public boolean isEmpty()
      • size

        public int size()
      • $plus

        public ORMap<A,​B> $plus​(scala.Tuple2<A,​B> entry,
                                      Cluster node)
        Deprecated.
        Use `:+` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
      • put

        public ORMap<A,​B> put​(Cluster node,
                                    A key,
                                    B value)
        Deprecated.
        Use `put` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
      • put

        public ORMap<A,​B> put​(UniqueAddress node,
                                    A key,
                                    B value)
        INTERNAL API
        Parameters:
        node - (undocumented)
        key - (undocumented)
        value - (undocumented)
        Returns:
        (undocumented)
      • updated

        public ORMap<A,​B> updated​(SelfUniqueAddress node,
                                        A key,
                                        B initial,
                                        scala.Function1<B,​B> 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,​B> updated​(Cluster node,
                                        A key,
                                        B initial,
                                        scala.Function1<B,​B> modify)
        Deprecated.
        Use `updated` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
      • updated

        public ORMap<A,​B> updated​(Cluster node,
                                        A key,
                                        B initial,
                                        java.util.function.Function<B,​B> modify)
        Deprecated.
        use update for the Java API as updated is ambiguous with the Scala API. Since 2.5.20.
        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)
      • update

        public ORMap<A,​B> update​(SelfUniqueAddress node,
                                       A key,
                                       B initial,
                                       java.util.function.Function<B,​B> 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)
      • update

        public ORMap<A,​B> update​(Cluster node,
                                       A key,
                                       B initial,
                                       java.util.function.Function<B,​B> modify)
        Deprecated.
        Use `update` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
      • updated

        public ORMap<A,​B> updated​(UniqueAddress node,
                                        A key,
                                        B initial,
                                        boolean valueDeltas,
                                        scala.Function1<B,​B> modify)
        INTERNAL API
        Parameters:
        node - (undocumented)
        key - (undocumented)
        initial - (undocumented)
        valueDeltas - (undocumented)
        modify - (undocumented)
        Returns:
        (undocumented)
      • updated$default$4

        public boolean updated$default$4()
      • remove

        public ORMap<A,​B> remove​(A key,
                                       SelfUniqueAddress node)
        Scala API 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 ORMap<A,​B> remove​(SelfUniqueAddress node,
                                       A key)
        Java API 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)
      • $minus

        public ORMap<A,​B> $minus​(A key,
                                       Cluster node)
        Deprecated.
        Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
      • remove

        public ORMap<A,​B> remove​(Cluster node,
                                       A key)
        Deprecated.
        Use `remove` that takes a `SelfUniqueAddress` parameter instead. Since 2.5.20.
      • remove

        public ORMap<A,​B> remove​(UniqueAddress node,
                                       A key)
        INTERNAL API
        Parameters:
        node - (undocumented)
        key - (undocumented)
        Returns:
        (undocumented)
      • removeKey

        public ORMap<A,​B> removeKey​(UniqueAddress node,
                                          A key)
        INTERNAL API This function is only to be used by derived maps that avoid remove anomalies by keeping the vvector (in form of key -> value pair) for deleted keys
        Parameters:
        node - (undocumented)
        key - (undocumented)
        Returns:
        (undocumented)
      • mergeRetainingDeletedValues

        public ORMap<A,​B> mergeRetainingDeletedValues​(ORMap<A,​B> that)
        INTERNAL API This function is only to be used by derived maps that avoid remove anomalies by keeping the vvector (in form of key -> value pair) for deleted keys
        Parameters:
        that - (undocumented)
        Returns:
        (undocumented)
      • resetDelta

        public ORMap<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)
      • mergeDeltaRetainingDeletedValues

        public ORMap<A,​B> mergeDeltaRetainingDeletedValues​(ORMap.DeltaOp thatDelta)
        INTERNAL API This function is only to be used by derived maps that avoid remove anomalies by keeping the vvector (in form of key -> value pair) for deleted keys
        Parameters:
        thatDelta - (undocumented)
        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 ORMap<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 ORMap<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