XContentBuilder (Elasticsearch: Core 2.3.3 API)

java.lang.Object
- org.elasticsearch.common.xcontent.XContentBuilder

All Implemented Interfaces:: AutoCloseable, BytesStream, Releasable

public final class XContentBuilder
extends Object
implements BytesStream, Releasable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XContentBuilder.FieldCaseConversion

Nested Classes
Modifier and Type	Class and Description
`static class`	`XContentBuilder.FieldCaseConversion`

Field Summary

Fields
Modifier and Type	Field and Description
`static org.joda.time.format.DateTimeFormatter`	`defaultDatePrinter`
`protected static XContentBuilder.FieldCaseConversion`	`globalFieldCaseConversion`

Constructor Summary

Constructors
Constructor and Description
`XContentBuilder(XContent xContent, OutputStream bos)` Constructs a new builder using the provided xcontent and an OutputStream.
`XContentBuilder(XContent xContent, OutputStream bos, String[] filters)` Constructs a new builder using the provided xcontent, an OutputStream and some filters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XContentBuilder`	`array(String name, Object... values)`
`XContentBuilder`	`array(String name, String... values)`
`XContentBuilder`	`array(XContentBuilderString name, Object... values)`
`XContentBuilder`	`array(XContentBuilderString name, String... values)`
`static XContentBuilder`	`builder(XContent xContent)`
`static XContentBuilder`	`builder(XContent xContent, String[] filters)`
`BytesReference`	`bytes()`
`XContentBuilder`	`byteSizeField(XContentBuilderString rawFieldName, XContentBuilderString readableFieldName, ByteSizeValue byteSizeValue)`
`XContentBuilder`	`byteSizeField(XContentBuilderString rawFieldName, XContentBuilderString readableFieldName, long rawSize)`
`void`	`close()`
`XContentType`	`contentType()`
`XContentBuilder`	`copyCurrentStructure(XContentParser parser)`
`XContentBuilder`	`dateValueField(String rawFieldName, String readableFieldName, long rawTimestamp)`
`XContentBuilder`	`dateValueField(XContentBuilderString rawFieldName, XContentBuilderString readableFieldName, long rawTimestamp)`
`XContentBuilder`	`endArray()`
`XContentBuilder`	`endObject()`
`XContentBuilder`	`field(String name)`
`XContentBuilder`	`field(String name, BigDecimal value)`
`XContentBuilder`	`field(String name, BigDecimal value, int scale, RoundingMode rounding, boolean toDouble)`
`XContentBuilder`	`field(String name, boolean... value)`
`XContentBuilder`	`field(String name, boolean value)`
`XContentBuilder`	`field(String name, byte[] value)`
`XContentBuilder`	`field(String name, byte[] value, int offset, int length)`
`XContentBuilder`	`field(String name, org.apache.lucene.util.BytesRef value)` Writes the binary content of the given BytesRef Use `XContentParser.binaryValue()` to read the value back
`XContentBuilder`	`field(String name, BytesReference value)` Writes the binary content of the given BytesReference Use `XContentParser.binaryValue()` to read the value back
`XContentBuilder`	`field(String name, char[] value, int offset, int length)`
`XContentBuilder`	`field(String name, Date date)`
`XContentBuilder`	`field(String name, Date date, org.joda.time.format.DateTimeFormatter formatter)`
`XContentBuilder`	`field(String name, double... value)`
`XContentBuilder`	`field(String name, double value)`
`XContentBuilder`	`field(String name, Double value)`
`XContentBuilder`	`field(String name, float... value)`
`XContentBuilder`	`field(String name, float value)`
`XContentBuilder`	`field(String name, Float value)`
`XContentBuilder`	`field(String name, int... value)`
`XContentBuilder`	`field(String name, int value)`
`XContentBuilder`	`field(String name, Integer value)`
`XContentBuilder`	`field(String name, Iterable<?> value)`
`XContentBuilder`	`field(String name, long... value)`
`XContentBuilder`	`field(String name, long value)`
`XContentBuilder`	`field(String name, Long value)`
`XContentBuilder`	`field(String name, Map<String,Object> value)`
`XContentBuilder`	`field(String name, Object... value)`
`XContentBuilder`	`field(String name, Object value)`
`XContentBuilder`	`field(String name, org.joda.time.ReadableInstant date)`
`XContentBuilder`	`field(String name, org.joda.time.ReadableInstant date, org.joda.time.format.DateTimeFormatter formatter)`
`XContentBuilder`	`field(String name, String... value)`
`XContentBuilder`	`field(String name, String value)`
`XContentBuilder`	`field(String name, String value, XContentBuilder.FieldCaseConversion conversion)`
`XContentBuilder`	`field(String name, Text value)`
`XContentBuilder`	`field(String name, ToXContent xContent)`
`XContentBuilder`	`field(String name, ToXContent xContent, ToXContent.Params params)`
`XContentBuilder`	`field(String name, XContentBuilder.FieldCaseConversion conversion)`
`XContentBuilder`	`field(XContentBuilderString name)`
`XContentBuilder`	`field(XContentBuilderString name, BigDecimal value)`
`XContentBuilder`	`field(XContentBuilderString name, BigDecimal value, int scale, RoundingMode rounding, boolean toDouble)`
`XContentBuilder`	`field(XContentBuilderString name, boolean... value)`
`XContentBuilder`	`field(XContentBuilderString name, boolean value)`
`XContentBuilder`	`field(XContentBuilderString name, byte[] value)`
`XContentBuilder`	`field(XContentBuilderString name, org.apache.lucene.util.BytesRef value)` Writes the binary content of the given BytesRef Use `XContentParser.binaryValue()` to read the value back
`XContentBuilder`	`field(XContentBuilderString name, BytesReference value)` Writes the binary content of the given BytesReference Use `XContentParser.binaryValue()` to read the value back
`XContentBuilder`	`field(XContentBuilderString name, char[] value, int offset, int length)`
`XContentBuilder`	`field(XContentBuilderString name, Date date)`
`XContentBuilder`	`field(XContentBuilderString name, Date date, org.joda.time.format.DateTimeFormatter formatter)`
`XContentBuilder`	`field(XContentBuilderString name, double... value)`
`XContentBuilder`	`field(XContentBuilderString name, double value)`
`XContentBuilder`	`field(XContentBuilderString name, Double value)`
`XContentBuilder`	`field(XContentBuilderString name, float... value)`
`XContentBuilder`	`field(XContentBuilderString name, float value)`
`XContentBuilder`	`field(XContentBuilderString name, Float value)`
`XContentBuilder`	`field(XContentBuilderString name, int... value)`
`XContentBuilder`	`field(XContentBuilderString name, int value)`
`XContentBuilder`	`field(XContentBuilderString name, Integer value)`
`XContentBuilder`	`field(XContentBuilderString name, int offset, int length, int... value)`
`XContentBuilder`	`field(XContentBuilderString name, Iterable<?> value)`
`XContentBuilder`	`field(XContentBuilderString name, long... value)`
`XContentBuilder`	`field(XContentBuilderString name, long value)`
`XContentBuilder`	`field(XContentBuilderString name, Long value)`
`XContentBuilder`	`field(XContentBuilderString name, Map<String,Object> value)`
`XContentBuilder`	`field(XContentBuilderString name, Object... value)`
`XContentBuilder`	`field(XContentBuilderString name, Object value)`
`XContentBuilder`	`field(XContentBuilderString name, org.joda.time.ReadableInstant date)`
`XContentBuilder`	`field(XContentBuilderString name, org.joda.time.ReadableInstant date, org.joda.time.format.DateTimeFormatter formatter)`
`XContentBuilder`	`field(XContentBuilderString name, String... value)`
`XContentBuilder`	`field(XContentBuilderString name, String value)`
`XContentBuilder`	`field(XContentBuilderString name, String value, XContentBuilder.FieldCaseConversion conversion)`
`XContentBuilder`	`field(XContentBuilderString name, Text value)`
`XContentBuilder`	`field(XContentBuilderString name, XContentBuilder.FieldCaseConversion conversion)`
`XContentBuilder`	`fieldCaseConversion(XContentBuilder.FieldCaseConversion fieldCaseConversion)`
`XContentBuilder`	`flush()`
`XContentGenerator`	`generator()`
`static void`	`globalFieldCaseConversion(XContentBuilder.FieldCaseConversion globalFieldCaseConversion)`
`boolean`	`humanReadable()`
`XContentBuilder`	`humanReadable(boolean humanReadable)`
`XContentBuilder`	`latlon(double lat, double lon)`
`XContentBuilder`	`latlon(String name, double lat, double lon)`
`XContentBuilder`	`lfAtEnd()`
`XContentBuilder`	`map(Map<String,?> map)`
`XContentBuilder`	`nullField(String name)`
`XContentBuilder`	`nullField(XContentBuilderString name)`
`XContentBuilder`	`nullValue()`
`XContentBuilder`	`percentageField(XContentBuilderString rawFieldName, XContentBuilderString readableFieldName, double percentage)`
`XContentBuilder`	`prettyPrint()`
`XContentBuilder`	`rawField(String fieldName, BytesReference content)`
`XContentBuilder`	`rawField(String fieldName, InputStream content)`
`XContentBuilder`	`rawValue(BytesReference content)`
`XContentBuilder`	`startArray()`
`XContentBuilder`	`startArray(String name)`
`XContentBuilder`	`startArray(String name, XContentBuilder.FieldCaseConversion conversion)`
`XContentBuilder`	`startArray(XContentBuilderString name)`
`XContentBuilder`	`startObject()`
`XContentBuilder`	`startObject(String name)`
`XContentBuilder`	`startObject(String name, XContentBuilder.FieldCaseConversion conversion)`
`XContentBuilder`	`startObject(XContentBuilderString name)`
`XContentBuilder`	`startObject(XContentBuilderString name, XContentBuilder.FieldCaseConversion conversion)`
`String`	`string()` Returns a string representation of the builder (only applicable for text based xcontent).
`XContentBuilder`	`timeValueField(String rawFieldName, String readableFieldName, long rawTime, TimeUnit timeUnit)`
`XContentBuilder`	`timeValueField(XContentBuilderString rawFieldName, XContentBuilderString readableFieldName, long rawTime)`
`XContentBuilder`	`timeValueField(XContentBuilderString rawFieldName, XContentBuilderString readableFieldName, TimeValue timeValue)`
`XContentBuilder`	`utf8Field(String name, org.apache.lucene.util.BytesRef value)` Writes the binary content of the given BytesRef as UTF-8 bytes Use `XContentParser.utf8Bytes()` to read the value back
`XContentBuilder`	`utf8Field(XContentBuilderString name, org.apache.lucene.util.BytesRef value)` Writes the binary content of the given BytesRef as UTF-8 bytes Use `XContentParser.utf8Bytes()` to read the value back
`XContentBuilder`	`value(boolean value)`
`XContentBuilder`	`value(Boolean value)`
`XContentBuilder`	`value(byte[] value)`
`XContentBuilder`	`value(byte[] value, int offset, int length)`
`XContentBuilder`	`value(org.apache.lucene.util.BytesRef value)` Writes the binary content of the given BytesRef Use `XContentParser.binaryValue()` to read the value back
`XContentBuilder`	`value(BytesReference value)` Writes the binary content of the given BytesReference Use `XContentParser.binaryValue()` to read the value back
`XContentBuilder`	`value(Date date)`
`XContentBuilder`	`value(Date date, org.joda.time.format.DateTimeFormatter dateTimeFormatter)`
`XContentBuilder`	`value(double value)`
`XContentBuilder`	`value(Double value)`
`XContentBuilder`	`value(float value)`
`XContentBuilder`	`value(Float value)`
`XContentBuilder`	`value(int value)`
`XContentBuilder`	`value(Integer value)`
`XContentBuilder`	`value(Iterable<?> value)`
`XContentBuilder`	`value(long value)`
`XContentBuilder`	`value(Long value)`
`XContentBuilder`	`value(Map<String,Object> map)`
`XContentBuilder`	`value(Object value)`
`XContentBuilder`	`value(org.joda.time.ReadableInstant date)`
`XContentBuilder`	`value(org.joda.time.ReadableInstant date, org.joda.time.format.DateTimeFormatter dateTimeFormatter)`
`XContentBuilder`	`value(String value)`
`XContentBuilder`	`value(Text value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultDatePrinter

public static final org.joda.time.format.DateTimeFormatter defaultDatePrinter

globalFieldCaseConversion

protected static XContentBuilder.FieldCaseConversion globalFieldCaseConversion

Constructor Detail
- XContentBuilder
```
public XContentBuilder(XContent xContent,
                       OutputStream bos)
                throws IOException
```
  Constructs a new builder using the provided xcontent and an OutputStream. Make sure to call close() when the builder is done with.
  
  Throws:
  
  IOException
- XContentBuilder
```
public XContentBuilder(XContent xContent,
                       OutputStream bos,
                       String[] filters)
                throws IOException
```
  Constructs a new builder using the provided xcontent, an OutputStream and some filters. The filters are used to filter fields that won't be written to the OutputStream. Make sure to call close() when the builder is done with.
  
  Throws:
  
  IOException

Method Detail

globalFieldCaseConversion

public static void globalFieldCaseConversion(XContentBuilder.FieldCaseConversion globalFieldCaseConversion)

builder

public static XContentBuilder builder(XContent xContent)
                               throws IOException

Throws:: IOException

builder

public static XContentBuilder builder(XContent xContent,
                                      String[] filters)
                               throws IOException

Throws:: IOException

fieldCaseConversion

public XContentBuilder fieldCaseConversion(XContentBuilder.FieldCaseConversion fieldCaseConversion)

contentType
```
public XContentType contentType()
```

prettyPrint
```
public XContentBuilder prettyPrint()
```

lfAtEnd
```
public XContentBuilder lfAtEnd()
```

humanReadable

public XContentBuilder humanReadable(boolean humanReadable)

humanReadable
```
public boolean humanReadable()
```

field

public XContentBuilder field(String name,
                             ToXContent xContent)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             ToXContent xContent,
                             ToXContent.Params params)
                      throws IOException

