AtomixConsistentTreeMap (onos-apps-fwd)

java.lang.Object
- io.atomix.resource.AbstractResource<AtomixConsistentTreeMap>
- - org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMap

All Implemented Interfaces:

io.atomix.catalyst.util.Managed<AtomixConsistentTreeMap>, io.atomix.resource.Resource<AtomixConsistentTreeMap>, AsyncConsistentMap<String,byte[]>, AsyncConsistentTreeMap<byte[]>, DistributedPrimitive, Transactional<MapUpdate<String,byte[]>>
```
public class AtomixConsistentTreeMap
extends io.atomix.resource.AbstractResource<AtomixConsistentTreeMap>
implements AsyncConsistentTreeMap<byte[]>
```
Implementation of AsyncConsistentTreeMap.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive
  DistributedPrimitive.Status, DistributedPrimitive.Type
- Nested classes/interfaces inherited from interface io.atomix.resource.Resource
  io.atomix.resource.Resource.Config, io.atomix.resource.Resource.Event, io.atomix.resource.Resource.EventType, io.atomix.resource.Resource.Options, io.atomix.resource.Resource.State

Field Summary

Fields
Modifier and Type Field and Description

static String CHANGE_SUBJECT
- Fields inherited from class io.atomix.resource.AbstractResource
  client, config, options
- Fields inherited from interface org.onosproject.store.service.DistributedPrimitive
  DEFAULT_OPERTATION_TIMEOUT_MILLIS

Fields
Modifier and Type	Field and Description
`static String`	`CHANGE_SUBJECT`

Constructor Summary

Constructors
Constructor and Description

AtomixConsistentTreeMap(io.atomix.copycat.client.CopycatClient client, Properties options)

