Package org.elasticsearch.cluster.metadata

Enum Class IndexMetadata.State

java.lang.Object

java.lang.Enum<IndexMetadata.State>

org.elasticsearch.cluster.metadata.IndexMetadata.State

All Implemented Interfaces:

Serializable, Comparable<IndexMetadata.State>, Constable, Writeable

Enclosing class:

IndexMetadata

public static enum IndexMetadata.State
extends Enum<IndexMetadata.State>
implements Writeable

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSE
OPEN

Method Summary

Modifier and Type	Method	Description
static IndexMetadata.State	fromId(byte id)
static IndexMetadata.State	fromString(String state)
byte	id()
static IndexMetadata.State	readFrom(StreamInput in)
static IndexMetadata.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IndexMetadata.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

OPEN

public static final IndexMetadata.State OPEN

CLOSE

public static final IndexMetadata.State CLOSE

Method Details

values

public static IndexMetadata.State[] 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 IndexMetadata.State 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

id

public byte id()

fromId

public static IndexMetadata.State fromId(byte id)

readFrom

public static IndexMetadata.State readFrom(StreamInput in)
                                    throws IOException

Throws:

IOException

fromString

public static IndexMetadata.State fromString(String state)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException