io.atomix.core.transaction

Interface AsyncTransactionalMap<K,V>

All Superinterfaces:

AsyncPrimitive, DistributedPrimitive

public interface AsyncTransactionalMap<K,V>
extends AsyncPrimitive

Asynchronous transactional map.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	containsKey(K key) Returns true if this map contains a mapping for the specified key.
CompletableFuture<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.
CompletableFuture<V>	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
CompletableFuture<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.
CompletableFuture<V>	remove(K key) Removes the mapping for a key from this map if it is present (optional operation).
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, V oldValue, V newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
default TransactionalMap<K,V>	sync() Returns a synchronous wrapper around the asynchronous primitive.
TransactionalMap<K,V>	sync(Duration operationTimeout) Returns a synchronous wrapper around the asynchronous primitive.

Methods inherited from interface io.atomix.primitive.AsyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Method Detail

get

CompletableFuture<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.

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

containsKey

CompletableFuture<Boolean> containsKey(K key)

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

Parameters:

key - key whose presence in this map to be tested

Returns:

true if this map contains a mapping for the specified key

put

CompletableFuture<V> put(K key,
                         V value)

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.

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

CompletableFuture<V> remove(K key)

Removes the mapping for a key from this map if it is present (optional operation).

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.

putIfAbsent

CompletableFuture<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.

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

CompletableFuture<Boolean> remove(K key,
                                  V value)

Removes the entry for the specified key only if it is currently mapped to the specified value.

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

CompletableFuture<Boolean> replace(K key,
                                   V oldValue,
                                   V newValue)

Replaces the entry for the specified key only if currently mapped to the specified value.

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

sync

default TransactionalMap<K,V> sync()

Description copied from interface: AsyncPrimitive

Returns a synchronous wrapper around the asynchronous primitive.

Specified by:

sync in interface AsyncPrimitive

Returns:

the synchronous primitive

sync

TransactionalMap<K,V> sync(Duration operationTimeout)

Description copied from interface: AsyncPrimitive

Returns a synchronous wrapper around the asynchronous primitive.

Specified by:

sync in interface AsyncPrimitive

Parameters:

operationTimeout - the synchronous operation timeout

Returns:

the synchronous primitive