org.onosproject.store.primitives.impl

Class DelegatingAsyncConsistentMap<K,V>

java.lang.Object

org.onosproject.store.primitives.impl.DelegatingDistributedPrimitive

org.onosproject.store.primitives.impl.DelegatingAsyncConsistentMap<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

AsyncConsistentMap<K,V>, DistributedPrimitive, Transactional<MapUpdate<K,V>>

Direct Known Subclasses:

CachingAsyncConsistentMap, MeteredAsyncConsistentMap, UnmodifiableAsyncConsistentMap

public class DelegatingAsyncConsistentMap<K,V>
extends DelegatingDistributedPrimitive
implements AsyncConsistentMap<K,V>

AsyncConsistentMap that merely delegates control to another AsyncConsistentMap.

Nested Class Summary

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

DistributedPrimitive.Status, DistributedPrimitive.Type

Field Summary

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

DEFAULT_OPERTATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addListener(MapEventListener<K,V> listener, Executor executor) Registers the specified listener to be notified whenever the map is updated.
void	addStatusChangeListener(Consumer<DistributedPrimitive.Status> listener) Registers a listener to be called when the primitive's status changes.
CompletableFuture<Version>	begin(TransactionId transactionId) Begins the transaction.
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<V>>	computeIf(K key, Predicate<? super V> condition, BiFunction<? super K,? super V,? extends V> 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(K key) Returns true if this map contains a mapping for the specified key.
CompletableFuture<Boolean>	containsValue(V value) Returns true if this map contains the specified value.
CompletableFuture<Set<Map.Entry<K,Versioned<V>>>>	entrySet() Returns the set of entries contained in this map.
boolean	equals(Object other)
CompletableFuture<Versioned<V>>	get(K 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<V>>	getOrDefault(K key, V 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.
int	hashCode()
CompletableFuture<Set<K>>	keySet() Returns a Set view of the keys contained in this map.
CompletableFuture<Boolean>	prepare(TransactionLog<MapUpdate<K,V>> transactionLog) Prepares a transaction for commitment.
CompletableFuture<Boolean>	prepareAndCommit(TransactionLog<MapUpdate<K,V>> transactionLog) Prepares and commits a transaction.
CompletableFuture<Versioned<V>>	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
CompletableFuture<Versioned<V>>	putAndGet(K key, V value) Associates the specified value with the specified key in this map (optional operation).
CompletableFuture<Versioned<V>>	putIfAbsent(K key, V 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<V>>	remove(K key) Removes the mapping for a key from this map if it is present (optional operation).
CompletableFuture<Boolean>	remove(K 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<Boolean>	remove(K key, V value) Removes the entry for the specified key only if it is currently mapped to the specified value.
CompletableFuture<Void>	removeListener(MapEventListener<K,V> listener) Unregisters the specified listener such that it will no longer receive map change notifications.
void	removeStatusChangeListener(Consumer<DistributedPrimitive.Status> listener) Unregisters a previously registered listener to be called when the primitive's status changes.
CompletableFuture<Boolean>	replace(K key, long oldVersion, V newValue) Replaces the entry for the specified key only if it is currently mapped to the specified version.
CompletableFuture<Versioned<V>>	replace(K key, V value) Replaces the entry for the specified key only if there is any value which associated with specified key.
CompletableFuture<Boolean>	replace(K key, V oldValue, V newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
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.
Collection<Consumer<DistributedPrimitive.Status>>	statusChangeListeners() Returns the collection of status change listeners previously registered.
String	toString()
CompletableFuture<Collection<Versioned<V>>>	values() Returns the collection of values (and associated versions) contained in this map.

Methods inherited from class org.onosproject.store.primitives.impl.DelegatingDistributedPrimitive

applicationId, destroy, name, primitiveType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addListener, asConsistentMap, asConsistentMap, compute, computeIfAbsent, computeIfPresent, destroy, isEmpty, primitiveType

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

applicationId, name

Method Detail

size

public CompletableFuture<Integer> size()

Description copied from interface: AsyncConsistentMap

Returns the number of entries in the map.

Specified by:

size in interface AsyncConsistentMap<K,V>

Returns:

a future for map size.

containsKey

public CompletableFuture<Boolean> containsKey(K key)

Description copied from interface: AsyncConsistentMap

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface AsyncConsistentMap<K,V>

Parameters:

key - key

Returns:

a future whose value will be true if map contains key, false otherwise.

containsValue

public CompletableFuture<Boolean> containsValue(V value)

Description copied from interface: AsyncConsistentMap

Returns true if this map contains the specified value.

Specified by:

containsValue in interface AsyncConsistentMap<K,V>

Parameters:

value - value

Returns:

a future whose value will be true if map contains value, false otherwise.

get

public CompletableFuture<Versioned<V>> get(K 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<K,V>

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<V>> getOrDefault(K key,
                                                    V 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<K,V>

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

computeIf

public CompletableFuture<Versioned<V>> computeIf(K key,
                                                 Predicate<? super V> condition,
                                                 BiFunction<? super K,? super V,? extends V> 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<K,V>

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

put

public CompletableFuture<Versioned<V>> put(K key,
                                           V 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<K,V>

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<V>> putAndGet(K key,
                                                 V 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<K,V>

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

new value.

remove

public CompletableFuture<Versioned<V>> remove(K 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<K,V>

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.

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<K,V>

Returns:

future that will be successfully completed when the map is cleared

keySet

public CompletableFuture<Set<K>> 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<K,V>

Returns:

a set of the keys contained in this map

values

public CompletableFuture<Collection<Versioned<V>>> 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<K,V>

Returns:

a collection of the values (and associated versions) contained in this map

entrySet

public CompletableFuture<Set<Map.Entry<K,Versioned<V>>>> 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<K,V>

Returns:

set of entries contained in this map.

putIfAbsent

public CompletableFuture<Versioned<V>> putIfAbsent(K key,
                                                   V 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<K,V>

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<Boolean> remove(K key,
                                         V 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<K,V>

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(K 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<K,V>

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<V>> replace(K key,
                                               V 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<K,V>

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(K key,
                                          V oldValue,
                                          V 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<K,V>

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(K key,
                                          long oldVersion,
                                          V 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<K,V>

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

addListener

public CompletableFuture<Void> addListener(MapEventListener<K,V> 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<K,V>

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<K,V> 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<K,V>

Parameters:

listener - listener to unregister

Returns:

future that will be completed when the operation finishes

begin

public CompletableFuture<Version> begin(TransactionId transactionId)

Description copied from interface: Transactional

Begins the transaction.

Specified by:

begin in interface Transactional<MapUpdate<K,V>>

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<K,V>> transactionLog)

Description copied from interface: Transactional

Prepares a transaction for commitment.

Specified by:

prepare in interface Transactional<MapUpdate<K,V>>

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<K,V>> transactionLog)

Description copied from interface: Transactional

Prepares and commits a transaction.

Specified by:

prepareAndCommit in interface Transactional<MapUpdate<K,V>>

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<K,V>>

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<K,V>>

Parameters:

transactionId - transaction identifier

Returns:

future that will be completed when the operation finishes

addStatusChangeListener

public void addStatusChangeListener(Consumer<DistributedPrimitive.Status> listener)

Description copied from interface: DistributedPrimitive

Registers a listener to be called when the primitive's status changes.

Specified by:

addStatusChangeListener in interface DistributedPrimitive

Overrides:

addStatusChangeListener in class DelegatingDistributedPrimitive

Parameters:

listener - The listener to be called when the status changes.

removeStatusChangeListener

public void removeStatusChangeListener(Consumer<DistributedPrimitive.Status> listener)

Description copied from interface: DistributedPrimitive

Unregisters a previously registered listener to be called when the primitive's status changes.

Specified by:

removeStatusChangeListener in interface DistributedPrimitive

Overrides:

removeStatusChangeListener in class DelegatingDistributedPrimitive

Parameters:

listener - The listener to unregister

statusChangeListeners

public Collection<Consumer<DistributedPrimitive.Status>> statusChangeListeners()

Description copied from interface: DistributedPrimitive

Returns the collection of status change listeners previously registered.

Specified by:

statusChangeListeners in interface DistributedPrimitive

Overrides:

statusChangeListeners in class DelegatingDistributedPrimitive

Returns:

collection of status change listeners

toString

public String toString()

Overrides:

toString in class DelegatingDistributedPrimitive

hashCode

public int hashCode()

Overrides:

hashCode in class DelegatingDistributedPrimitive

equals

public boolean equals(Object other)

Overrides:

equals in class DelegatingDistributedPrimitive