org.neo4j.kernel.api.index
Enum InternalIndexState

java.lang.Object
  java.lang.Enum<InternalIndexState>
      org.neo4j.kernel.api.index.InternalIndexState

All Implemented Interfaces:

Serializable, Comparable<InternalIndexState>

public enum InternalIndexState
extends Enum<InternalIndexState>

Defines the state of a given index.

Enum Constant Summary

FAILED
Denotes that the index, for one reason or another, is broken.

ONLINE
Given after the database has populated the index, and notified the index provider that the index is in fact populated.

POPULATING
Denotes that an index is in the process of being created.

Method Summary

static InternalIndexState	valueOf(String name) Returns the enum constant of this type with the specified name.
static InternalIndexState[]	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

POPULATING

public static final InternalIndexState POPULATING

Denotes that an index is in the process of being created.

ONLINE

public static final InternalIndexState ONLINE

Given after the database has populated the index, and notified the index provider that the index is in fact populated.

FAILED

public static final InternalIndexState FAILED

Denotes that the index, for one reason or another, is broken. Information about the failure is expected to have been logged. Dropping a failed index should be possible, as long as the failure is not caused by eg. out of memory.

Method Detail

values

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

Returns:

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

valueOf

public static InternalIndexState 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