net.kuujo.copycat.collections.internal.collection

Class AbstractAsyncCollection<S extends AsyncCollection<S,V>,T extends CollectionState<T,V>,U extends AsyncCollectionProxy<V>,V>

java.lang.Object

net.kuujo.copycat.resource.internal.AbstractResource<S>

net.kuujo.copycat.collections.internal.collection.AbstractAsyncCollection<S,T,U,V>

All Implemented Interfaces:

AsyncCollection<S,V>, AsyncCollectionProxy<V>, Resource<S>, Managed<S>

Direct Known Subclasses:

DefaultAsyncList, DefaultAsyncSet

public abstract class AbstractAsyncCollection<S extends AsyncCollection<S,V>,T extends CollectionState<T,V>,U extends AsyncCollectionProxy<V>,V>
extends AbstractResource<S>
implements AsyncCollection<S,V>

Abstract asynchronous collection implementation.

Author:

Jordan Halterman

Field Summary

Fields

Modifier and Type	Field and Description
protected U	proxy

Fields inherited from class net.kuujo.copycat.resource.internal.AbstractResource

context, executor, serializer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAsyncCollection(ResourceContext context, StateMachine<T> stateMachine, Class proxyClass)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	add(V value) Adds a entry to the collection.
CompletableFuture<Boolean>	addAll(Collection<? extends V> values) Adds a collection of entries to the collection.
protected <R> CompletableFuture<R>	checkOpen(java.util.function.Supplier<CompletableFuture<R>> supplier) If the collection is closed, returning a failed CompletableFuture.
CompletableFuture<Void>	clear() Clears all values from the collection.
CompletableFuture<Void>	close()
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<S>	open()
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.

Methods inherited from class net.kuujo.copycat.resource.internal.AbstractResource

addShutdownTask, addStartupTask, cluster, isClosed, isOpen, name, runShutdownTasks, runStartupTasks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.kuujo.copycat.resource.Resource

addShutdownTask, addStartupTask, cluster, name

Methods inherited from interface net.kuujo.copycat.util.Managed

isClosed, isOpen

Field Detail

proxy

protected U extends AsyncCollectionProxy<V> proxy

Constructor Detail

AbstractAsyncCollection

protected AbstractAsyncCollection(ResourceContext context,
                                  StateMachine<T> stateMachine,
                                  Class proxyClass)

Method Detail

checkOpen

protected <R> CompletableFuture<R> checkOpen(java.util.function.Supplier<CompletableFuture<R>> supplier)

If the collection is closed, returning a failed CompletableFuture. Otherwise, calls the given supplier to return the completed future result.

Type Parameters:

R - The future result type.

Parameters:

supplier - The supplier to call if the collection is open.

Returns:

A completable future that if this collection is closed is immediately failed.

add

public CompletableFuture<Boolean> add(V value)

Description copied from interface: AsyncCollectionProxy

Adds a entry to the collection.

Specified by:

add in interface AsyncCollectionProxy<V>

Parameters:

value - The entry to add.

Returns:

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

addAll

public CompletableFuture<Boolean> addAll(Collection<? extends V> values)

Description copied from interface: AsyncCollectionProxy

Adds a collection of entries to the collection.

Specified by:

addAll in interface AsyncCollectionProxy<V>

Parameters:

values - The values to add.

Returns:

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

retainAll

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

Description copied from interface: AsyncCollectionProxy

Retains a collection of values in the collection.

Specified by:

retainAll in interface AsyncCollectionProxy<V>

Parameters:

values - The values to retain.

Returns:

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

remove

public CompletableFuture<Boolean> remove(Object value)

Description copied from interface: AsyncCollectionProxy

Removes a entry from the collection.

Specified by:

remove in interface AsyncCollectionProxy<V>

Parameters:

value - The entry to remove.

Returns:

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

removeAll

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

Description copied from interface: AsyncCollectionProxy

Removes a collection of values from the collection.

Specified by:

removeAll in interface AsyncCollectionProxy<V>

Parameters:

values - The collection of values to remove.

Returns:

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

contains

public CompletableFuture<Boolean> contains(Object value)

Description copied from interface: AsyncCollectionProxy

Checks whether the collection contains a entry.

Specified by:

contains in interface AsyncCollectionProxy<V>

Parameters:

value - The entry to check.

Returns:

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

containsAll

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

Description copied from interface: AsyncCollectionProxy

Checks whether the collection contains a collection of entries.

Specified by:

containsAll in interface AsyncCollectionProxy<V>

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

public CompletableFuture<Integer> size()

Description copied from interface: AsyncCollectionProxy

Gets the current collection size.

Specified by:

size in interface AsyncCollectionProxy<V>

Returns:

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

isEmpty

public CompletableFuture<Boolean> isEmpty()

Description copied from interface: AsyncCollectionProxy

Checks whether the collection is empty.

Specified by:

isEmpty in interface AsyncCollectionProxy<V>

Returns:

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

clear

public CompletableFuture<Void> clear()

Description copied from interface: AsyncCollectionProxy

Clears all values from the collection.

Specified by:

clear in interface AsyncCollectionProxy<V>

Returns:

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

open

public CompletableFuture<S> open()

Specified by:

open in interface Managed<S extends AsyncCollection<S,V>>

close

public CompletableFuture<Void> close()

Specified by:

close in interface Managed<S extends AsyncCollection<S,V>>