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> array
(String name, Iterator<? extends ChunkedToXContentObject> contents, ToXContent.Params params) Creates an Iterator to serialize a named field where the value is represented by an iterator ofChunkedToXContentObject
.static Iterator
<ToXContent> array
(String name, Iterator<? extends ToXContent> contents) static <T> Iterator
<ToXContent> array
(String name, Iterator<T> items, Function<T, ToXContent> toXContent) static Iterator
<ToXContent> array
(Iterator<? extends ToXContent> contents) static <T> Iterator
<ToXContent> array
(Iterator<T> items, Function<T, ToXContent> toXContent) static Iterator
<ToXContent> chunk
(ToXContent item) Creates an Iterator of a single ToXContent object that serializes the given object as a single chunk.static Iterator
<ToXContent> endArray()
static Iterator
<ToXContent> static Iterator
<ToXContent> field
(String name, ChunkedToXContentObject value, ToXContent.Params params) Creates an Iterator to serialize a named field where the value is represented by aChunkedToXContentObject
.static Iterator
<ToXContent> object
(String name, Iterator<? extends ToXContent> iterator) Defines an object namedname
, with the contents set byiterator
static Iterator
<ToXContent> Defines an object namedname
, with the contents of each field set bymap
static <T> Iterator
<ToXContent> Defines an object namedname
, with the contents set by callingtoXContent
on each entry inmap
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.static Iterator
<ToXContent> xContentObjectFieldObjects
(String name, Map<String, ? extends ToXContent> map) Defines an object namedname
, with the contents of each field each another object created from each entry inmap
static Iterator
<ToXContent> xContentObjectFields
(String name, Map<String, ? extends ToXContent> map) Defines an object namedname
, with the contents of each field created from each entry inmap
-
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
-
object
Defines an object namedname
, with the contents of each field set bymap
-
object
public static <T> Iterator<ToXContent> object(String name, Map<String, T> map, Function<Map.Entry<String, T>, ToXContent> toXContent) Defines an object namedname
, with the contents set by callingtoXContent
on each entry inmap
-
xContentObjectFields
public static Iterator<ToXContent> xContentObjectFields(String name, Map<String, ? extends ToXContent> map) Defines an object namedname
, with the contents of each field created from each entry inmap
-
xContentObjectFieldObjects
public static Iterator<ToXContent> xContentObjectFieldObjects(String name, Map<String, ? extends ToXContent> map) Defines an object namedname
, with the contents of each field each another object created from each entry inmap
-
field
public static Iterator<ToXContent> field(String name, ChunkedToXContentObject value, ToXContent.Params params) Creates an Iterator to serialize a named field where the value is represented by aChunkedToXContentObject
. Chunked equivalent forXContentBuilder field(String name, ToXContent value)
- Parameters:
name
- name of the fieldvalue
- value for this fieldparams
- params to propagate for XContent serialization- Returns:
- Iterator composing field name and value serialization
-
array
-
array
-
array
-
array
public static <T> Iterator<ToXContent> array(String name, Iterator<T> items, Function<T, ToXContent> toXContent) -
array
public static Iterator<ToXContent> array(String name, Iterator<? extends ChunkedToXContentObject> contents, ToXContent.Params params) Creates an Iterator to serialize a named field where the value is represented by an iterator ofChunkedToXContentObject
. Chunked equivalent forXContentBuilder array(String name, ToXContent value)
- Parameters:
name
- name of the fieldcontents
- values for this fieldparams
- params to propagate for XContent serialization- Returns:
- Iterator composing field name and value serialization
-
object
Defines an object namedname
, with the contents set byiterator
-
chunk
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.
-
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.
-