net.kuujo.copycat.collections

Interface AsyncList<T>

Type Parameters:

T - The list data type.

All Superinterfaces:

AsyncCollection<AsyncList<T>,T>, AsyncCollectionProxy<T>, AsyncListProxy<T>, Managed<AsyncList<T>>, Resource<AsyncList<T>>

All Known Implementing Classes:

DefaultAsyncList

public interface AsyncList<T>
extends AsyncCollection<AsyncList<T>,T>, AsyncListProxy<T>

Asynchronous list.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
static <T> AsyncList<T>	create(String name) Creates a new asynchronous list with the default cluster configuration.
static <T> AsyncList<T>	create(String name, ClusterConfig cluster) Creates a new asynchronous list with the default list configuration.
static <T> AsyncList<T>	create(String name, ClusterConfig cluster, AsyncListConfig config) Creates a new asynchronous list.

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

addShutdownTask, addStartupTask, cluster, name

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

close, isClosed, isOpen, open

Methods inherited from interface net.kuujo.copycat.collections.AsyncListProxy

add, addAll, get, remove, set

Methods inherited from interface net.kuujo.copycat.collections.AsyncCollectionProxy

add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, size

Method Detail

create

static <T> AsyncList<T> create(String name)

Creates a new asynchronous list with the default cluster configuration.

The list will be constructed with the default cluster configuration. The default cluster configuration searches for two resources on the classpath - cluster and {cluster-defaults} - in that order. Configuration options specified in cluster.conf will override those in {cluster-defaults.conf}.

Additionally, the list will be constructed with an list configuration that searches the classpath for three configuration files - {name}, list, list-defaults, resource, and resource-defaults - in that order. The first resource is a configuration resource with the same name as the list resource. If the resource is namespaced - e.g. `lists.my-list.conf` - then resource configurations will be loaded according to namespaces as well; for example, `lists.conf`.

Type Parameters:

T - The list data type.

Parameters:

name - The asynchronous list name.

Returns:

The asynchronous list.

create

static <T> AsyncList<T> create(String name,
                               ClusterConfig cluster)

Creates a new asynchronous list with the default list configuration.

The list will be constructed with an list configuration that searches the classpath for three configuration files - {name}, list, list-defaults, resource, and resource-defaults - in that order. The first resource is a configuration resource with the same name as the list resource. If the resource is namespaced - e.g. `lists.my-list.conf` - then resource configurations will be loaded according to namespaces as well; for example, `lists.conf`.

Type Parameters:

T - The list data type.

Parameters:

name - The asynchronous list name.

cluster - The cluster configuration.

Returns:

The asynchronous list.

create

static <T> AsyncList<T> create(String name,
                               ClusterConfig cluster,
                               AsyncListConfig config)

Creates a new asynchronous list.

Type Parameters:

T - The list data type.

Parameters:

name - The asynchronous list name.

cluster - The cluster configuration.

config - The list configuration.

Returns:

The asynchronous list.