public final class XContentBuilder extends java.lang.Object implements BytesStream, Releasable
Modifier and Type | Field and Description |
---|---|
static org.joda.time.format.DateTimeFormatter |
defaultDatePrinter |
Constructor and Description |
---|
XContentBuilder(XContent xContent,
java.io.OutputStream bos)
Constructs a new builder using the provided xcontent and an OutputStream.
|
XContentBuilder(XContent xContent,
java.io.OutputStream bos,
java.lang.String[] filters)
Constructs a new builder using the provided xcontent, an OutputStream and
some filters.
|
XContentBuilder(XContent xContent,
java.io.OutputStream bos,
java.lang.String[] filters,
boolean inclusive)
Constructs a new builder using the provided xcontent, an OutputStream and
some filters.
|
Modifier and Type | Method and Description |
---|---|
XContentBuilder |
array(java.lang.String name,
java.lang.Object... values) |
XContentBuilder |
array(java.lang.String name,
java.lang.String... values) |
static XContentBuilder |
builder(XContent xContent) |
static XContentBuilder |
builder(XContent xContent,
java.lang.String[] filters) |
static XContentBuilder |
builder(XContent xContent,
java.lang.String[] filters,
boolean inclusive) |
BytesReference |
bytes() |
XContentBuilder |
byteSizeField(java.lang.String rawFieldName,
java.lang.String readableFieldName,
ByteSizeValue byteSizeValue) |
XContentBuilder |
byteSizeField(java.lang.String rawFieldName,
java.lang.String readableFieldName,
long rawSize) |
void |
close() |
XContentType |
contentType() |
XContentBuilder |
copyCurrentStructure(XContentParser parser) |
XContentBuilder |
dateValueField(java.lang.String rawFieldName,
java.lang.String readableFieldName,
long rawTimestamp) |
XContentBuilder |
endArray() |
XContentBuilder |
endObject() |
XContentBuilder |
field(java.lang.String name) |
XContentBuilder |
field(java.lang.String name,
java.math.BigDecimal value) |
XContentBuilder |
field(java.lang.String name,
java.math.BigDecimal value,
int scale,
java.math.RoundingMode rounding,
boolean toDouble) |
XContentBuilder |
field(java.lang.String name,
boolean... value) |
XContentBuilder |
field(java.lang.String name,
boolean value) |
XContentBuilder |
field(java.lang.String name,
byte[] value) |
XContentBuilder |
field(java.lang.String name,
byte[] value,
int offset,
int length) |
XContentBuilder |
field(java.lang.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(java.lang.String name,
BytesReference value)
Writes the binary content of the given BytesReference
Use
XContentParser.binaryValue() to read the value back |
XContentBuilder |
field(java.lang.String name,
char[] value,
int offset,
int length) |
XContentBuilder |
field(java.lang.String name,
java.util.Date date) |
XContentBuilder |
field(java.lang.String name,
java.util.Date date,
org.joda.time.format.DateTimeFormatter formatter) |
XContentBuilder |
field(java.lang.String name,
double... value) |
XContentBuilder |
field(java.lang.String name,
double value) |
XContentBuilder |
field(java.lang.String name,
java.lang.Double value) |
XContentBuilder |
field(java.lang.String name,
float... value) |
XContentBuilder |
field(java.lang.String name,
float value) |
XContentBuilder |
field(java.lang.String name,
java.lang.Float value) |
XContentBuilder |
field(java.lang.String name,
int... value) |
XContentBuilder |
field(java.lang.String name,
int value) |
XContentBuilder |
field(java.lang.String name,
java.lang.Integer value) |
XContentBuilder |
field(java.lang.String name,
java.lang.Iterable<?> value) |
XContentBuilder |
field(java.lang.String name,
long... value) |
XContentBuilder |
field(java.lang.String name,
long value) |
XContentBuilder |
field(java.lang.String name,
java.lang.Long value) |
XContentBuilder |
field(java.lang.String name,
java.util.Map<java.lang.String,java.lang.Object> value) |
XContentBuilder |
field(java.lang.String name,
java.lang.Object... value) |
XContentBuilder |
field(java.lang.String name,
java.lang.Object value) |
XContentBuilder |
field(java.lang.String name,
org.joda.time.ReadableInstant date) |
XContentBuilder |
field(java.lang.String name,
org.joda.time.ReadableInstant date,
org.joda.time.format.DateTimeFormatter formatter) |
XContentBuilder |
field(java.lang.String name,
java.lang.String... value) |
XContentBuilder |
field(java.lang.String name,
java.lang.String value) |
XContentBuilder |
field(java.lang.String name,
Text value) |
XContentBuilder |
field(java.lang.String name,
ToXContent xContent) |
XContentBuilder |
field(java.lang.String name,
ToXContent xContent,
ToXContent.Params params) |
XContentBuilder |
flush() |
XContentGenerator |
generator() |
boolean |
humanReadable() |
XContentBuilder |
humanReadable(boolean humanReadable) |
boolean |
isPrettyPrint() |
XContentBuilder |
latlon(double lat,
double lon) |
XContentBuilder |
latlon(java.lang.String name,
double lat,
double lon) |
XContentBuilder |
lfAtEnd() |
XContentBuilder |
map(java.util.Map<java.lang.String,?> map) |
XContentBuilder |
nullField(java.lang.String name) |
XContentBuilder |
nullValue() |
XContentBuilder |
percentageField(java.lang.String rawFieldName,
java.lang.String readableFieldName,
double percentage) |
XContentBuilder |
prettyPrint() |
XContentBuilder |
rawField(java.lang.String fieldName,
BytesReference content) |
XContentBuilder |
rawField(java.lang.String fieldName,
java.io.InputStream content) |
XContentBuilder |
rawValue(BytesReference content) |
XContentBuilder |
startArray() |
XContentBuilder |
startArray(java.lang.String name) |
XContentBuilder |
startObject() |
XContentBuilder |
startObject(java.lang.String name) |
java.lang.String |
string()
Returns a string representation of the builder (only applicable for text based xcontent).
|
XContentBuilder |
timeValueField(java.lang.String rawFieldName,
java.lang.String readableFieldName,
long rawTime) |
XContentBuilder |
timeValueField(java.lang.String rawFieldName,
java.lang.String readableFieldName,
long rawTime,
java.util.concurrent.TimeUnit timeUnit) |
XContentBuilder |
timeValueField(java.lang.String rawFieldName,
java.lang.String readableFieldName,
TimeValue timeValue) |
XContentBuilder |
utf8Field(java.lang.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 |
value(boolean value) |
XContentBuilder |
value(java.lang.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(java.util.Date date) |
XContentBuilder |
value(java.util.Date date,
org.joda.time.format.DateTimeFormatter dateTimeFormatter) |
XContentBuilder |
value(double value) |
XContentBuilder |
value(java.lang.Double value) |
XContentBuilder |
value(float value) |
XContentBuilder |
value(java.lang.Float value) |
XContentBuilder |
value(int value) |
XContentBuilder |
value(java.lang.Integer value) |
XContentBuilder |
value(java.lang.Iterable<?> value) |
XContentBuilder |
value(long value) |
XContentBuilder |
value(java.lang.Long value) |
XContentBuilder |
value(java.util.Map<java.lang.String,java.lang.Object> map) |
XContentBuilder |
value(java.lang.Object value) |
XContentBuilder |
value(org.joda.time.ReadableInstant date) |
XContentBuilder |
value(org.joda.time.ReadableInstant date,
org.joda.time.format.DateTimeFormatter dateTimeFormatter) |
XContentBuilder |
value(java.lang.String value) |
XContentBuilder |
value(Text value) |
public static final org.joda.time.format.DateTimeFormatter defaultDatePrinter
public XContentBuilder(XContent xContent, java.io.OutputStream bos) throws java.io.IOException
close()
when the builder is done with.java.io.IOException
public XContentBuilder(XContent xContent, java.io.OutputStream bos, java.lang.String[] filters) throws java.io.IOException
close()
when the builder is done with.java.io.IOException
public XContentBuilder(XContent xContent, java.io.OutputStream bos, java.lang.String[] filters, boolean inclusive) throws java.io.IOException
filters
are specified and inclusive
is
true, only those values matching a filter will be written to the output
stream. If inclusive
is false, those matching will be excluded.
Make sure to call close()
when the builder is done with.java.io.IOException
public static XContentBuilder builder(XContent xContent) throws java.io.IOException
java.io.IOException
public static XContentBuilder builder(XContent xContent, java.lang.String[] filters) throws java.io.IOException
java.io.IOException
public static XContentBuilder builder(XContent xContent, java.lang.String[] filters, boolean inclusive) throws java.io.IOException
java.io.IOException
public XContentType contentType()
public XContentBuilder prettyPrint()
public boolean isPrettyPrint()
public XContentBuilder lfAtEnd()
public XContentBuilder humanReadable(boolean humanReadable)
public boolean humanReadable()
public XContentBuilder field(java.lang.String name, ToXContent xContent) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, ToXContent xContent, ToXContent.Params params) throws java.io.IOException
java.io.IOException
public XContentBuilder startObject(java.lang.String name) throws java.io.IOException
java.io.IOException
public XContentBuilder startObject() throws java.io.IOException
java.io.IOException
public XContentBuilder endObject() throws java.io.IOException
java.io.IOException
public XContentBuilder array(java.lang.String name, java.lang.String... values) throws java.io.IOException
java.io.IOException
public XContentBuilder array(java.lang.String name, java.lang.Object... values) throws java.io.IOException
java.io.IOException
public XContentBuilder startArray(java.lang.String name) throws java.io.IOException
java.io.IOException
public XContentBuilder startArray() throws java.io.IOException
java.io.IOException
public XContentBuilder endArray() throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, char[] value, int offset, int length) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.String value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.Integer value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, int value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.Long value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, long value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.Float value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, float value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.Double value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, double value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.math.BigDecimal value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.math.BigDecimal value, int scale, java.math.RoundingMode rounding, boolean toDouble) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, org.apache.lucene.util.BytesRef value) throws java.io.IOException
XContentParser.binaryValue()
to read the value backjava.io.IOException
public XContentBuilder field(java.lang.String name, BytesReference value) throws java.io.IOException
XContentParser.binaryValue()
to read the value backjava.io.IOException
public XContentBuilder utf8Field(java.lang.String name, org.apache.lucene.util.BytesRef value) throws java.io.IOException
XContentParser.utf8Bytes()
to read the value backjava.io.IOException
public XContentBuilder field(java.lang.String name, Text value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, byte[] value, int offset, int length) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.Iterable<?> value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, boolean... value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.String... value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.Object... value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, int... value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, long... value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, float... value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, double... value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.lang.Object value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.lang.Object value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, boolean value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, byte[] value) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, org.joda.time.ReadableInstant date) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, org.joda.time.ReadableInstant date, org.joda.time.format.DateTimeFormatter formatter) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.util.Date date) throws java.io.IOException
java.io.IOException
public XContentBuilder field(java.lang.String name, java.util.Date date, org.joda.time.format.DateTimeFormatter formatter) throws java.io.IOException
java.io.IOException
public XContentBuilder nullField(java.lang.String name) throws java.io.IOException
java.io.IOException
public XContentBuilder nullValue() throws java.io.IOException
java.io.IOException
public XContentBuilder rawField(java.lang.String fieldName, java.io.InputStream content) throws java.io.IOException
java.io.IOException
public XContentBuilder rawField(java.lang.String fieldName, BytesReference content) throws java.io.IOException
java.io.IOException
public XContentBuilder rawValue(BytesReference content) throws java.io.IOException
java.io.IOException
public XContentBuilder timeValueField(java.lang.String rawFieldName, java.lang.String readableFieldName, TimeValue timeValue) throws java.io.IOException
java.io.IOException
public XContentBuilder timeValueField(java.lang.String rawFieldName, java.lang.String readableFieldName, long rawTime) throws java.io.IOException
java.io.IOException
public XContentBuilder timeValueField(java.lang.String rawFieldName, java.lang.String readableFieldName, long rawTime, java.util.concurrent.TimeUnit timeUnit) throws java.io.IOException
java.io.IOException
public XContentBuilder dateValueField(java.lang.String rawFieldName, java.lang.String readableFieldName, long rawTimestamp) throws java.io.IOException
java.io.IOException
public XContentBuilder byteSizeField(java.lang.String rawFieldName, java.lang.String readableFieldName, ByteSizeValue byteSizeValue) throws java.io.IOException
java.io.IOException
public XContentBuilder byteSizeField(java.lang.String rawFieldName, java.lang.String readableFieldName, long rawSize) throws java.io.IOException
java.io.IOException
public XContentBuilder percentageField(java.lang.String rawFieldName, java.lang.String readableFieldName, double percentage) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.lang.Boolean value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(boolean value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(org.joda.time.ReadableInstant date) throws java.io.IOException
java.io.IOException
public XContentBuilder value(org.joda.time.ReadableInstant date, org.joda.time.format.DateTimeFormatter dateTimeFormatter) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.util.Date date) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.util.Date date, org.joda.time.format.DateTimeFormatter dateTimeFormatter) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.lang.Integer value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(int value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.lang.Long value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(long value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.lang.Float value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(float value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.lang.Double value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(double value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.lang.String value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(byte[] value) throws java.io.IOException
java.io.IOException
public XContentBuilder value(byte[] value, int offset, int length) throws java.io.IOException
java.io.IOException
public XContentBuilder value(org.apache.lucene.util.BytesRef value) throws java.io.IOException
XContentParser.binaryValue()
to read the value backjava.io.IOException
public XContentBuilder value(BytesReference value) throws java.io.IOException
XContentParser.binaryValue()
to read the value backjava.io.IOException
public XContentBuilder value(Text value) throws java.io.IOException
java.io.IOException
public XContentBuilder map(java.util.Map<java.lang.String,?> map) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.util.Map<java.lang.String,java.lang.Object> map) throws java.io.IOException
java.io.IOException
public XContentBuilder value(java.lang.Iterable<?> value) throws java.io.IOException
java.io.IOException
public XContentBuilder latlon(java.lang.String name, double lat, double lon) throws java.io.IOException
java.io.IOException
public XContentBuilder latlon(double lat, double lon) throws java.io.IOException
java.io.IOException
public XContentBuilder copyCurrentStructure(XContentParser parser) throws java.io.IOException
java.io.IOException
public XContentBuilder flush() throws java.io.IOException
java.io.IOException
public void close()
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in interface Releasable
public XContentGenerator generator()
public BytesReference bytes()
bytes
in interface BytesStream
public java.lang.String string() throws java.io.IOException
java.io.IOException