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.

      • unapply

        public static <A,​B extends ReplicatedData> scala.Option<scala.collection.immutable.Map<A,​B>> unapply​(ORMap<A,​B> m)
        Extract the entries().
      • 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
      • entries

        public scala.collection.immutable.Map<A,​B> entries()
        Scala API: All entries of the map.
      • getEntries

        public java.util.Map<A,​B> getEntries()
        Java API: All entries of the map.
      • 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.
      • contains

        public boolean contains​(A key)
      • isEmpty

        public boolean isEmpty()
      • size

        public int size()
      • $colon$plus

        public ORMap<A,​B> $colon$plus​(scala.Tuple2<A,​B> entry,
                                            SelfUniqueAddress node)
        Adds an entry to the map
      • $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​(SelfUniqueAddress node,
                                    A key,
                                    B 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 {@link ORMap#updated(node:akka\.cluster\.ddata\.SelfUniqueAddress*} 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 {@link ORMap#updated(node:akka\.cluster\.ddata\.SelfUniqueAddress*} instead.

      • 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.
      • 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.

      • 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.

      • 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.

      • 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
      • 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.
      • 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.
      • $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.
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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