Constructors
Constructor and Description
`AtomixConsistentTreeMap(io.atomix.copycat.client.CopycatClient client, Properties options)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<Void>`	`addListener(MapEventListener<String,byte[]> listener, Executor executor)` Registers the specified listener to be notified whenever the map is updated.
`CompletableFuture<Version>`	`begin(TransactionId transactionId)` Begins the transaction.
`CompletableFuture<Map.Entry<String,Versioned<byte[]>>>`	`ceilingEntry(String key)` Returns the entry associated with the least key greater than or equal to the key.
`CompletableFuture<String>`	`ceilingKey(String key)` Return the lowest key greater than or equal to key.
`CompletableFuture<Void>`	`clear()` Removes all of the mappings from this map (optional operation).
`CompletableFuture<Void>`	`commit(TransactionId transactionId)` Commits a previously prepared transaction and unlocks the object.
`CompletableFuture<Versioned<byte[]>>`	`computeIf(String key, Predicate<? super byte[]> condition, BiFunction<? super String,? super byte[],? extends byte[]> remappingFunction)` If the value for the specified key satisfies a condition, attempts to compute a new mapping given the key and its current mapped value.
`CompletableFuture<Boolean>`	`containsKey(String key)` Returns true if this map contains a mapping for the specified key.
`CompletableFuture<Boolean>`	`containsValue(byte[] value)` Returns true if this map contains the specified value.
`CompletableFuture<Set<Map.Entry<String,Versioned<byte[]>>>>`	`entrySet()` Returns the set of entries contained in this map.
`CompletableFuture<Map.Entry<String,Versioned<byte[]>>>`	`firstEntry()` Return the entry associated with the lowest key in the map.
`CompletableFuture<String>`	`firstKey()` Return the lowest key in the map.
`CompletableFuture<Map.Entry<String,Versioned<byte[]>>>`	`floorEntry(String key)` Returns the entry associated with the greatest key less than or equal to key.
`CompletableFuture<String>`	`floorKey(String key)` Return the highest key less than or equal to key.
`CompletableFuture<Versioned<byte[]>>`	`get(String key)` Returns the value (and version) to which the specified key is mapped, or null if this map contains no mapping for the key.
`CompletableFuture<Versioned<byte[]>>`	`getOrDefault(String key, byte[] defaultValue)` Returns the value (and version) to which the specified key is mapped, or the provided default value if this map contains no mapping for the key.
`CompletableFuture<Map.Entry<String,Versioned<byte[]>>>`	`higherEntry(String key)` Returns the entry associated with the least key greater than key.
`CompletableFuture<String>`	`higherKey(String key)` Return the lowest key greater than key.
`CompletableFuture<Boolean>`	`isEmpty()` Returns true if the map is empty.
`CompletableFuture<Set<String>>`	`keySet()` Returns a Set view of the keys contained in this map.
`CompletableFuture<Map.Entry<String,Versioned<byte[]>>>`	`lastEntry()` Return the entry associated with the highest key in the map.
`CompletableFuture<String>`	`lastKey()` Return the highest key in the map.
`CompletableFuture<Map.Entry<String,Versioned<byte[]>>>`	`lowerEntry(String key)` Returns the entry associated with the largest key less than key.
`CompletableFuture<String>`	`lowerKey(String key)` Return the entry associated with the greatest key less than key.
`String`	`name()` Returns the name of this primitive.
`CompletableFuture<NavigableSet<String>>`	`navigableKeySet()` Returns a navigable set of the keys in this map.
`CompletableFuture<AtomixConsistentTreeMap>`	`open()`
`CompletableFuture<Map.Entry<String,Versioned<byte[]>>>`	`pollFirstEntry()` Return and remove the entry associated with the lowest key.
`CompletableFuture<Map.Entry<String,Versioned<byte[]>>>`	`pollLastEntry()` Return and remove the entry associated with the highest key.
`CompletableFuture<Boolean>`	`prepare(TransactionLog<MapUpdate<String,byte[]>> transactionLog)` Prepares a transaction for commitment.
`CompletableFuture<Boolean>`	`prepareAndCommit(TransactionLog<MapUpdate<String,byte[]>> transactionLog)` Prepares and commits a transaction.
`CompletableFuture<Versioned<byte[]>>`	`put(String key, byte[] value)` Associates the specified value with the specified key in this map (optional operation).
`CompletableFuture<Versioned<byte[]>>`	`putAndGet(String key, byte[] value)` Associates the specified value with the specified key in this map (optional operation).
`CompletableFuture<Versioned<byte[]>>`	`putIfAbsent(String key, byte[] value)` If the specified key is not already associated with a value associates it with the given value and returns null, else behaves as a get returning the existing mapping without making any changes.
`CompletableFuture<Versioned<byte[]>>`	`remove(String key)` Removes the mapping for a key from this map if it is present (optional operation).
`CompletableFuture<Boolean>`	`remove(String key, byte[] value)` Removes the entry for the specified key only if it is currently mapped to the specified value.
`CompletableFuture<Boolean>`	`remove(String key, long version)` Removes the entry for the specified key only if its current version in the map is equal to the specified version.
`CompletableFuture<Void>`	`removeListener(MapEventListener<String,byte[]> listener)` Unregisters the specified listener such that it will no longer receive map change notifications.
`CompletableFuture<Versioned<byte[]>>`	`replace(String key, byte[] value)` Replaces the entry for the specified key only if there is any value which associated with specified key.
`CompletableFuture<Boolean>`	`replace(String key, byte[] oldValue, byte[] newValue)` Replaces the entry for the specified key only if currently mapped to the specified value.
`CompletableFuture<Boolean>`	`replace(String key, long oldVersion, byte[] newValue)` Replaces the entry for the specified key only if it is currently mapped to the specified version.
`CompletableFuture<Void>`	`rollback(TransactionId transactionId)` Aborts a previously prepared transaction and unlocks the object.
`CompletableFuture<Integer>`	`size()` Returns the number of entries in the map.
`CompletableFuture<NavigableMap<String,byte[]>>`	`subMap(String upperKey, String lowerKey, boolean inclusiveUpper, boolean inclusiveLower)` Returns a navigable map containing the entries from the original map which are larger than (or if specified equal to) `lowerKey` AND less than (or if specified equal to) `upperKey`.
`CompletableFuture<Collection<Versioned<byte[]>>>`	`values()` Returns the collection of values (and associated versions) contained in this map.

