Module org.elasticsearch.server

Package org.elasticsearch.common.xcontent

Enum Class ChunkedToXContentHelper

java.lang.Object

java.lang.Enum<ChunkedToXContentHelper>

org.elasticsearch.common.xcontent.ChunkedToXContentHelper

All Implemented Interfaces:

Serializable, Comparable<ChunkedToXContentHelper>, Constable

public enum ChunkedToXContentHelper
extends Enum<ChunkedToXContentHelper>

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Method Summary

Modifier and Type	Method	Description
static Iterator<ToXContent>	endArray()
static Iterator<ToXContent>	endObject()
static Iterator<ToXContent>	field(String name, boolean value)
static Iterator<ToXContent>	field(String name, long value)
static Iterator<ToXContent>	field(String name, String value)
static Iterator<ToXContent>	singleChunk(ToXContent item)	Creates an Iterator of a single ToXContent object that serializes the given object as a single chunk.
static Iterator<ToXContent>	startArray()
static Iterator<ToXContent>	startArray(String name)
static Iterator<ToXContent>	startObject()
static Iterator<ToXContent>	startObject(String name)
static ChunkedToXContentHelper	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChunkedToXContentHelper[]	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

Method Details

values

public static ChunkedToXContentHelper[] 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 ChunkedToXContentHelper 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

startObject

public static Iterator<ToXContent> startObject()

startObject

public static Iterator<ToXContent> startObject(String name)

endObject

public static Iterator<ToXContent> endObject()

startArray

public static Iterator<ToXContent> startArray()

startArray

public static Iterator<ToXContent> startArray(String name)

endArray

public static Iterator<ToXContent> endArray()

field

public static Iterator<ToXContent> field(String name,
 boolean value)

field

public static Iterator<ToXContent> field(String name,
 long value)

field

public static Iterator<ToXContent> field(String name,
 String value)

singleChunk

public static Iterator<ToXContent> singleChunk(ToXContent item)

Creates an Iterator of a single ToXContent object that serializes the given object as a single chunk. Just wraps Iterators.single(T), but still useful because it avoids any type ambiguity.

Parameters:

item - Item to wrap

Returns:

Singleton iterator for the given item.