Throws:: IOException

startObject

public XContentBuilder startObject(String name)
                            throws IOException

Throws:: IOException

startObject

public XContentBuilder startObject(String name,
                                   XContentBuilder.FieldCaseConversion conversion)
                            throws IOException

Throws:: IOException

startObject

public XContentBuilder startObject(XContentBuilderString name)
                            throws IOException

Throws:: IOException

startObject

public XContentBuilder startObject(XContentBuilderString name,
                                   XContentBuilder.FieldCaseConversion conversion)
                            throws IOException

Throws:: IOException

startObject

public XContentBuilder startObject()
                            throws IOException

Throws:: IOException

endObject

public XContentBuilder endObject()
                          throws IOException

Throws:: IOException

array

public XContentBuilder array(String name,
                             String... values)
                      throws IOException

Throws:: IOException

array

public XContentBuilder array(XContentBuilderString name,
                             String... values)
                      throws IOException

Throws:: IOException

array

public XContentBuilder array(String name,
                             Object... values)
                      throws IOException

Throws:: IOException

array

public XContentBuilder array(XContentBuilderString name,
                             Object... values)
                      throws IOException

Throws:: IOException

startArray

public XContentBuilder startArray(String name,
                                  XContentBuilder.FieldCaseConversion conversion)
                           throws IOException