Methods inherited from class io.atomix.resource.AbstractResource
close, config, context, delete, equals, hashCode, isClosed, isOpen, onEvent, onRecovery, onStateChange, options, recover, serializer, state, toString, type

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.onosproject.store.service.AsyncConsistentTreeMap
asTreeMap, asTreeMap

Methods inherited from interface org.onosproject.store.service.AsyncConsistentMap
addListener, asConsistentMap, asConsistentMap, compute, computeIfAbsent, computeIfPresent, destroy, primitiveType

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive
addStatusChangeListener, applicationId, removeStatusChangeListener, statusChangeListeners

- Field Detail
  - CHANGE_SUBJECT
```
public static final String CHANGE_SUBJECT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AtomixConsistentTreeMap
```
public AtomixConsistentTreeMap(io.atomix.copycat.client.CopycatClient client,
                               Properties options)
```
- Method Detail
  - name
```
public String name()
```
    Description copied from interface: DistributedPrimitive
    
    Returns the name of this primitive.
    
    Specified by:
    
    name in interface DistributedPrimitive
    
    Returns:
    
    name
  - open
```
public CompletableFuture<AtomixConsistentTreeMap> open()
```
    Specified by:
    
    open in interface io.atomix.catalyst.util.Managed<AtomixConsistentTreeMap>
    
    Specified by:
    
    open in interface io.atomix.resource.Resource<AtomixConsistentTreeMap>
    
    Overrides:
    
    open in class io.atomix.resource.AbstractResource<AtomixConsistentTreeMap>
  - isEmpty
```
public CompletableFuture<Boolean> isEmpty()
```
    Description copied from interface: AsyncConsistentMap
    
    Returns true if the map is empty.
    
    Specified by:
    
    isEmpty in interface AsyncConsistentMap<String,byte[]>
    
    Returns:
    
    a future whose value will be true if map has no entries, false otherwise.
  - size
```
public CompletableFuture<Integer> size()
```
    Description copied from interface: AsyncConsistentMap
    
    Returns the number of entries in the map.
    
    Specified by:
    
    size in interface AsyncConsistentMap<String,byte[]>
    
    Returns:
    
    a future for map size.
  - containsKey
```
public CompletableFuture<Boolean> containsKey(String key)
```
    Description copied from interface: AsyncConsistentMap
    
    Returns true if this map contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key
    
    Returns:
    
    a future whose value will be true if map contains key, false otherwise.
  - containsValue
```
public CompletableFuture<Boolean> containsValue(byte[] value)
```
    Description copied from interface: AsyncConsistentMap
    
    Returns true if this map contains the specified value.
    
    Specified by:
    
    containsValue in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    value - value
    
    Returns:
    
    a future whose value will be true if map contains value, false otherwise.
  - get
```
public CompletableFuture<Versioned<byte[]>> get(String key)
```
    Description copied from interface: AsyncConsistentMap
    
    Returns the value (and version) to which the specified key is mapped, or null if this map contains no mapping for the key.
    
    Specified by:
    
    get in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - the key whose associated value (and version) is to be returned
    
    Returns:
    
    a future value (and version) to which the specified key is mapped, or null if this map contains no mapping for the key
  - getOrDefault
```
public CompletableFuture<Versioned<byte[]>> getOrDefault(String key,
                                                         byte[] defaultValue)
