io.atomix.core.collection

Interface AsyncDistributedCollection<E>

All Superinterfaces:

AsyncIterable<E>, AsyncPrimitive, DistributedPrimitive

All Known Subinterfaces:

AsyncDistributedList<E>, AsyncDistributedMultiset<E>, AsyncDistributedNavigableSet<E>, AsyncDistributedQueue<E>, AsyncDistributedSet<E>, AsyncDistributedSortedSet<E>

public interface AsyncDistributedCollection<E>
extends AsyncPrimitive, AsyncIterable<E>

Asynchronous distributed collection.

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 element) Adds the specified element to this collection if it is not already present (optional operation).
CompletableFuture<Boolean>	addAll(Collection<? extends E> c) Adds all of the elements in the specified collection to this collection if they're not already present (optional operation).
default CompletableFuture<Void>	addListener(CollectionEventListener<E> listener) Registers the specified listener to be notified whenever the collection is updated.
CompletableFuture<Void>	addListener(CollectionEventListener<E> listener, Executor executor) Registers the specified listener to be notified whenever the collection is updated.
CompletableFuture<Void>	clear() Removes all elements from the collection.
CompletableFuture<Boolean>	contains(E element) Returns if this collection contains the specified element.
CompletableFuture<Boolean>	containsAll(Collection<? extends E> c) Returns if this collection contains all the elements in specified collection.
CompletableFuture<Boolean>	isEmpty() Returns if the collection is empty.
CompletableFuture<Boolean>	remove(E element) Removes the specified element to this collection if it is present (optional operation).
CompletableFuture<Boolean>	removeAll(Collection<? extends E> c) Removes from this collection all of its elements that are contained in the specified collection (optional operation).
CompletableFuture<Void>	removeListener(CollectionEventListener<E> listener) Unregisters the specified listener.
CompletableFuture<Boolean>	retainAll(Collection<? extends E> c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
CompletableFuture<Integer>	size() Returns the number of elements in the collection.
default DistributedCollection<E>	sync() Returns a synchronous wrapper around the asynchronous primitive.
DistributedCollection<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

Methods inherited from interface io.atomix.core.iterator.AsyncIterable

iterator, stream

Method Detail

add

CompletableFuture<Boolean> add(E element)

Adds the specified element to this collection if it is not already present (optional operation).

Parameters:

element - element to add

Returns:

true if this collection did not already contain the specified element.

remove

CompletableFuture<Boolean> remove(E element)

Removes the specified element to this collection if it is present (optional operation).

Parameters:

element - element to remove

Returns:

true if this collection contained the specified element

size

CompletableFuture<Integer> size()

Returns the number of elements in the collection.

Returns:

size of the collection

isEmpty

CompletableFuture<Boolean> isEmpty()

Returns if the collection is empty.

Returns:

true if this collection is empty

clear

CompletableFuture<Void> clear()

Removes all elements from the collection.

Returns:

CompletableFuture that is completed when the operation completes

contains

CompletableFuture<Boolean> contains(E element)

Returns if this collection contains the specified element.

Parameters:

element - element to check

Returns:

true if this collection contains the specified element

addAll

CompletableFuture<Boolean> addAll(Collection<? extends E> c)

Adds all of the elements in the specified collection to this collection if they're not already present (optional operation).

Parameters:

c - collection containing elements to be added to this collection

Returns:

true if this collection contains all elements in the collection

containsAll

CompletableFuture<Boolean> containsAll(Collection<? extends E> c)

Returns if this collection contains all the elements in specified collection.

Parameters:

c - collection

Returns:

true if this collection contains all elements in the collection

retainAll

CompletableFuture<Boolean> retainAll(Collection<? extends E> c)

Retains only the elements in this collection that are contained in the specified collection (optional operation).

Parameters:

c - collection containing elements to be retained in this collection

Returns:

true if this collection changed as a result of the call

removeAll

CompletableFuture<Boolean> removeAll(Collection<? extends E> c)

Removes from this collection all of its elements that are contained in the specified collection (optional operation).

Parameters:

c - collection containing elements to be removed from this collection

Returns:

true if this collection changed as a result of the call

addListener

default CompletableFuture<Void> addListener(CollectionEventListener<E> listener)

Registers the specified listener to be notified whenever the collection is updated.

Parameters:

listener - listener to notify about collection update events

Returns:

CompletableFuture that is completed when the operation completes

addListener

CompletableFuture<Void> addListener(CollectionEventListener<E> listener,
                                    Executor executor)

Registers the specified listener to be notified whenever the collection is updated.

Parameters:

listener - listener to notify about collection update events

executor - executor on which to call event listener

Returns:

CompletableFuture that is completed when the operation completes

removeListener

CompletableFuture<Void> removeListener(CollectionEventListener<E> listener)

Unregisters the specified listener.

Parameters:

listener - listener to unregister.

Returns:

CompletableFuture that is completed when the operation completes

sync

default DistributedCollection<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

DistributedCollection<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