net.kuujo.copycat.collections

Interface AsyncCollectionProxy<T>

All Known Subinterfaces:

AsyncCollection<T,U>, AsyncList<T>, AsyncListProxy<T>, AsyncSet<T>, AsyncSetProxy<T>

All Known Implementing Classes:

AbstractAsyncCollection, DefaultAsyncList, DefaultAsyncSet

public interface AsyncCollectionProxy<T>

Asynchronous collection proxy.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	add(T value) Adds a entry to the collection.
CompletableFuture<Boolean>	addAll(Collection<? extends T> values) Adds a collection of entries to the collection.
CompletableFuture<Void>	clear() Clears all values from the collection.
CompletableFuture<Boolean>	contains(Object value) Checks whether the collection contains a entry.
CompletableFuture<Boolean>	containsAll(Collection<?> values) Checks whether the collection contains a collection of entries.
CompletableFuture<Boolean>	isEmpty() Checks whether the collection is empty.
CompletableFuture<Boolean>	remove(Object value) Removes a entry from the collection.
CompletableFuture<Boolean>	removeAll(Collection<?> values) Removes a collection of values from the collection.
CompletableFuture<Boolean>	retainAll(Collection<?> values) Retains a collection of values in the collection.
CompletableFuture<Integer>	size() Gets the current collection size.

Method Detail

add

CompletableFuture<Boolean> add(T value)

Adds a entry to the collection.

Parameters:

value - The entry to add.

Returns:

A completable future to be completed with the result once complete.

addAll

CompletableFuture<Boolean> addAll(Collection<? extends T> values)

Adds a collection of entries to the collection.

Parameters:

values - The values to add.

Returns:

A completable future to be completed with the result once complete.

retainAll

CompletableFuture<Boolean> retainAll(Collection<?> values)

Retains a collection of values in the collection.

Parameters:

values - The values to retain.

Returns:

A completable future to be completed with the result once complete.

remove

CompletableFuture<Boolean> remove(Object value)

Removes a entry from the collection.

Parameters:

value - The entry to remove.

Returns:

A completable future to be completed with the result once complete.

removeAll

CompletableFuture<Boolean> removeAll(Collection<?> values)

Removes a collection of values from the collection.

Parameters:

values - The collection of values to remove.

Returns:

A completable future to be completed with the result once complete.

contains

CompletableFuture<Boolean> contains(Object value)

Checks whether the collection contains a entry.

Parameters:

value - The entry to check.

Returns:

A completable future to be completed with the result once complete.

containsAll

CompletableFuture<Boolean> containsAll(Collection<?> values)

Checks whether the collection contains a collection of entries.

Parameters:

values - The collection of values to check.

Returns:

A completable future to be completed with a boolean value indicating whether the collection contains the given set of values.

size

CompletableFuture<Integer> size()

Gets the current collection size.

Returns:

A completable future to be completed with the result once complete.

isEmpty

CompletableFuture<Boolean> isEmpty()

Checks whether the collection is empty.

Returns:

A completable future to be completed with the result once complete.

clear

CompletableFuture<Void> clear()

Clears all values from the collection.

Returns:

A completable future to be completed with the result once complete.