```
    Description copied from interface: AsyncConsistentMap
    
    Returns the value (and version) to which the specified key is mapped, or the provided default value if this map contains no mapping for the key.
    
    Specified by:
    
    getOrDefault in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - the key whose associated value (and version) is to be returned
    
    defaultValue - the default value to return if the key is not set
    
    Returns:
    
    a future value (and version) to which the specified key is mapped, or null if this map contains no mapping for the key
  - keySet
```
public CompletableFuture<Set<String>> keySet()
```
    Description copied from interface: AsyncConsistentMap
    
    Returns a Set view of the keys contained in this map. This method differs from the behavior of java.util.Map.keySet() in that what is returned is a unmodifiable snapshot view of the keys in the ConsistentMap. Attempts to modify the returned set, whether direct or via its iterator, result in an UnsupportedOperationException.
    
    Specified by:
    
    keySet in interface AsyncConsistentMap<String,byte[]>
    
    Returns:
    
    a set of the keys contained in this map
  - values
```
public CompletableFuture<Collection<Versioned<byte[]>>> values()
```
    Description copied from interface: AsyncConsistentMap
    
    Returns the collection of values (and associated versions) contained in this map. This method differs from the behavior of java.util.Map.values() in that what is returned is a unmodifiable snapshot view of the values in the ConsistentMap. Attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.
    
    Specified by:
    
    values in interface AsyncConsistentMap<String,byte[]>
    
    Returns:
    
    a collection of the values (and associated versions) contained in this map
  - entrySet
```
public CompletableFuture<Set<Map.Entry<String,Versioned<byte[]>>>> entrySet()
```
    Description copied from interface: AsyncConsistentMap
    
    Returns the set of entries contained in this map. This method differs from the behavior of java.util.Map.entrySet() in that what is returned is a unmodifiable snapshot view of the entries in the ConsistentMap. Attempts to modify the returned set, whether direct or via its iterator, result in an UnsupportedOperationException.
    
    Specified by:
    
    entrySet in interface AsyncConsistentMap<String,byte[]>
    
    Returns:
    
    set of entries contained in this map.
  - put
```
public CompletableFuture<Versioned<byte[]>> put(String key,
                                                byte[] value)
```
    Description copied from interface: AsyncConsistentMap
    
    Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value.
    
    Specified by:
    
    put in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value (and version) associated with key, or null if there was no mapping for key.
  - putAndGet
```
public CompletableFuture<Versioned<byte[]>> putAndGet(String key,
                                                      byte[] value)
```
    Description copied from interface: AsyncConsistentMap
    
    Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value.
    
    Specified by:
    
    putAndGet in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    new value.
  - putIfAbsent
```
public CompletableFuture<Versioned<byte[]>> putIfAbsent(String key,
                                                        byte[] value)
```
    Description copied from interface: AsyncConsistentMap
    
    If the specified key is not already associated with a value associates it with the given value and returns null, else behaves as a get returning the existing mapping without making any changes.
    
    Specified by:
    
    putIfAbsent in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with the specified key or null if key does not already mapped to a value.
  - remove
```
public CompletableFuture<Versioned<byte[]>> remove(String key)
```
    Description copied from interface: AsyncConsistentMap
    
    Removes the mapping for a key from this map if it is present (optional operation).
    
    Specified by:
    
    remove in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key whose value is to be removed from the map
    
    Returns:
    
    the value (and version) to which this map previously associated the key, or null if the map contained no mapping for the key.
  - remove
```
public CompletableFuture<Boolean> remove(String key,
                                         byte[] value)
```
    Description copied from interface: AsyncConsistentMap
    
    Removes the entry for the specified key only if it is currently mapped to the specified value.
    
    Specified by:
    
    remove in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key with which the specified value is associated
    
    value - value expected to be associated with the specified key
    
    Returns:
    
    true if the value was removed
  - remove
```
public CompletableFuture<Boolean> remove(String key,
                                         long version)
