org.onosproject.store.primitives.impl

Class UnmodifiableAsyncConsistentMap<K,V>

java.lang.Object

org.onosproject.store.primitives.impl.DelegatingDistributedPrimitive

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

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

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

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

public class UnmodifiableAsyncConsistentMap<K,V>
extends DelegatingAsyncConsistentMap<K,V>

An unmodifiable AsyncConsistentMap.

Any attempt to update the map through this instance will cause the operation to be completed with an UnsupportedOperationException.

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

Constructor Summary

Constructors

Constructor and Description
UnmodifiableAsyncConsistentMap(AsyncConsistentMap<K,V> backingMap)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	clear() Removes all of the mappings from this map (optional operation).
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<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<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.

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

addListener, addStatusChangeListener, begin, commit, containsKey, containsValue, entrySet, equals, get, getOrDefault, hashCode, keySet, prepare, prepareAndCommit, removeListener, removeStatusChangeListener, rollback, size, statusChangeListeners, toString, values

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

Constructor Detail

UnmodifiableAsyncConsistentMap

public UnmodifiableAsyncConsistentMap(AsyncConsistentMap<K,V> backingMap)

Method Detail

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>

Overrides:

computeIf in class DelegatingAsyncConsistentMap<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>

Overrides:

put in class DelegatingAsyncConsistentMap<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>

Overrides:

putAndGet in class DelegatingAsyncConsistentMap<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>

Overrides:

remove in class DelegatingAsyncConsistentMap<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>

Overrides:

clear in class DelegatingAsyncConsistentMap<K,V>

Returns:

future that will be successfully completed when the map is cleared

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>

Overrides:

putIfAbsent in class DelegatingAsyncConsistentMap<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>

Overrides:

remove in class DelegatingAsyncConsistentMap<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>

Overrides:

remove in class DelegatingAsyncConsistentMap<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>

Overrides:

replace in class DelegatingAsyncConsistentMap<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>

Overrides:

replace in class DelegatingAsyncConsistentMap<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>

Overrides:

replace in class DelegatingAsyncConsistentMap<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