Package org.elasticsearch.xcontent.json
Class JsonXContentGenerator
java.lang.Object
org.elasticsearch.xcontent.json.JsonXContentGenerator
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
,XContentGenerator
- Direct Known Subclasses:
CborXContentGenerator
,SmileXContentGenerator
,YamlXContentGenerator
-
Field Summary
Modifier and TypeFieldDescriptionprotected final com.fasterxml.jackson.core.JsonGenerator
Generator used to write content -
Constructor Summary
ConstructorDescriptionJsonXContentGenerator
(com.fasterxml.jackson.core.JsonGenerator baseJsonGenerator, OutputStream os, Set<String> includes, Set<String> excludes) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
void
copyCurrentStructure
(XContentParser parser) protected void
copyRawValue
(InputStream stream, XContent xContent) void
flush()
boolean
isClosed()
Returnstrue
if this XContentGenerator has been closed.boolean
protected boolean
Whether this generator supports writing raw data directlyfinal void
void
void
writeBinary
(byte[] value) void
writeBinary
(byte[] value, int offset, int len) void
writeBinaryField
(String name, byte[] value) void
writeBoolean
(boolean value) void
writeBooleanField
(String name, boolean value) void
writeDirectField
(String name, org.elasticsearch.core.CheckedConsumer<OutputStream, IOException> writer) Write a field whose value is written directly to the output stream.void
void
void
void
writeFieldName
(String name) void
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 content) Writes a raw field with the value taken from the bytes in the streamvoid
writeRawField
(String name, InputStream content, XContentType contentType) Writes a raw field with the value taken from the bytes in the streamvoid
writeRawValue
(InputStream stream, XContentType xContentType) Writes a raw value taken from the bytes in the streamvoid
void
void
writeString
(char[] value, 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.XContentGenerator
copyCurrentEvent
-
Field Details
-
generator
protected final com.fasterxml.jackson.core.JsonGenerator generatorGenerator used to write content
-
-
Constructor Details
-
JsonXContentGenerator
public JsonXContentGenerator(com.fasterxml.jackson.core.JsonGenerator baseJsonGenerator, OutputStream os, Set<String> includes, Set<String> excludes)
-
-
Method Details
-
contentType
- Specified by:
contentType
in interfaceXContentGenerator
-
usePrettyPrint
public final void usePrettyPrint()- Specified by:
usePrettyPrint
in interfaceXContentGenerator
-
isPrettyPrint
public boolean isPrettyPrint()- Specified by:
isPrettyPrint
in interfaceXContentGenerator
-
usePrintLineFeedAtEnd
public void usePrintLineFeedAtEnd()- Specified by:
usePrintLineFeedAtEnd
in interfaceXContentGenerator
-
writeStartObject
- Specified by:
writeStartObject
in interfaceXContentGenerator
- Throws:
IOException
-
writeEndObject
- Specified by:
writeEndObject
in interfaceXContentGenerator
- Throws:
IOException
-
writeStartArray
- Specified by:
writeStartArray
in interfaceXContentGenerator
- Throws:
IOException
-
writeEndArray
- Specified by:
writeEndArray
in interfaceXContentGenerator
- Throws:
IOException
-
writeFieldName
- Specified by:
writeFieldName
in interfaceXContentGenerator
- Throws:
IOException
-
writeNull
- Specified by:
writeNull
in interfaceXContentGenerator
- Throws:
IOException
-
writeNullField
- Specified by:
writeNullField
in interfaceXContentGenerator
- Throws:
IOException
-
writeBooleanField
- Specified by:
writeBooleanField
in interfaceXContentGenerator
- Throws:
IOException
-
writeBoolean
- Specified by:
writeBoolean
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumberField
- Specified by:
writeNumberField
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumberField
- Specified by:
writeNumberField
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumberField
- Specified by:
writeNumberField
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumberField
- Specified by:
writeNumberField
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumberField
- Specified by:
writeNumberField
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumberField
- Specified by:
writeNumberField
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in interfaceXContentGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in interfaceXContentGenerator
- Throws:
IOException
-
writeStringField
- Specified by:
writeStringField
in interfaceXContentGenerator
- Throws:
IOException
-
writeString
- Specified by:
writeString
in interfaceXContentGenerator
- Throws:
IOException
-
writeString
- Specified by:
writeString
in interfaceXContentGenerator
- Throws:
IOException
-
writeUTF8String
- Specified by:
writeUTF8String
in interfaceXContentGenerator
- Throws:
IOException
-
writeBinaryField
- Specified by:
writeBinaryField
in interfaceXContentGenerator
- Throws:
IOException
-
writeBinary
- Specified by:
writeBinary
in interfaceXContentGenerator
- Throws:
IOException
-
writeBinary
- Specified by:
writeBinary
in interfaceXContentGenerator
- Throws:
IOException
-
writeEndRaw
public void writeEndRaw() -
writeRawField
Description copied from interface:XContentGenerator
Writes a raw field with the value taken from the bytes in the stream- Specified by:
writeRawField
in interfaceXContentGenerator
- Throws:
IOException
-
writeRawField
public void writeRawField(String name, InputStream content, XContentType contentType) throws IOException Description copied from interface:XContentGenerator
Writes a raw field with the value taken from the bytes in the stream- Specified by:
writeRawField
in interfaceXContentGenerator
- Throws:
IOException
-
writeRawValue
Description copied from interface:XContentGenerator
Writes a raw value taken from the bytes in the stream- Specified by:
writeRawValue
in interfaceXContentGenerator
- Throws:
IOException
-
supportsRawWrites
protected boolean supportsRawWrites()Whether this generator supports writing raw data directly -
copyRawValue
- Throws:
IOException
-
copyCurrentStructure
- Specified by:
copyCurrentStructure
in interfaceXContentGenerator
- Throws:
IOException
-
writeDirectField
public void writeDirectField(String name, org.elasticsearch.core.CheckedConsumer<OutputStream, IOException> writer) throws IOExceptionDescription copied from interface:XContentGenerator
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)- Specified by:
writeDirectField
in interfaceXContentGenerator
- Throws:
IOException
-
flush
- Specified by:
flush
in interfaceFlushable
- Throws:
IOException
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
isClosed
public boolean isClosed()Description copied from interface:XContentGenerator
Returnstrue
if this XContentGenerator has been closed. A closed generator can not do any more output.- Specified by:
isClosed
in interfaceXContentGenerator
-