```
    Description copied from interface: AsyncConsistentMap
    
    Removes the entry for the specified key only if its current version in the map is equal to the specified version.
    
    Specified by:
    
    remove in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key with which the specified version is associated
    
    version - version expected to be associated with the specified key
    
    Returns:
    
    true if the value was removed
  - replace
```
public CompletableFuture<Versioned<byte[]>> replace(String key,
                                                    byte[] value)
```
    Description copied from interface: AsyncConsistentMap
    
    Replaces the entry for the specified key only if there is any value which associated with specified key.
    
    Specified by:
    
    replace in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key with which the specified value is associated
    
    value - value expected to be associated with the specified key
    
    Returns:
    
    the previous value associated with the specified key or null
  - replace
```
public CompletableFuture<Boolean> replace(String key,
                                          byte[] oldValue,
                                          byte[] newValue)
```
    Description copied from interface: AsyncConsistentMap
    
    Replaces the entry for the specified key only if currently mapped to the specified value.
    
    Specified by:
    
    replace in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key with which the specified value is associated
    
    oldValue - value expected to be associated with the specified key
    
    newValue - value to be associated with the specified key
    
    Returns:
    
    true if the value was replaced
  - replace
```
public CompletableFuture<Boolean> replace(String key,
                                          long oldVersion,
                                          byte[] newValue)
```
    Description copied from interface: AsyncConsistentMap
    
    Replaces the entry for the specified key only if it is currently mapped to the specified version.
    
    Specified by:
    
    replace in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key key with which the specified value is associated
    
    oldVersion - version expected to be associated with the specified key
    
    newValue - value to be associated with the specified key
    
    Returns:
    
    true if the value was replaced
  - clear
```
public CompletableFuture<Void> clear()
```
    Description copied from interface: AsyncConsistentMap
    
    Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
    
    Specified by:
    
    clear in interface AsyncConsistentMap<String,byte[]>
    
    Returns:
    
    future that will be successfully completed when the map is cleared
  - computeIf
```
public CompletableFuture<Versioned<byte[]>> computeIf(String key,
                                                      Predicate<? super byte[]> condition,
                                                      BiFunction<? super String,? super byte[],? extends byte[]> remappingFunction)
```
    Description copied from interface: AsyncConsistentMap
    
    If the value for the specified key satisfies a condition, attempts to compute a new mapping given the key and its current mapped value. If the computed value is null, the current mapping will be removed from the map. If a conflicting concurrent modification attempt is detected, the returned future will be completed exceptionally with ConsistentMapException.ConcurrentModification.
    
    Specified by:
    
    computeIf in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    condition - condition that should evaluate to true for the computation to proceed
    
    remappingFunction - the function to compute a value
    
    Returns:
    
    the new value associated with the specified key, or the old value if condition evaluates to false
  - addListener
```
public CompletableFuture<Void> addListener(MapEventListener<String,byte[]> listener,
                                           Executor executor)
```
    Description copied from interface: AsyncConsistentMap
    
    Registers the specified listener to be notified whenever the map is updated.
    
    Specified by:
    
    addListener in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    listener - listener to notify about map events
    
    executor - executor to use for handling incoming map events
    
    Returns:
    
    future that will be completed when the operation finishes
  - removeListener
```
public CompletableFuture<Void> removeListener(MapEventListener<String,byte[]> listener)
```
    Description copied from interface: AsyncConsistentMap
    
    Unregisters the specified listener such that it will no longer receive map change notifications.
    
    Specified by:
    
    removeListener in interface AsyncConsistentMap<String,byte[]>
    
    Parameters:
    
    listener - listener to unregister
    
    Returns:
    
    future that will be completed when the operation finishes
  - firstKey
```
public CompletableFuture<String> firstKey()
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return the lowest key in the map.
    
    Specified by:
    
    firstKey in interface AsyncConsistentTreeMap<byte[]>
    
    Returns:
    
    the key or null if none exist
  - lastKey
