net.kuujo.copycat.atomic

Interface AsyncBoolean

All Superinterfaces:

AsyncBooleanProxy, net.kuujo.copycat.util.Managed<AsyncBoolean>, net.kuujo.copycat.resource.Resource<AsyncBoolean>

All Known Implementing Classes:

DefaultAsyncBoolean

public interface AsyncBoolean
extends AsyncBooleanProxy, net.kuujo.copycat.resource.Resource<AsyncBoolean>

Asynchronous atomic boolean.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
static AsyncBoolean	create(String name) Creates a new asynchronous atomic boolean with the default cluster configuration.
static AsyncBoolean	create(String name, net.kuujo.copycat.cluster.ClusterConfig cluster) Creates a new asynchronous atomic boolean with the default atomic boolean configuration.
static AsyncBoolean	create(String name, net.kuujo.copycat.cluster.ClusterConfig cluster, AsyncBooleanConfig config) Creates a new asynchronous atomic boolean.

Methods inherited from interface net.kuujo.copycat.atomic.AsyncBooleanProxy

compareAndSet, get, getAndSet, set

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 AsyncBoolean create(String name)

Creates a new asynchronous atomic boolean with the default cluster configuration.

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

Parameters:

name - The asynchronous atomic boolean name.

Returns:

The asynchronous atomic boolean.

create

static AsyncBoolean create(String name,
                           net.kuujo.copycat.cluster.ClusterConfig cluster)

Creates a new asynchronous atomic boolean with the default atomic boolean configuration.

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

Parameters:

name - The asynchronous atomic boolean name.

cluster - The cluster configuration.

Returns:

The asynchronous atomic boolean.

create

static AsyncBoolean create(String name,
                           net.kuujo.copycat.cluster.ClusterConfig cluster,
                           AsyncBooleanConfig config)

Creates a new asynchronous atomic boolean.

Parameters:

name - The asynchronous atomic boolean name.

cluster - The cluster configuration.

config - The atomic boolean configuration.

Returns:

The asynchronous atomic boolean.