io.atomix.core.transaction

Interface TransactionalSet<E>

All Superinterfaces:

DistributedPrimitive, SyncPrimitive

public interface TransactionalSet<E>
extends SyncPrimitive

Transactional set.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
boolean	add(E e) Adds the specified element to this set if it is not already present (optional operation).
AsyncTransactionalSet<E>	async() Returns the underlying asynchronous primitive.
boolean	contains(E e) Returns true if this set contains the specified element.
boolean	remove(E e) Removes the specified element from this set if it is present (optional operation).

Methods inherited from interface io.atomix.primitive.SyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Method Detail

add

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

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

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

async

AsyncTransactionalSet<E> async()

Description copied from interface: SyncPrimitive

Returns the underlying asynchronous primitive.

Specified by:

async in interface SyncPrimitive

Returns:

the underlying asynchronous primitive