```
public CompletableFuture<String> lastKey()
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return the highest key in the map.
    
    Specified by:
    
    lastKey in interface AsyncConsistentTreeMap<byte[]>
    
    Returns:
    
    the key or null if none exist
  - ceilingEntry
```
public CompletableFuture<Map.Entry<String,Versioned<byte[]>>> ceilingEntry(String key)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Returns the entry associated with the least key greater than or equal to the key.
    
    Specified by:
    
    ceilingEntry in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the entry or null if no suitable key exists
  - floorEntry
```
public CompletableFuture<Map.Entry<String,Versioned<byte[]>>> floorEntry(String key)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Returns the entry associated with the greatest key less than or equal to key.
    
    Specified by:
    
    floorEntry in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the entry or null if no suitable key exists
  - higherEntry
```
public CompletableFuture<Map.Entry<String,Versioned<byte[]>>> higherEntry(String key)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Returns the entry associated with the least key greater than key.
    
    Specified by:
    
    higherEntry in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the entry or null if no suitable key exists
  - lowerEntry
```
public CompletableFuture<Map.Entry<String,Versioned<byte[]>>> lowerEntry(String key)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Returns the entry associated with the largest key less than key.
    
    Specified by:
    
    lowerEntry in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the entry or null if no suitable key exists
  - firstEntry
```
public CompletableFuture<Map.Entry<String,Versioned<byte[]>>> firstEntry()
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return the entry associated with the lowest key in the map.
    
    Specified by:
    
    firstEntry in interface AsyncConsistentTreeMap<byte[]>
    
    Returns:
    
    the entry or null if none exist
  - lastEntry
```
public CompletableFuture<Map.Entry<String,Versioned<byte[]>>> lastEntry()
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return the entry associated with the highest key in the map.
    
    Specified by:
    
    lastEntry in interface AsyncConsistentTreeMap<byte[]>
    
    Returns:
    
    the entry or null if none exist
  - pollFirstEntry
```
public CompletableFuture<Map.Entry<String,Versioned<byte[]>>> pollFirstEntry()
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return and remove the entry associated with the lowest key.
    
    Specified by:
    
    pollFirstEntry in interface AsyncConsistentTreeMap<byte[]>
    
    Returns:
    
    the entry or null if none exist
  - pollLastEntry
```
public CompletableFuture<Map.Entry<String,Versioned<byte[]>>> pollLastEntry()
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return and remove the entry associated with the highest key.
    
    Specified by:
    
    pollLastEntry in interface AsyncConsistentTreeMap<byte[]>
    
    Returns:
    
    the entry or null if none exist
  - lowerKey
```
public CompletableFuture<String> lowerKey(String key)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return the entry associated with the greatest key less than key.
    
    Specified by:
    
    lowerKey in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the entry or null if no suitable key exists
  - floorKey
```
public CompletableFuture<String> floorKey(String key)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return the highest key less than or equal to key.
    
    Specified by:
    
    floorKey in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the entry or null if no suitable key exists
  - ceilingKey
```
public CompletableFuture<String> ceilingKey(String key)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return the lowest key greater than or equal to key.
    
    Specified by:
    
    ceilingKey in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the entry or null if no suitable key exists
  - higherKey
```
public CompletableFuture<String> higherKey(String key)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Return the lowest key greater than key.
    
    Specified by:
    
    higherKey in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the entry or null if no suitable key exists
  - navigableKeySet
```
public CompletableFuture<NavigableSet<String>> navigableKeySet()
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Returns a navigable set of the keys in this map.
    
    Specified by:
    
    navigableKeySet in interface AsyncConsistentTreeMap<byte[]>
    
    Returns:
    
    a navigable key set (this may be empty)
  - subMap
