net.kuujo.copycat.collections

Interface AsyncMultiMap<K,V>

Type Parameters:

K - The multimap key type.

V - The multimap entry type.

All Superinterfaces:

AsyncMultiMapProxy<K,V>, net.kuujo.copycat.util.Managed<AsyncMultiMap<K,V>>, net.kuujo.copycat.resource.Resource<AsyncMultiMap<K,V>>

All Known Implementing Classes:

DefaultAsyncMultiMap

public interface AsyncMultiMap<K,V>
extends AsyncMultiMapProxy<K,V>, net.kuujo.copycat.resource.Resource<AsyncMultiMap<K,V>>

Asynchronous multi-map.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
static <K,V> AsyncMultiMap<K,V>	create(String name) Creates a new asynchronous multimap with the default cluster configuration.
static <K,V> AsyncMultiMap<K,V>	create(String name, net.kuujo.copycat.cluster.ClusterConfig cluster) Creates a new asynchronous multimap.
static <K,V> AsyncMultiMap<K,V>	create(String name, net.kuujo.copycat.cluster.ClusterConfig cluster, AsyncMultiMapConfig config) Creates a new asynchronous multimap.

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

clear, containsEntry, containsKey, containsValue, entrySet, get, getOrDefault, isEmpty, keySet, put, putAll, remove, remove, replace, replace, replaceAll, size, values

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

addShutdownTask, addStartupTask, cluster, name, state

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

close, isClosed, isOpen, open

Method Detail

create

static <K,V> AsyncMultiMap<K,V> create(String name)

Creates a new asynchronous multimap with the default cluster configuration.

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

Type Parameters:

K - The multimap key type.

V - The multimap value type.

Parameters:

name - The asynchronous multimap name.

Returns:

The asynchronous multimap.

create

static <K,V> AsyncMultiMap<K,V> create(String name,
                                       net.kuujo.copycat.cluster.ClusterConfig cluster)

Creates a new asynchronous multimap.

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

Type Parameters:

K - The multimap key type.

V - The multimap value type.

Parameters:

name - The asynchronous multimap name.

cluster - The cluster configuration.

Returns:

The asynchronous multimap.

create

static <K,V> AsyncMultiMap<K,V> create(String name,
                                       net.kuujo.copycat.cluster.ClusterConfig cluster,
                                       AsyncMultiMapConfig config)

Creates a new asynchronous multimap.

Type Parameters:

K - The multimap key type.

V - The multimap value type.

Parameters:

name - The asynchronous multimap name.

cluster - The cluster configuration.

config - The multimap configuration.

Returns:

The asynchronous multimap.