Module org.elasticsearch.server
Enum Class ChunkedToXContentHelper
- All Implemented Interfaces:
Serializable
,Comparable<ChunkedToXContentHelper>
,Constable
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Method Summary
Modifier and TypeMethodDescriptionstatic Iterator
<ToXContent> endArray()
static Iterator
<ToXContent> static Iterator
<ToXContent> static Iterator
<ToXContent> static Iterator
<ToXContent> static Iterator
<ToXContent> optionalField
(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> static Iterator
<ToXContent> startArray
(String name) static Iterator
<ToXContent> static Iterator
<ToXContent> startObject
(String name) static ChunkedToXContentHelper
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.
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
startObject
-
startObject
-
endObject
-
startArray
-
startArray
-
endArray
-
field
-
field
-
field
-
optionalField
-
singleChunk
Creates an Iterator of a single ToXContent object that serializes the given object as a single chunk. Just wrapsIterators.single(T)
, but still useful because it avoids any type ambiguity.- Parameters:
item
- Item to wrap- Returns:
- Singleton iterator for the given item.
-