```
public CompletableFuture<NavigableMap<String,byte[]>> subMap(String upperKey,
                                                             String lowerKey,
                                                             boolean inclusiveUpper,
                                                             boolean inclusiveLower)
```
    Description copied from interface: AsyncConsistentTreeMap
    
    Returns a navigable map containing the entries from the original map which are larger than (or if specified equal to) lowerKey AND less than (or if specified equal to) upperKey.
    
    Specified by:
    
    subMap in interface AsyncConsistentTreeMap<byte[]>
    
    Parameters:
    
    upperKey - the upper bound for the keys in this map
    
    lowerKey - the lower bound for the keys in this map
    
    inclusiveUpper - whether keys equal to the upperKey should be included
    
    inclusiveLower - whether keys equal to the lowerKey should be included
    
    Returns:
    
    a navigable map containing entries in the specified range (this may be empty)
  - begin
```
public CompletableFuture<Version> begin(TransactionId transactionId)
```
    Description copied from interface: Transactional
    
    Begins the transaction.
    
    Specified by:
    
    begin in interface Transactional<MapUpdate<String,byte[]>>
    
    Parameters:
    
    transactionId - the transaction identifier for the transaction to begin
    
    Returns:
    
    a completable future to be completed with the lock version
  - prepare
```
public CompletableFuture<Boolean> prepare(TransactionLog<MapUpdate<String,byte[]>> transactionLog)
```
    Description copied from interface: Transactional
    
    Prepares a transaction for commitment.
    
    Specified by:
    
    prepare in interface Transactional<MapUpdate<String,byte[]>>
    
    Parameters:
    
    transactionLog - transaction log
    
    Returns:
    
    true if prepare is successful and transaction is ready to be committed false otherwise
  - prepareAndCommit
```
public CompletableFuture<Boolean> prepareAndCommit(TransactionLog<MapUpdate<String,byte[]>> transactionLog)
```
    Description copied from interface: Transactional
    
    Prepares and commits a transaction.
    
    Specified by:
    
    prepareAndCommit in interface Transactional<MapUpdate<String,byte[]>>
    
    Parameters:
    
    transactionLog - transaction log
    
    Returns:
    
    true if prepare is successful and transaction was committed false otherwise
  - commit
```
public CompletableFuture<Void> commit(TransactionId transactionId)
```
    Description copied from interface: Transactional
    
    Commits a previously prepared transaction and unlocks the object.
    
    Specified by:
    
    commit in interface Transactional<MapUpdate<String,byte[]>>
    
    Parameters:
    
    transactionId - transaction identifier
    
    Returns:
    
    future that will be completed when the operation finishes
  - rollback
```
public CompletableFuture<Void> rollback(TransactionId transactionId)
```
    Description copied from interface: Transactional
    
    Aborts a previously prepared transaction and unlocks the object.
    
    Specified by:
    
    rollback in interface Transactional<MapUpdate<String,byte[]>>
    
    Parameters:
    
    transactionId - transaction identifier
    
    Returns:
    
    future that will be completed when the operation finishes

Class AtomixConsistentTreeMap

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

Nested classes/interfaces inherited from interface io.atomix.resource.Resource

Field Summary

Fields inherited from class io.atomix.resource.AbstractResource

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

Constructor Summary

Method Summary

Methods inherited from class io.atomix.resource.AbstractResource

Methods inherited from class java.lang.Object

Methods inherited from interface org.onosproject.store.service.AsyncConsistentTreeMap

Methods inherited from interface org.onosproject.store.service.AsyncConsistentMap

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

Field Detail

CHANGE_SUBJECT

Constructor Detail

AtomixConsistentTreeMap

Method Detail

name

open

isEmpty

size

containsKey

containsValue

get

getOrDefault

keySet

values

entrySet

put

putAndGet

putIfAbsent

remove

remove

remove

replace

replace

replace

clear

computeIf

addListener

removeListener

firstKey

lastKey

ceilingEntry

floorEntry

higherEntry

lowerEntry

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

lowerKey

floorKey

ceilingKey

higherKey

navigableKeySet

subMap

begin

prepare

prepareAndCommit

commit

rollback