io.atomix.core.transaction

Interface AsyncTransactionalSet<E>

All Superinterfaces:

AsyncPrimitive, DistributedPrimitive

public interface AsyncTransactionalSet<E>
extends AsyncPrimitive

Transactional set.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	add(E e) Adds the specified element to this set if it is not already present (optional operation).
CompletableFuture<Boolean>	contains(E e) Returns true if this set contains the specified element.
CompletableFuture<Boolean>	remove(E e) Removes the specified element from this set if it is present (optional operation).
default TransactionalSet<E>	sync() Returns a synchronous wrapper around the asynchronous primitive.
TransactionalSet<E>	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

add

CompletableFuture<Boolean> add(E e)

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that (e==null ? e2==null : e.equals(e2)). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

Parameters:

e - element to be added to this set

Returns:

true if this set did not already contain the specified element

remove

CompletableFuture<Boolean> remove(E e)

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters:

e - element to be removed to this set

Returns:

true if this set contained the specified element

contains

CompletableFuture<Boolean> contains(E e)

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that (o==null ? e==null : o.equals(e)).

Parameters:

e - element whose presence in this set is to be tested

Returns:

true if this set contains the specified element

Throws:

ClassCastException - if the type of the specified element is incompatible with this set

NullPointerException - if the specified element is null and this set does not permit null elements

sync

default TransactionalSet<E> 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

TransactionalSet<E> 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