net.kuujo.copycat.collections

Interface AsyncMap<K,V>

Type Parameters:

K - The map key type.

V - The map entry type.

All Superinterfaces:

AsyncMapProxy<K,V>, net.kuujo.copycat.util.Managed<AsyncMap<K,V>>, net.kuujo.copycat.resource.Resource<AsyncMap<K,V>>

All Known Implementing Classes:

DefaultAsyncMap

public interface AsyncMap<K,V>
extends AsyncMapProxy<K,V>, net.kuujo.copycat.resource.Resource<AsyncMap<K,V>>

Asynchronous map.

Author:

Jordan Halterman

Method Summary

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

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

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, 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> AsyncMap<K,V> create(String name)

Creates a new asynchronous map with the default cluster configuration.

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

Type Parameters:

K - The map key type.

V - The map value type.

Parameters:

name - The asynchronous map name.

Returns:

The asynchronous map.

create

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

Creates a new asynchronous map.

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

Type Parameters:

K - The map key type.

V - The map value type.

Parameters:

name - The asynchronous map name.

cluster - The cluster configuration.

Returns:

The asynchronous map.

create

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

Creates a new asynchronous map.

Type Parameters:

K - The map key type.

V - The map value type.

Parameters:

name - The asynchronous map name.

cluster - The cluster configuration.

config - The map configuration.

Returns:

The asynchronous map.