Interface ORMap<K,​V extends Crdt>

  • Type Parameters:
    K - The type of keys.
    V - The CRDT to be used for values.
    All Superinterfaces:
    Crdt, java.util.Map<K,​V>

    public interface ORMap<K,​V extends Crdt>
    extends Crdt, java.util.Map<K,​V>
    An Observed-Removed Map.

    An Observed-Removed Map allows both the addition and removal of objects in a map. A removal can only be done if all of the additions that caused the key to be in the map have been seen by this node. This means that, for example, if node 1 adds key A, and node 2 also adds key A, then node 1's addition is replicated to node 3, and node 3 deletes it before node 2's addition is replicated, then the item will still be in the map because node 2's addition had not yet been observed by node 3. However, if both additions had been replicated to node 3, then the key will be removed.

    The values of the map are themselves CRDTs, and hence allow concurrent updates that will eventually converge. Values may only be inserted using the getOrCreate(Object, Function) function, using the CrdtFactory passed in to the creation callback. Invoking put(Object, Crdt) or any other insertion method will throw a UnsupportedOperationException.

    While removing entries from the map is supported, if the entries are added back again, it is possible that the value of the deleted entry may be merged into the value of the current entry, depending on whether the removal has been replicated to all nodes before the addition is performed.

    The map may contain different CRDT types as values, however, for a given key, the type must never change. If two different types for the same key are inserted on different nodes, the CRDT will enter an invalid state that can never be merged, and behavior of the CRDT is undefined.

    Care needs to be taken to ensure that the serialized value of keys in the set is stable. For example, if using protobufs, the serialized value of any maps contained in the protobuf is not stable, and can yield a different set of bytes for the same logically equal element. Hence maps should be avoided. Additionally, some changes in protobuf schemas which are backwards compatible from a protobuf perspective, such as changing from sint32 to int32, do result in different serialized bytes, and so must be avoided.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      V getOrCreate​(K key, java.util.function.Function<CrdtFactory,​V> create)
      Get or create an entry in the map with the given key.
      default V put​(K key, V value)
      Not supported on ORMap.
      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
    • Method Detail

      • getOrCreate

        V getOrCreate​(K key,
                      java.util.function.Function<CrdtFactory,​V> create)
        Get or create an entry in the map with the given key.
        key - The key of the entry.
        create - A callback used to create the value using the given CrdtFactory if an entry for the key is not currently in the map.
        The existing or newly created value for the given key.