Throws:: IOException

startArray

public XContentBuilder startArray(String name)
                           throws IOException

Throws:: IOException

startArray

public XContentBuilder startArray(XContentBuilderString name)
                           throws IOException

Throws:: IOException

startArray

public XContentBuilder startArray()
                           throws IOException

Throws:: IOException

endArray

public XContentBuilder endArray()
                         throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             XContentBuilder.FieldCaseConversion conversion)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             XContentBuilder.FieldCaseConversion conversion)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             char[] value,
                             int offset,
                             int length)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             char[] value,
                             int offset,
                             int length)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             String value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             String value,
                             XContentBuilder.FieldCaseConversion conversion)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             String value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             String value,
                             XContentBuilder.FieldCaseConversion conversion)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Integer value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Integer value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             int value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             int value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Long value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Long value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             long value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             long value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Float value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Float value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             float value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             float value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Double value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Double value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             double value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             double value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             BigDecimal value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             BigDecimal value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             BigDecimal value,
                             int scale,
                             RoundingMode rounding,
                             boolean toDouble)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             BigDecimal value,
                             int scale,
                             RoundingMode rounding,
                             boolean toDouble)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             org.apache.lucene.util.BytesRef value)
                      throws IOException

Writes the binary content of the given BytesRef Use XContentParser.binaryValue() to read the value back

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             org.apache.lucene.util.BytesRef value)
                      throws IOException

