TranscodingAsyncAtomicCounterMap (onos-apps-fwd)

java.lang.Object
- org.onosproject.store.primitives.impl.TranscodingAsyncAtomicCounterMap<K1,K2>

All Implemented Interfaces:

AsyncAtomicCounterMap<K1>, DistributedPrimitive
```
public class TranscodingAsyncAtomicCounterMap<K1,K2>
extends Object
implements AsyncAtomicCounterMap<K1>
```
An AsyncAtomicCounterMap that transcodes keys.

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
`TranscodingAsyncAtomicCounterMap(AsyncAtomicCounterMap<K2> backingMap, Function<K1,K2> keyEncoder, Function<K2,K1> keyDecoder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<Long>`	`addAndGet(K1 key, long delta)` Adds delta to the value currently associated with key, and returns the new value.
`CompletableFuture<Void>`	`clear()` Removes all entries from the map.
`CompletableFuture<Long>`	`decrementAndGet(K1 key)` Decrements by one the value currently associated with key, and returns the new value.
`CompletableFuture<Long>`	`get(K1 key)` Returns the value associated with key, or zero if there is no value associated with key.
`CompletableFuture<Long>`	`getAndAdd(K1 key, long delta)` Adds delta to the value currently associated with key, and returns the old value.
`CompletableFuture<Long>`	`getAndDecrement(K1 key)` Decrements by one the value currently associated with key, and returns the old value.
`CompletableFuture<Long>`	`getAndIncrement(K1 key)` Increments by one the value currently associated with key, and returns the old value.
`CompletableFuture<Long>`	`incrementAndGet(K1 key)` Increments by one the value currently associated with key, and returns the new value.
`CompletableFuture<Boolean>`	`isEmpty()` Returns a boolean indicating whether the map is empty.
`String`	`name()` Returns the name of this primitive.
`CompletableFuture<Long>`	`put(K1 key, long newValue)` Associates ewValue with key in this map, and returns the value previously associated with key, or zero if there was no such value.
`CompletableFuture<Long>`	`putIfAbsent(K1 key, long newValue)` If key is not already associated with a value or if key is associated with zero, associate it with newValue.
`CompletableFuture<Long>`	`remove(K1 key)` Removes and returns the value associated with key.
`CompletableFuture<Boolean>`	`remove(K1 key, long value)` If (key, value) is currently in the map, this method removes it and returns true; otherwise, this method returns false.
`CompletableFuture<Boolean>`	`replace(K1 key, long expectedOldValue, long newValue)` If (key, expectedOldValue) is currently in the map, this method replaces expectedOldValue with newValue and returns true; otherwise, this method return false.
`CompletableFuture<Integer>`	`size()` Returns the number of entries in the map.

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

Methods inherited from interface org.onosproject.store.service.AsyncAtomicCounterMap
asAtomicCounterMap, asAtomicCounterMap, primitiveType

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

- Constructor Detail
  - TranscodingAsyncAtomicCounterMap
```
public TranscodingAsyncAtomicCounterMap(AsyncAtomicCounterMap<K2> backingMap,
                                        Function<K1,K2> keyEncoder,
                                        Function<K2,K1> keyDecoder)
```
- 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
  - incrementAndGet
```
public CompletableFuture<Long> incrementAndGet(K1 key)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Increments by one the value currently associated with key, and returns the new value.
    
    Specified by:
    
    incrementAndGet in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    Returns:
    
    incremented value
  - decrementAndGet
```
public CompletableFuture<Long> decrementAndGet(K1 key)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Decrements by one the value currently associated with key, and returns the new value.
    
    Specified by:
    
    decrementAndGet in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    Returns:
    
    updated value
  - getAndIncrement
```
public CompletableFuture<Long> getAndIncrement(K1 key)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Increments by one the value currently associated with key, and returns the old value.
    
    Specified by:
    
    getAndIncrement in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    Returns:
    
    previous value
  - getAndDecrement
```
public CompletableFuture<Long> getAndDecrement(K1 key)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Decrements by one the value currently associated with key, and returns the old value.
    
    Specified by:
    
    getAndDecrement in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    Returns:
    
    previous value
  - addAndGet
