org.modeshape.jcr.api.index

Enum IndexManager.IndexStatus

java.lang.Object

java.lang.Enum<IndexManager.IndexStatus>

org.modeshape.jcr.api.index.IndexManager.IndexStatus

All Implemented Interfaces:

Serializable, Comparable<IndexManager.IndexStatus>

Enclosing interface:

IndexManager

public static enum IndexManager.IndexStatus
extends Enum<IndexManager.IndexStatus>

Enum with a list of possible statuses for managed indexes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Inactive index which has been disabled or shut down.
ENABLED Active index being considered/used by the query engine when executing queries
NON_EXISTENT Index which does not exist
REINDEXING Active index which is re-indexing its data but is not being used by the query engine

Method Summary

Modifier and Type	Method and Description
static IndexManager.IndexStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexManager.IndexStatus[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ENABLED

public static final IndexManager.IndexStatus ENABLED

Active index being considered/used by the query engine when executing queries

REINDEXING

public static final IndexManager.IndexStatus REINDEXING

Active index which is re-indexing its data but is not being used by the query engine

DISABLED

public static final IndexManager.IndexStatus DISABLED

Inactive index which has been disabled or shut down.

NON_EXISTENT

public static final IndexManager.IndexStatus NON_EXISTENT

Index which does not exist

Method Detail

values

public static IndexManager.IndexStatus[] 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 (IndexManager.IndexStatus c : IndexManager.IndexStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static IndexManager.IndexStatus 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