Writes the binary content of the given BytesRef Use XContentParser.binaryValue() to read the value back

Throws:: IOException

field

public XContentBuilder field(String name,
                             BytesReference value)
                      throws IOException

Writes the binary content of the given BytesReference Use XContentParser.binaryValue() to read the value back

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             BytesReference value)
                      throws IOException

Writes the binary content of the given BytesReference Use XContentParser.binaryValue() to read the value back

Throws:: IOException

utf8Field

public XContentBuilder utf8Field(XContentBuilderString name,
                                 org.apache.lucene.util.BytesRef value)
                          throws IOException

Writes the binary content of the given BytesRef as UTF-8 bytes Use XContentParser.utf8Bytes() to read the value back

Throws:: IOException

utf8Field

public XContentBuilder utf8Field(String name,
                                 org.apache.lucene.util.BytesRef value)
                          throws IOException

Writes the binary content of the given BytesRef as UTF-8 bytes Use XContentParser.utf8Bytes() to read the value back

Throws:: IOException

field

public XContentBuilder field(String name,
                             Text value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Text value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             byte[] value,
                             int offset,
                             int length)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Map<String,Object> value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Map<String,Object> value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Iterable<?> value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Iterable<?> value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             boolean... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             boolean... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             String... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             String... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Object... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Object... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             int... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             int offset,
                             int length,
                             int... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             int... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             long... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             long... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             float... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             float... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             double... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             double... value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Object value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Object value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(Object value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             boolean value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             boolean value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             byte[] value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             byte[] value)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             org.joda.time.ReadableInstant date)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             org.joda.time.ReadableInstant date)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             org.joda.time.ReadableInstant date,
                             org.joda.time.format.DateTimeFormatter formatter)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             org.joda.time.ReadableInstant date,
                             org.joda.time.format.DateTimeFormatter formatter)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Date date)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Date date)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(String name,
                             Date date,
                             org.joda.time.format.DateTimeFormatter formatter)
                      throws IOException