```
public CompletableFuture<Long> addAndGet(K1 key,
                                         long delta)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Adds delta to the value currently associated with key, and returns the new value.
    
    Specified by:
    
    addAndGet in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    delta - the value to add
    
    Returns:
    
    updated value
  - getAndAdd
```
public CompletableFuture<Long> getAndAdd(K1 key,
                                         long delta)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Adds delta to the value currently associated with key, and returns the old value.
    
    Specified by:
    
    getAndAdd in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    delta - the value to add
    
    Returns:
    
    previous value
  - get
```
public CompletableFuture<Long> get(K1 key)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Returns the value associated with key, or zero if there is no value associated with key.
    
    Specified by:
    
    get in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    Returns:
    
    current value
  - put
```
public CompletableFuture<Long> put(K1 key,
                                   long newValue)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Associates ewValue with key in this map, and returns the value previously associated with key, or zero if there was no such value.
    
    Specified by:
    
    put in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    newValue - the value to put
    
    Returns:
    
    previous value or zero
  - putIfAbsent
```
public CompletableFuture<Long> putIfAbsent(K1 key,
                                           long newValue)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    If key is not already associated with a value or if key is associated with zero, associate it with newValue. Returns the previous value associated with key, or zero if there was no mapping for key.
    
    Specified by:
    
    putIfAbsent in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    newValue - the value to put
    
    Returns:
    
    previous value or zero
  - replace
```
public CompletableFuture<Boolean> replace(K1 key,
                                          long expectedOldValue,
                                          long newValue)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    If (key, expectedOldValue) is currently in the map, this method replaces expectedOldValue with newValue and returns true; otherwise, this method return false. If expectedOldValue is zero, this method will succeed if (key, zero) is currently in the map, or if key is not in the map at all.
    
    Specified by:
    
    replace in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    expectedOldValue - the expected value
    
    newValue - the value to replace
    
    Returns:
    
    true if the value was replaced, false otherwise
  - remove
```
public CompletableFuture<Long> remove(K1 key)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Removes and returns the value associated with key. If key is not in the map, this method has no effect and returns zero.
    
    Specified by:
    
    remove in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    Returns:
    
    the previous value associated with the specified key or null
  - remove
```
public CompletableFuture<Boolean> remove(K1 key,
                                         long value)
```
    Description copied from interface: AsyncAtomicCounterMap
    
    If (key, value) is currently in the map, this method removes it and returns true; otherwise, this method returns false.
    
    Specified by:
    
    remove in interface AsyncAtomicCounterMap<K1>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - the value to remove
    
    Returns:
    
    true if the value was removed, false otherwise
  - size
```
public CompletableFuture<Integer> size()
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Returns the number of entries in the map.
    
    Specified by:
    
    size in interface AsyncAtomicCounterMap<K1>
    
    Returns:
    
    the number of entries in the map
  - isEmpty
```
public CompletableFuture<Boolean> isEmpty()
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Returns a boolean indicating whether the map is empty.
    
    Specified by:
    
    isEmpty in interface AsyncAtomicCounterMap<K1>
    
    Returns:
    
    true if the map is empty, false otherwise
  - clear
```
public CompletableFuture<Void> clear()
```
    Description copied from interface: AsyncAtomicCounterMap
    
    Removes all entries from the map.
    
    Specified by:
    
    clear in interface AsyncAtomicCounterMap<K1>
    
    Returns:
    
    void

Class TranscodingAsyncAtomicCounterMap<K1,K2>

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Constructor Detail

TranscodingAsyncAtomicCounterMap

Method Detail

name

incrementAndGet

decrementAndGet

getAndIncrement

getAndDecrement

addAndGet

getAndAdd

get

put

putIfAbsent

replace

remove

remove

size

isEmpty

clear