org.apache.jackrabbit.mongomk

Enum DocumentStore.Collection

java.lang.Object

java.lang.Enum<DocumentStore.Collection>

org.apache.jackrabbit.mongomk.DocumentStore.Collection

All Implemented Interfaces:

Serializable, Comparable<DocumentStore.Collection>

Enclosing interface:

DocumentStore

public static enum DocumentStore.Collection
extends Enum<DocumentStore.Collection>

The list of collections.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLUSTER_NODES The 'clusterNodes' collection contains the list of currently running cluster nodes.
NODES The 'nodes' collection.

Method Summary

Methods

Modifier and Type	Method and Description
String	toString()
static DocumentStore.Collection	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentStore.Collection[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NODES

public static final DocumentStore.Collection NODES

The 'nodes' collection. It contains all the node data, with one document per node, and the path as the primary key. Each document possibly contains multiple revisions.

Key: the path, value: the node data (possibly multiple revisions)

Old revisions are removed after some time, either by the process that removed or updated the node, lazily when reading, or in a background process.

CLUSTER_NODES

public static final DocumentStore.Collection CLUSTER_NODES

The 'clusterNodes' collection contains the list of currently running cluster nodes. The key is the clusterNodeId (0, 1, 2,...).

Method Detail

values

public static DocumentStore.Collection[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DocumentStore.Collection c : DocumentStore.Collection.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DocumentStore.Collection valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<DocumentStore.Collection>