TransactionalMapParticipant (onos-apps-fwd)

java.lang.Object
- org.onosproject.store.primitives.impl.TransactionalMapParticipant<K,V>

Type Parameters:

K - key type

V - value type.

All Implemented Interfaces:

TransactionParticipant, TransactionalMap<K,V>

Direct Known Subclasses:

DefaultTransactionalMapParticipant
```
public abstract class TransactionalMapParticipant<K,V>
extends Object
implements TransactionalMap<K,V>, TransactionParticipant
```
Base class for participants within a single TransactionalMap.
This class provides the basic functionality required by transactional map participants and provides methods for defining operations specific to individual isolation levels.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ConsistentMap<K,V>`	`backingMap`
`protected Set<K>`	`deleteSet`
`protected Version`	`lock`
`protected Transaction<MapUpdate<K,V>>`	`transaction`
`protected Map<K,V>`	`writeCache`

Constructor Summary

Constructors
Modifier Constructor and Description

protected TransactionalMapParticipant(ConsistentMap<K,V> backingMap, Transaction<MapUpdate<K,V>> transaction)

Constructors
Modifier	Constructor and Description
`protected`	`TransactionalMapParticipant(ConsistentMap<K,V> backingMap, Transaction<MapUpdate<K,V>> transaction)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<Void>`	`commit()` Attempts to execute the commit phase for previously prepared transaction.
`boolean`	`containsKey(K key)` Returns true if this map contains a mapping for the specified key.
`V`	`get(K key)` Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
`protected List<MapUpdate<K,V>>`	`log(Version lockVersion)` Returns a list of updates performed within this map partition.
`CompletableFuture<Boolean>`	`prepare()` Executes the prepare phase.
`CompletableFuture<Boolean>`	`prepareAndCommit()` Executes the prepare and commit phases atomically.
`V`	`put(K key, V value)` Associates the specified value with the specified key in this map (optional operation).
`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 returns the current value.
`protected abstract V`	`read(K key)` Executes a get operation based on the transaction isolation level.
`protected abstract Stream<MapUpdate<K,V>>`	`records(Version lockVersion)` Returns a stream of updates performed within this map partition.
`V`	`remove(K key)` Removes the mapping for a key from this map if it is present (optional operation).
`boolean`	`remove(K key, V value)` Removes the entry for the specified key only if it is currently mapped to the specified value.
`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()` Attempts to execute the rollback phase for previously prepared transaction.
`String`	`toString()`

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

Methods inherited from interface org.onosproject.store.primitives.impl.TransactionParticipant
hasPendingUpdates

- Field Detail
  - backingMap
```
protected final ConsistentMap<K,V> backingMap
```
  - transaction
```
protected final Transaction<MapUpdate<K,V>> transaction
```
  - writeCache
```
protected final Map<K,V> writeCache
```
  - deleteSet
```
protected final Set<K> deleteSet
```
  - lock
```
protected volatile Version lock
```
- Constructor Detail
  - TransactionalMapParticipant
```
protected TransactionalMapParticipant(ConsistentMap<K,V> backingMap,
                                      Transaction<MapUpdate<K,V>> transaction)
```
- Method Detail
  - get
```
public V get(K key)
```
    Description copied from interface: TransactionalMap
    
    Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
    
    Specified by:
    
    get in interface TransactionalMap<K,V>
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or null if this map contains no mapping for the key
  - read
```
protected abstract V read(K key)
```
    Executes a get operation based on the transaction isolation level.
    
    Parameters:
    
    key - the key to look up
    
    Returns:
    
    the value
  - containsKey
```
public boolean containsKey(K key)
```
    Description copied from interface: TransactionalMap
    
    Returns true if this map contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface TransactionalMap<K,V>
    
    Parameters:
    
    key - key whose presence in this map to be tested
    
    Returns:
    
    true if this map contains a mapping for the specified key
  - put
```
public V put(K key,
             V value)
```
    Description copied from interface: TransactionalMap
    
    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 TransactionalMap<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 key, or null if there was no mapping for key.
  - remove
```
public V remove(K key)
```
    Description copied from interface: TransactionalMap
    
    Removes the mapping for a key from this map if it is present (optional operation).
    
    Specified by:
    
    remove in interface TransactionalMap<K,V>
    
    Parameters:
    
    key - key whose value is to be removed from the map
    
    Returns:
    
    the value to which this map previously associated the key, or null if the map contained no mapping for the key.
  - remove
```
public boolean remove(K key,
                      V value)
```
    Description copied from interface: TransactionalMap
    
    Removes the entry for the specified key only if it is currently mapped to the specified value.
    
    Specified by:
    
    remove in interface TransactionalMap<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
  - replace
```
public boolean replace(K key,
                       V oldValue,
                       V newValue)
```
    Description copied from interface: TransactionalMap
    
    Replaces the entry for the specified key only if currently mapped to the specified value.
    
    Specified by:
    
    replace in interface TransactionalMap<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
  - putIfAbsent
```
public V putIfAbsent(K key,
                     V value)
```
    Description copied from interface: TransactionalMap
    
    If the specified key is not already associated with a value associates it with the given value and returns null, else returns the current value.
    
    Specified by:
    
    putIfAbsent in interface TransactionalMap<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.
  - prepare
```
public CompletableFuture<Boolean> prepare()
```
    Description copied from interface: TransactionParticipant
    
    Executes the prepare phase.
    
    Specified by:
    
    prepare in interface TransactionParticipant
    
    Returns:
    
    true is successful; false otherwise
  - commit
```
public CompletableFuture<Void> commit()
```
    Description copied from interface: TransactionParticipant
    
    Attempts to execute the commit phase for previously prepared transaction.
    
    Specified by:
    
    commit in interface TransactionParticipant
    
    Returns:
    
    future that is completed when the operation completes
  - prepareAndCommit
```
public CompletableFuture<Boolean> prepareAndCommit()
```
    Description copied from interface: TransactionParticipant
    
    Executes the prepare and commit phases atomically.
    
    Specified by:
    
    prepareAndCommit in interface TransactionParticipant
    
    Returns:
    
    true is successful; false otherwise
  - rollback
```
public CompletableFuture<Void> rollback()
```
    Description copied from interface: TransactionParticipant
    
    Attempts to execute the rollback phase for previously prepared transaction.
    
    Specified by:
    
    rollback in interface TransactionParticipant
    
    Returns:
    
    future that is completed when the operation completes
  - log
```
protected List<MapUpdate<K,V>> log(Version lockVersion)
```
    Returns a list of updates performed within this map partition.
    
    Parameters:
    
    lockVersion - the global transaction lock version
    
    Returns:
    
    a list of map updates
  - records
```
protected abstract Stream<MapUpdate<K,V>> records(Version lockVersion)
```
    Returns a stream of updates performed within this map partition.
    
    Parameters:
    
    lockVersion - the global transaction lock version
    
    Returns:
    
    a stream of map updates
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TransactionalMapParticipant<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.onosproject.store.primitives.impl.TransactionParticipant

Field Detail

backingMap

transaction

writeCache

deleteSet

lock

Constructor Detail

TransactionalMapParticipant

Method Detail

get

read

containsKey

put

remove

remove

replace

putIfAbsent

prepare

commit

prepareAndCommit

rollback

log

records

toString