Package org.elasticsearch.xcontent

Interface XContentGenerator

All Superinterfaces:

AutoCloseable, Closeable, Flushable

All Known Implementing Classes:

CborXContentGenerator, JsonXContentGenerator, SmileXContentGenerator, YamlXContentGenerator

public interface XContentGenerator
extends Closeable, Flushable

Method Summary

Modifier and Type	Method	Description
XContentType	contentType()
default void	copyCurrentEvent(XContentParser parser)
void	copyCurrentStructure(XContentParser parser)
boolean	isClosed()	Returns true if this XContentGenerator has been closed.
boolean	isPrettyPrint()
void	usePrettyPrint()
void	usePrintLineFeedAtEnd()
void	writeBinary(byte[] value)
void	writeBinary(byte[] value, int offset, int length)
void	writeBinaryField(String name, byte[] value)
void	writeBoolean(boolean value)
void	writeBooleanField(String name, boolean value)
void	writeDirectField(String name, CheckedConsumer<OutputStream,IOException> writer)	Write a field whose value is written directly to the output stream.
void	writeEndArray()
void	writeEndObject()
void	writeFieldName(String name)
void	writeNull()
void	writeNullField(String name)
void	writeNumber(double value)
void	writeNumber(float value)
void	writeNumber(int value)
void	writeNumber(long value)
void	writeNumber(short value)
void	writeNumber(BigDecimal value)
void	writeNumber(BigInteger value)
void	writeNumberField(String name, double value)
void	writeNumberField(String name, float value)
void	writeNumberField(String name, int value)
void	writeNumberField(String name, long value)
void	writeNumberField(String name, BigDecimal value)
void	writeNumberField(String name, BigInteger value)
void	writeRawField(String name, InputStream value)	Deprecated. use writeRawField(String, InputStream, XContentType) to avoid content type auto-detection
void	writeRawField(String name, InputStream value, XContentType xContentType)	Writes a raw field with the value taken from the bytes in the stream
void	writeRawValue(InputStream value, XContentType xContentType)	Writes a raw value taken from the bytes in the stream
void	writeStartArray()
void	writeStartObject()
void	writeString(char[] text, int offset, int len)
void	writeString(String value)
void	writeStringField(String name, String value)
void	writeUTF8String(byte[] value, int offset, int length)

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Method Details

contentType

XContentType contentType()

usePrettyPrint

void usePrettyPrint()

isPrettyPrint

boolean isPrettyPrint()

usePrintLineFeedAtEnd

void usePrintLineFeedAtEnd()

writeStartObject

void writeStartObject()
               throws IOException

Throws:

IOException

writeEndObject

void writeEndObject()
             throws IOException

Throws:

IOException

writeStartArray

void writeStartArray()
              throws IOException

Throws:

IOException

writeEndArray

void writeEndArray()
            throws IOException

Throws:

IOException

writeFieldName

void writeFieldName(String name)
             throws IOException

Throws:

IOException

writeNull

void writeNull()
        throws IOException

Throws:

IOException

writeNullField

void writeNullField(String name)
             throws IOException

Throws:

IOException

writeBooleanField

void writeBooleanField(String name,
 boolean value)
                throws IOException

Throws:

IOException

writeBoolean

void writeBoolean(boolean value)
           throws IOException

Throws:

IOException

writeNumberField

void writeNumberField(String name,
 double value)
               throws IOException

Throws:

IOException

writeNumber

void writeNumber(double value)
          throws IOException

Throws:

IOException

writeNumberField

void writeNumberField(String name,
 float value)
               throws IOException

Throws:

IOException

writeNumber

void writeNumber(float value)
          throws IOException

Throws:

IOException

writeNumberField

void writeNumberField(String name,
 int value)
               throws IOException

Throws:

IOException

writeNumber

void writeNumber(int value)
          throws IOException

Throws:

IOException

writeNumberField

void writeNumberField(String name,
 long value)
               throws IOException

Throws:

IOException

writeNumber

void writeNumber(long value)
          throws IOException

Throws:

IOException

writeNumber

void writeNumber(short value)
          throws IOException

Throws:

IOException

writeNumber

void writeNumber(BigInteger value)
          throws IOException

Throws:

IOException

writeNumberField

void writeNumberField(String name,
 BigInteger value)
               throws IOException

Throws:

IOException

writeNumber

void writeNumber(BigDecimal value)
          throws IOException

Throws:

IOException

writeNumberField

void writeNumberField(String name,
 BigDecimal value)
               throws IOException

Throws:

IOException

writeStringField

void writeStringField(String name,
 String value)
               throws IOException

Throws:

IOException

writeString

void writeString(String value)
          throws IOException

Throws:

IOException

writeString

void writeString(char[] text,
 int offset,
 int len)
          throws IOException

Throws:

IOException

writeUTF8String

void writeUTF8String(byte[] value,
 int offset,
 int length)
              throws IOException

Throws:

IOException

writeBinaryField

void writeBinaryField(String name,
 byte[] value)
               throws IOException

Throws:

IOException

writeBinary

void writeBinary(byte[] value)
          throws IOException

Throws:

IOException

writeBinary

void writeBinary(byte[] value,
 int offset,
 int length)
          throws IOException

Throws:

IOException

writeRawField

@Deprecated
void writeRawField(String name,
 InputStream value)
            throws IOException

Deprecated.

use writeRawField(String, InputStream, XContentType) to avoid content type auto-detection

Writes a raw field with the value taken from the bytes in the stream

Throws:

IOException

writeRawField

void writeRawField(String name,
 InputStream value,
 XContentType xContentType)
            throws IOException

Writes a raw field with the value taken from the bytes in the stream

Throws:

IOException

writeRawValue

void writeRawValue(InputStream value,
 XContentType xContentType)
            throws IOException

Writes a raw value taken from the bytes in the stream

Throws:

IOException

copyCurrentStructure

void copyCurrentStructure(XContentParser parser)
                   throws IOException

Throws:

IOException

writeDirectField

void writeDirectField(String name,
 CheckedConsumer<OutputStream,IOException> writer)
               throws IOException

Write a field whose value is written directly to the output stream. As the content is copied as is, the writer must a valid XContent value (e.g., string is properly escaped and quoted)

Throws:

IOException

copyCurrentEvent

default void copyCurrentEvent(XContentParser parser)
                       throws IOException

Throws:

IOException

isClosed

boolean isClosed()

Returns true if this XContentGenerator has been closed. A closed generator can not do any more output.