DatabaseProxy (onos-core-dist 1.1.0 API)

All Known Subinterfaces:

Database

All Known Implementing Classes:

DefaultDatabase, PartitionedDatabase
```
public interface DatabaseProxy<K,V>
```
Database proxy.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<Boolean>`	`atomicBatchUpdate(List<org.onosproject.store.service.UpdateOperation<K,V>> updates)` Perform a atomic batch update operation i.e.
`CompletableFuture<Void>`	`clear(String tableName)` Clears the table.
`CompletableFuture<Boolean>`	`containsKey(String tableName, K key)` Checks whether the table contains a key.
`CompletableFuture<Boolean>`	`containsValue(String tableName, V value)` Checks whether the table contains a value.
`CompletableFuture<Set<Map.Entry<K,org.onosproject.store.service.Versioned<V>>>>`	`entrySet(String tableName)` Gets a set of entries in the table.
`CompletableFuture<org.onosproject.store.service.Versioned<V>>`	`get(String tableName, K key)` Gets a value from the table.
`CompletableFuture<Boolean>`	`isEmpty(String tableName)` Checks whether the table is empty.
`CompletableFuture<Set<K>>`	`keySet(String tableName)` Gets a set of keys in the table.
`CompletableFuture<org.onosproject.store.service.Versioned<V>>`	`put(String tableName, K key, V value)` Puts a value in the table.
`CompletableFuture<org.onosproject.store.service.Versioned<V>>`	`putIfAbsent(String tableName, K key, V value)` Puts a value in the table if the given key does not exist.
`CompletableFuture<org.onosproject.store.service.Versioned<V>>`	`remove(String tableName, K key)` Removes a value from the table.
`CompletableFuture<Boolean>`	`remove(String tableName, K key, long version)` Removes a key and if the existing version for that key matches the specified version.
`CompletableFuture<Boolean>`	`remove(String tableName, K key, V value)` Removes a key and if the existing value for that key matches the specified value.
`CompletableFuture<Boolean>`	`replace(String tableName, K key, long oldVersion, V newValue)` Replaces the entry for the specified key only if currently mapped to the specified version.
`CompletableFuture<Boolean>`	`replace(String tableName, K key, V oldValue, V newValue)` Replaces the entry for the specified key only if currently mapped to the specified value.
`CompletableFuture<Integer>`	`size(String tableName)` Gets the table size.
`CompletableFuture<Collection<org.onosproject.store.service.Versioned<V>>>`	`values(String tableName)` Gets a collection of values in the table.

- Method Detail
  - size
```
CompletableFuture<Integer> size(String tableName)
```
    Gets the table size.
    
    Parameters:
    
    tableName - table name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - isEmpty
```
CompletableFuture<Boolean> isEmpty(String tableName)
```
    Checks whether the table is empty.
    
    Parameters:
    
    tableName - table name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - containsKey
```
CompletableFuture<Boolean> containsKey(String tableName,
                                       K key)
```
    Checks whether the table contains a key.
    
    Parameters:
    
    tableName - table name
    
    key - The key to check.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - containsValue
```
CompletableFuture<Boolean> containsValue(String tableName,
                                         V value)
```
    Checks whether the table contains a value.
    
    Parameters:
    
    tableName - table name
    
    value - The value to check.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - get
```
CompletableFuture<org.onosproject.store.service.Versioned<V>> get(String tableName,
                                                                  K key)
```
    Gets a value from the table.
    
    Parameters:
    
    tableName - table name
    
    key - The key to get.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - put
```
CompletableFuture<org.onosproject.store.service.Versioned<V>> put(String tableName,
                                                                  K key,
                                                                  V value)
```
    Puts a value in the table.
    
    Parameters:
    
    tableName - table name
    
    key - The key to set.
    
    value - The value to set.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - remove
```
CompletableFuture<org.onosproject.store.service.Versioned<V>> remove(String tableName,
                                                                     K key)
```
    Removes a value from the table.
    
    Parameters:
    
    tableName - table name
    
    key - The key to remove.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - clear
```
CompletableFuture<Void> clear(String tableName)
```
    Clears the table.
    
    Parameters:
    
    tableName - table name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - keySet
```
CompletableFuture<Set<K>> keySet(String tableName)
```
    Gets a set of keys in the table.
    
    Parameters:
    
    tableName - table name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - values
```
CompletableFuture<Collection<org.onosproject.store.service.Versioned<V>>> values(String tableName)
```
    Gets a collection of values in the table.
    
    Parameters:
    
    tableName - table name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - entrySet
```
CompletableFuture<Set<Map.Entry<K,org.onosproject.store.service.Versioned<V>>>> entrySet(String tableName)
```
    Gets a set of entries in the table.
    
    Parameters:
    
    tableName - table name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - putIfAbsent
```
CompletableFuture<org.onosproject.store.service.Versioned<V>> putIfAbsent(String tableName,
                                                                          K key,
                                                                          V value)
```
    Puts a value in the table if the given key does not exist.
    
    Parameters:
    
    tableName - table name
    
    key - The key to set.
    
    value - The value to set if the given key does not exist.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - remove
```
CompletableFuture<Boolean> remove(String tableName,
                                  K key,
                                  V value)
```
    Removes a key and if the existing value for that key matches the specified value.
    
    Parameters:
    
    tableName - table name
    
    key - The key to remove.
    
    value - The value to remove.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - remove
```
CompletableFuture<Boolean> remove(String tableName,
                                  K key,
                                  long version)
```
    Removes a key and if the existing version for that key matches the specified version.
    
    Parameters:
    
    tableName - table name
    
    key - The key to remove.
    
    version - The expected version.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - replace
```
CompletableFuture<Boolean> replace(String tableName,
                                   K key,
                                   V oldValue,
                                   V newValue)
```
    Replaces the entry for the specified key only if currently mapped to the specified value.
    
    Parameters:
    
    tableName - table name
    
    key - The key to replace.
    
    oldValue - The value to replace.
    
    newValue - The value with which to replace the given key and value.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - replace
```
CompletableFuture<Boolean> replace(String tableName,
                                   K key,
                                   long oldVersion,
                                   V newValue)
```
    Replaces the entry for the specified key only if currently mapped to the specified version.
    
    Parameters:
    
    tableName - table name
    
    key - The key to update
    
    oldVersion - existing version in the map for this replace to succeed.
    
    newValue - The value with which to replace the given key and version.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - atomicBatchUpdate
```
CompletableFuture<Boolean> atomicBatchUpdate(List<org.onosproject.store.service.UpdateOperation<K,V>> updates)
```
    Perform a atomic batch update operation i.e. either all operations in batch succeed or none do and no state changes are made.
    
    Parameters:
    
    updates - list of updates to apply atomically.
    
    Returns:
    
    A completable future to be completed with the result once complete.

Interface DatabaseProxy<K,V>

Method Summary

Method Detail

size

isEmpty

containsKey

containsValue

get

put

remove

clear

keySet

values

entrySet

putIfAbsent

remove

remove

replace

replace

atomicBatchUpdate