Throws:: IOException

field

public XContentBuilder field(XContentBuilderString name,
                             Date date,
                             org.joda.time.format.DateTimeFormatter formatter)
                      throws IOException

Throws:: IOException

nullField

public XContentBuilder nullField(String name)
                          throws IOException

Throws:: IOException

nullField

public XContentBuilder nullField(XContentBuilderString name)
                          throws IOException

Throws:: IOException

nullValue

public XContentBuilder nullValue()
                          throws IOException

Throws:: IOException

rawField

public XContentBuilder rawField(String fieldName,
                                InputStream content)
                         throws IOException

Throws:: IOException

rawField

public XContentBuilder rawField(String fieldName,
                                BytesReference content)
                         throws IOException

Throws:: IOException

rawValue

public XContentBuilder rawValue(BytesReference content)
                         throws IOException

Throws:: IOException

timeValueField

public XContentBuilder timeValueField(XContentBuilderString rawFieldName,
                                      XContentBuilderString readableFieldName,
                                      TimeValue timeValue)
                               throws IOException

Throws:: IOException

timeValueField

public XContentBuilder timeValueField(XContentBuilderString rawFieldName,
                                      XContentBuilderString readableFieldName,
                                      long rawTime)
                               throws IOException

Throws:: IOException

dateValueField

