Package org.springframework.data.mongodb.core.index

Enum Class SearchIndexStatus

java.lang.Object

java.lang.Enum<SearchIndexStatus>

org.springframework.data.mongodb.core.index.SearchIndexStatus

All Implemented Interfaces:

Serializable, Comparable<SearchIndexStatus>, Constable

public enum SearchIndexStatus
extends Enum<SearchIndexStatus>

Representation of different conditions a search index can be in.

Since:

4.5

Author:

Christoph Strobl

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUILDING	building or re-building the index - might be queryable
DELETING	will cease to exist - no longer queryable
DOES_NOT_EXIST	nothing to be seen here - not queryable
FAILED	well, this one is broken - not queryable
PENDING	busy with other things, check back later - not queryable
READY	ask me anything - queryable
STALE	ask me anything about outdated data - still queryable

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BUILDING

public static final SearchIndexStatus BUILDING

building or re-building the index - might be queryable

DOES_NOT_EXIST

public static final SearchIndexStatus DOES_NOT_EXIST

nothing to be seen here - not queryable

DELETING

public static final SearchIndexStatus DELETING

will cease to exist - no longer queryable

FAILED

public static final SearchIndexStatus FAILED

well, this one is broken - not queryable

PENDING

public static final SearchIndexStatus PENDING

busy with other things, check back later - not queryable

READY

public static final SearchIndexStatus READY

ask me anything - queryable

STALE

public static final SearchIndexStatus STALE

ask me anything about outdated data - still queryable

Method Details

values

public static SearchIndexStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SearchIndexStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null