public XContentBuilder dateValueField(XContentBuilderString rawFieldName,
                                      XContentBuilderString readableFieldName,
                                      long rawTimestamp)
                               throws IOException

Throws:: IOException

timeValueField

public XContentBuilder timeValueField(String rawFieldName,
                                      String readableFieldName,
                                      long rawTime,
                                      TimeUnit timeUnit)
                               throws IOException

Throws:: IOException

dateValueField

public XContentBuilder dateValueField(String rawFieldName,
                                      String readableFieldName,
                                      long rawTimestamp)
                               throws IOException

Throws:: IOException

byteSizeField

public XContentBuilder byteSizeField(XContentBuilderString rawFieldName,
                                     XContentBuilderString readableFieldName,
                                     ByteSizeValue byteSizeValue)
                              throws IOException

Throws:: IOException

byteSizeField

public XContentBuilder byteSizeField(XContentBuilderString rawFieldName,
                                     XContentBuilderString readableFieldName,
                                     long rawSize)
                              throws IOException

Throws:: IOException

percentageField

public XContentBuilder percentageField(XContentBuilderString rawFieldName,
                                       XContentBuilderString readableFieldName,
                                       double percentage)
                                throws IOException

Throws:: IOException

value

public XContentBuilder value(Boolean value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(boolean value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(org.joda.time.ReadableInstant date)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(org.joda.time.ReadableInstant date,
                             org.joda.time.format.DateTimeFormatter dateTimeFormatter)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(Date date)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(Date date,
                             org.joda.time.format.DateTimeFormatter dateTimeFormatter)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(Integer value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(int value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(Long value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(long value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(Float value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(float value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(Double value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(double value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(String value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(byte[] value)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(byte[] value,
                             int offset,
                             int length)
                      throws IOException

Throws:: IOException

value
```
public XContentBuilder value(org.apache.lucene.util.BytesRef value)
                      throws IOException
```
Writes the binary content of the given BytesRef Use XContentParser.binaryValue() to read the value back

Throws:

IOException

value
```
public XContentBuilder value(BytesReference value)
                      throws IOException
```
Writes the binary content of the given BytesReference Use XContentParser.binaryValue() to read the value back

Throws:

IOException

value

public XContentBuilder value(Text value)
                      throws IOException

Throws:: IOException

map

public XContentBuilder map(Map<String,?> map)
                    throws IOException

Throws:: IOException

value

public XContentBuilder value(Map<String,Object> map)
                      throws IOException

Throws:: IOException

value

public XContentBuilder value(Iterable<?> value)
                      throws IOException

Throws:: IOException

latlon

public XContentBuilder latlon(String name,
                              double lat,
                              double lon)
                       throws IOException

Throws:: IOException

latlon

public XContentBuilder latlon(double lat,
                              double lon)
                       throws IOException

Throws:: IOException

copyCurrentStructure

public XContentBuilder copyCurrentStructure(XContentParser parser)
                                     throws IOException

Throws:: IOException

flush

public XContentBuilder flush()
                      throws IOException

Throws:: IOException

close
```
public void close()
```
Specified by:

close in interface AutoCloseable

Specified by:

close in interface Releasable

generator
```
public XContentGenerator generator()
```

bytes
```
public BytesReference bytes()
```
Specified by:

bytes in interface BytesStream

string
```
public String string()
              throws IOException
```
Returns a string representation of the builder (only applicable for text based xcontent).

Throws:

IOException

Class XContentBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultDatePrinter

globalFieldCaseConversion

Constructor Detail

XContentBuilder

XContentBuilder

Method Detail

globalFieldCaseConversion

builder

builder

fieldCaseConversion

contentType

prettyPrint

lfAtEnd

humanReadable

humanReadable

field

field

startObject

startObject

startObject

startObject

startObject

endObject

array

array

array

array

startArray

startArray

startArray

startArray

endArray

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

field

utf8Field

utf8Field

field

field

field

field

field