Class UTF8JsonGenerator
- java.lang.Object
-
- com.fasterxml.jackson.core.JsonGenerator
-
- com.fasterxml.jackson.core.base.GeneratorBase
-
- com.fasterxml.jackson.core.json.JsonGeneratorImpl
-
- com.fasterxml.jackson.core.json.UTF8JsonGenerator
-
- All Implemented Interfaces:
Versioned
,java.io.Closeable
,java.io.Flushable
,java.lang.AutoCloseable
public class UTF8JsonGenerator extends JsonGeneratorImpl
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonGenerator
JsonGenerator.Feature
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
_bufferRecyclable
Flag that indicates whether the output buffer is recycable (and needs to be returned to recycler once we are done) or not.protected char[]
_charBuffer
Intermediate buffer in which characters of a String are copied before being encoded.protected int
_charBufferLength
Length of_charBuffer
protected byte[]
_entityBuffer
6 character temporary buffer allocated if needed, for constructing escape sequencesprotected byte[]
_outputBuffer
Intermediate buffer in which contents are buffered before being written using_outputStream
.protected int
_outputEnd
End marker of the output buffer; one past the last valid position within the buffer.protected int
_outputMaxContiguous
Maximum number ofchar
s that we know will always fit in the output buffer after escapingprotected java.io.OutputStream
_outputStream
Underlying output stream used for writing JSON content.protected int
_outputTail
Pointer to the position right beyond the last character to output (end marker; may be past the buffer)protected byte
_quoteChar
Character used for quoting JSON Object property names and String values.private static byte
BYTE_0
private static byte
BYTE_BACKSLASH
private static byte
BYTE_COLON
private static byte
BYTE_COMMA
private static byte
BYTE_LBRACKET
private static byte
BYTE_LCURLY
private static byte
BYTE_RBRACKET
private static byte
BYTE_RCURLY
private static byte
BYTE_u
private static byte[]
FALSE_BYTES
private static byte[]
HEX_CHARS
private static int
MAX_BYTES_TO_BUFFER
private static byte[]
NULL_BYTES
private static byte[]
TRUE_BYTES
-
Fields inherited from class com.fasterxml.jackson.core.json.JsonGeneratorImpl
_cfgUnqNames, _characterEscapes, _ioContext, _maximumNonEscapedChar, _outputEscapes, _rootValueSeparator, sOutputEscapes
-
Fields inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext, DERIVED_FEATURES_MASK, MAX_BIG_DECIMAL_SCALE, SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST, WRITE_BINARY, WRITE_BOOLEAN, WRITE_NULL, WRITE_NUMBER, WRITE_RAW, WRITE_STRING
-
Fields inherited from class com.fasterxml.jackson.core.JsonGenerator
_cfgPrettyPrinter
-
-
Constructor Summary
Constructors Constructor Description UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out)
Deprecated.UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable)
Deprecated.UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, char quoteChar)
UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, char quoteChar, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
_flushBuffer()
private int
_handleLongCustomEscape(byte[] outputBuffer, int outputPtr, int outputEnd, byte[] raw, int remainingChars)
private int
_outputMultiByteChar(int ch, int outputPtr)
private int
_outputRawMultiByteChar(int ch, char[] cbuf, int inputOffset, int inputEnd)
Method called to output a character that is beyond range of 1- and 2-byte UTF-8 encodings, when outputting "raw" text (meaning it is not to be escaped or quoted)protected void
_outputSurrogates(int surr1, int surr2)
private int
_readMore(java.io.InputStream in, byte[] readBuffer, int inputPtr, int inputEnd, int maxRead)
protected void
_releaseBuffers()
Method called to release any buffers generator may be holding, once generator is being closed.protected void
_verifyValueWrite(java.lang.String typeMsg)
Method called before trying to write a value (scalar or structured), to verify that this is legal in current output state, as well as to output separators if and as necessary.protected void
_writeBinary(Base64Variant b64variant, byte[] input, int inputPtr, int inputEnd)
protected int
_writeBinary(Base64Variant b64variant, java.io.InputStream data, byte[] readBuffer)
protected int
_writeBinary(Base64Variant b64variant, java.io.InputStream data, byte[] readBuffer, int bytesLeft)
private void
_writeBytes(byte[] bytes)
private void
_writeBytes(byte[] bytes, int offset, int len)
private int
_writeCustomEscape(byte[] outputBuffer, int outputPtr, SerializableString esc, int remainingChars)
private void
_writeCustomStringSegment2(char[] cbuf, int offset, int end)
Same as_writeStringSegmentASCII2(char[], ...)
private void
_writeCustomStringSegment2(java.lang.String text, int offset, int end)
private int
_writeGenericEscape(int charToEscape, int outputPtr)
Method called to write a generic Unicode escape for given character.private void
_writeNull()
protected void
_writePPFieldName(SerializableString name)
protected void
_writePPFieldName(java.lang.String name)
Specialized version of_writeFieldName
, off-lined to keep the "fast path" as simple (and hopefully fast) as possible.private void
_writeQuotedInt(int i)
private void
_writeQuotedLong(long l)
private void
_writeQuotedRaw(char[] text, int offset, int length)
private void
_writeQuotedRaw(java.lang.String value)
private void
_writeQuotedShort(short s)
private void
_writeRawSegment(char[] cbuf, int offset, int end)
Helper method that is called for segmented write of raw content when explicitly outputting a segment of longer thing.private void
_writeSegmentedRaw(char[] cbuf, int offset, int len)
Helper method called when it is possible that output of raw section to output may cross buffer boundaryprivate void
_writeStringSegment(char[] cbuf, int offset, int len)
This method called when the string content is already in a char buffer, and its maximum total encoded and escaped length can not exceed size of the output buffer.private void
_writeStringSegment(java.lang.String text, int offset, int len)
private void
_writeStringSegment2(char[] cbuf, int offset, int end)
Secondary method called when content contains characters to escape, and/or multi-byte UTF-8 characters.private void
_writeStringSegment2(java.lang.String text, int offset, int end)
private void
_writeStringSegmentASCII2(char[] cbuf, int offset, int end)
Same as_writeStringSegment2(char[], ...)
private void
_writeStringSegmentASCII2(java.lang.String text, int offset, int end)
private void
_writeStringSegments(char[] cbuf, int offset, int totalLen)
Method called when character sequence to write is long enough that its maximum encoded and escaped form is not guaranteed to fit in the output buffer.private void
_writeStringSegments(java.lang.String text, boolean addQuotes)
Method called when String to write is long enough not to fit completely in temporary copy buffer.private void
_writeStringSegments(java.lang.String text, int offset, int totalLen)
private void
_writeUnq(SerializableString name)
private void
_writeUTF8Segment(byte[] utf8, int offset, int len)
private void
_writeUTF8Segment2(byte[] utf8, int offset, int len)
private void
_writeUTF8Segments(byte[] utf8, int offset, int totalLen)
Method called when UTF-8 encoded (but NOT yet escaped!) content is not guaranteed to fit in the output buffer after escaping; as such, we just need to chunk writes.void
close()
Method called to close this generator, so that no more content can be written.void
flush()
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.int
getOutputBuffered()
Method for verifying amount of content that is buffered by generator but not yet flushed to the underlying target (stream, writer), in units (byte, char) that the generator implementation uses for buffering; or -1 if this information is not available.java.lang.Object
getOutputTarget()
Method that can be used to get access to object that is used as target for generated output; this is usually eitherOutputStream
orWriter
, depending on what generator was constructed with.void
writeBinary(Base64Variant b64variant, byte[] data, int offset, int len)
Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes).int
writeBinary(Base64Variant b64variant, java.io.InputStream data, int dataLength)
Method similar toJsonGenerator.writeBinary(Base64Variant,byte[],int,int)
, but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.void
writeBoolean(boolean state)
Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').void
writeEndArray()
Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).void
writeEndObject()
Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).void
writeFieldName(SerializableString name)
Method similar toJsonGenerator.writeFieldName(String)
, main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.void
writeFieldName(java.lang.String name)
Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.void
writeNull()
Method for outputting literal JSON null value.void
writeNumber(char[] encodedValueBuffer, int offset, int length)
Overloaded version ofJsonGenerator.writeNumber(String)
with same semantics but possibly more efficient operation.void
writeNumber(double d)
Method for outputting indicate JSON numeric value.void
writeNumber(float f)
Method for outputting indicate JSON numeric value.void
writeNumber(int i)
Method for outputting given value as JSON number.void
writeNumber(long l)
Method for outputting given value as JSON number.void
writeNumber(short s)
Method for outputting given value as JSON number.void
writeNumber(java.lang.String encodedValue)
Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types.void
writeNumber(java.math.BigDecimal value)
Method for outputting indicate JSON numeric value.void
writeNumber(java.math.BigInteger value)
Method for outputting given value as JSON number.void
writeRaw(char ch)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).void
writeRaw(char[] cbuf, int offset, int len)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).void
writeRaw(SerializableString text)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).void
writeRaw(java.lang.String text)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).void
writeRaw(java.lang.String text, int offset, int len)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).void
writeRawUTF8String(byte[] text, int offset, int length)
Method similar toJsonGenerator.writeString(String)
but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON).void
writeRawValue(SerializableString text)
Method similar toJsonGenerator.writeRawValue(String)
, but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.writeRaw(SerializableString)
.void
writeStartArray()
Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).void
writeStartArray(int size)
Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray()
, but also specifying how many elements will be written for the array before callingJsonGenerator.writeEndArray()
.void
writeStartObject()
Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).void
writeStartObject(java.lang.Object forValue)
Method for writing starting marker of an Object value to represent the given Java Object value.void
writeString(char[] text, int offset, int len)
Method for outputting a String value.void
writeString(SerializableString text)
Method similar toJsonGenerator.writeString(String)
, but that takesSerializableString
which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.void
writeString(java.io.Reader reader, int len)
Method for outputting a String value.void
writeString(java.lang.String text)
Method for outputting a String value.void
writeUTF8String(byte[] text, int offset, int len)
Method similar toJsonGenerator.writeString(String)
but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else).-
Methods inherited from class com.fasterxml.jackson.core.json.JsonGeneratorImpl
_checkStdFeatureChanges, _reportCantWriteValueExpectName, _verifyPrettyValueWrite, disable, enable, getCharacterEscapes, getHighestEscapedChar, setCharacterEscapes, setHighestNonEscapedChar, setRootValueSeparator, version
-
Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_asString, _constructDefaultPrettyPrinter, _decodeSurrogate, getCodec, getCurrentValue, getFeatureMask, getOutputContext, isClosed, isEnabled, overrideStdFeatures, setCodec, setCurrentValue, setFeatureMask, useDefaultPrettyPrinter, writeObject, writeRawValue, writeRawValue, writeRawValue, writeTree
-
Methods inherited from class com.fasterxml.jackson.core.JsonGenerator
_copyCurrentContents, _reportError, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteFormattedNumbers, canWriteObjectId, canWriteTypeId, configure, copyCurrentEvent, copyCurrentStructure, getFormatFeatures, getPrettyPrinter, getSchema, isEnabled, overrideFormatFeatures, setPrettyPrinter, setSchema, writeArray, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeEmbeddedObject, writeFieldId, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectId, writeObjectRef, writeOmittedField, writeStartArray, writeStartArray, writeStartObject, writeStringField, writeTypeId, writeTypePrefix, writeTypeSuffix
-
-
-
-
Field Detail
-
BYTE_u
private static final byte BYTE_u
- See Also:
- Constant Field Values
-
BYTE_0
private static final byte BYTE_0
- See Also:
- Constant Field Values
-
BYTE_LBRACKET
private static final byte BYTE_LBRACKET
- See Also:
- Constant Field Values
-
BYTE_RBRACKET
private static final byte BYTE_RBRACKET
- See Also:
- Constant Field Values
-
BYTE_LCURLY
private static final byte BYTE_LCURLY
- See Also:
- Constant Field Values
-
BYTE_RCURLY
private static final byte BYTE_RCURLY
- See Also:
- Constant Field Values
-
BYTE_BACKSLASH
private static final byte BYTE_BACKSLASH
- See Also:
- Constant Field Values
-
BYTE_COMMA
private static final byte BYTE_COMMA
- See Also:
- Constant Field Values
-
BYTE_COLON
private static final byte BYTE_COLON
- See Also:
- Constant Field Values
-
MAX_BYTES_TO_BUFFER
private static final int MAX_BYTES_TO_BUFFER
- See Also:
- Constant Field Values
-
HEX_CHARS
private static final byte[] HEX_CHARS
-
NULL_BYTES
private static final byte[] NULL_BYTES
-
TRUE_BYTES
private static final byte[] TRUE_BYTES
-
FALSE_BYTES
private static final byte[] FALSE_BYTES
-
_outputStream
protected final java.io.OutputStream _outputStream
Underlying output stream used for writing JSON content.
-
_quoteChar
protected byte _quoteChar
Character used for quoting JSON Object property names and String values.- Since:
- 2.8
-
_outputBuffer
protected byte[] _outputBuffer
Intermediate buffer in which contents are buffered before being written using_outputStream
.
-
_outputTail
protected int _outputTail
Pointer to the position right beyond the last character to output (end marker; may be past the buffer)
-
_outputEnd
protected final int _outputEnd
End marker of the output buffer; one past the last valid position within the buffer.
-
_outputMaxContiguous
protected final int _outputMaxContiguous
Maximum number ofchar
s that we know will always fit in the output buffer after escaping
-
_charBuffer
protected char[] _charBuffer
Intermediate buffer in which characters of a String are copied before being encoded.
-
_charBufferLength
protected final int _charBufferLength
Length of_charBuffer
-
_entityBuffer
protected byte[] _entityBuffer
6 character temporary buffer allocated if needed, for constructing escape sequences
-
_bufferRecyclable
protected boolean _bufferRecyclable
Flag that indicates whether the output buffer is recycable (and needs to be returned to recycler once we are done) or not.
-
-
Constructor Detail
-
UTF8JsonGenerator
public UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, char quoteChar)
- Since:
- 2.10
-
UTF8JsonGenerator
public UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, char quoteChar, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable)
- Since:
- 2.10
-
UTF8JsonGenerator
@Deprecated public UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out)
Deprecated.
-
UTF8JsonGenerator
@Deprecated public UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable)
Deprecated.
-
-
Method Detail
-
getOutputTarget
public java.lang.Object getOutputTarget()
Description copied from class:JsonGenerator
Method that can be used to get access to object that is used as target for generated output; this is usually eitherOutputStream
orWriter
, depending on what generator was constructed with. Note that returned value may be null in some cases; including case where implementation does not want to exposed raw source to caller. In cases where output has been decorated, object returned here is the decorated version; this allows some level of interaction between users of generator and decorator object.In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.
- Overrides:
getOutputTarget
in classJsonGenerator
-
getOutputBuffered
public int getOutputBuffered()
Description copied from class:JsonGenerator
Method for verifying amount of content that is buffered by generator but not yet flushed to the underlying target (stream, writer), in units (byte, char) that the generator implementation uses for buffering; or -1 if this information is not available. Unit used is often the same as the unit of underlying target (that is, `byte` forOutputStream
, `char` forWriter
), but may differ if buffering is done before encoding. Default JSON-backed implementations do use matching units.Note: non-JSON implementations will be retrofitted for 2.6 and beyond; please report if you see -1 (missing override)
- Overrides:
getOutputBuffered
in classJsonGenerator
- Returns:
- Amount of content buffered in internal units, if amount known and accessible; -1 if not accessible.
-
writeFieldName
public void writeFieldName(java.lang.String name) throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.Field names can only be written in Object context (check out JSON specification for details), when field name is expected (field names alternate with values).
- Specified by:
writeFieldName
in classJsonGenerator
- Throws:
java.io.IOException
-
writeFieldName
public void writeFieldName(SerializableString name) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeFieldName(String)
, main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.Default implementation simple uses unprocessed name container in serialized String; implementations are strongly encouraged to make use of more efficient methods argument object has.
- Overrides:
writeFieldName
in classGeneratorBase
- Throws:
java.io.IOException
-
_writeUnq
private final void _writeUnq(SerializableString name) throws java.io.IOException
- Throws:
java.io.IOException
-
writeStartArray
public final void writeStartArray() throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
- Specified by:
writeStartArray
in classJsonGenerator
- Throws:
java.io.IOException
-
writeStartArray
public void writeStartArray(int size) throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray()
, but also specifying how many elements will be written for the array before callingJsonGenerator.writeEndArray()
.Default implementation simply calls
JsonGenerator.writeStartArray()
.- Overrides:
writeStartArray
in classJsonGenerator
- Parameters:
size
- Number of elements this array will have: actual number of values written (before matching call toJsonGenerator.writeEndArray()
MUST match; generator MAY verify this is the case.- Throws:
java.io.IOException
-
writeEndArray
public final void writeEndArray() throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).Marker can be written if the innermost structured type is Array.
- Specified by:
writeEndArray
in classJsonGenerator
- Throws:
java.io.IOException
-
writeStartObject
public final void writeStartObject() throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
- Specified by:
writeStartObject
in classJsonGenerator
- Throws:
java.io.IOException
-
writeStartObject
public void writeStartObject(java.lang.Object forValue) throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing starting marker of an Object value to represent the given Java Object value. Argument is offered as metadata, but more importantly it should be assigned as the "current value" for the Object content that gets constructed and initialized.Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
- Overrides:
writeStartObject
in classGeneratorBase
- Throws:
java.io.IOException
-
writeEndObject
public final void writeEndObject() throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).Marker can be written if the innermost structured type is Object, and the last written event was either a complete value, or START-OBJECT marker (see JSON specification for more details).
- Specified by:
writeEndObject
in classJsonGenerator
- Throws:
java.io.IOException
-
_writePPFieldName
protected final void _writePPFieldName(java.lang.String name) throws java.io.IOException
Specialized version of_writeFieldName
, off-lined to keep the "fast path" as simple (and hopefully fast) as possible.- Throws:
java.io.IOException
-
_writePPFieldName
protected final void _writePPFieldName(SerializableString name) throws java.io.IOException
- Throws:
java.io.IOException
-
writeString
public void writeString(java.lang.String text) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.- Specified by:
writeString
in classJsonGenerator
- Throws:
java.io.IOException
-
writeString
public void writeString(java.io.Reader reader, int len) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification. If the reader is null, then write a null. If len is < 0, then write all contents of the reader. Otherwise, write only len characters.- Overrides:
writeString
in classJsonGenerator
- Throws:
java.io.IOException
-
writeString
public void writeString(char[] text, int offset, int len) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.- Specified by:
writeString
in classJsonGenerator
- Throws:
java.io.IOException
-
writeString
public final void writeString(SerializableString text) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeString(String)
, but that takesSerializableString
which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.Default implementation just calls
JsonGenerator.writeString(String)
; sub-classes should override it with more efficient implementation if possible.- Overrides:
writeString
in classGeneratorBase
- Throws:
java.io.IOException
-
writeRawUTF8String
public void writeRawUTF8String(byte[] text, int offset, int length) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeString(String)
but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON). However, quoting that data format requires (like double-quotes for JSON) will be added around the value if and as necessary.Note that some backends may choose not to support this method: for example, if underlying destination is a
Writer
using this method would require UTF-8 decoding. If so, implementation may instead choose to throw aUnsupportedOperationException
due to ineffectiveness of having to decode input.- Specified by:
writeRawUTF8String
in classJsonGenerator
- Throws:
java.io.IOException
-
writeUTF8String
public void writeUTF8String(byte[] text, int offset, int len) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeString(String)
but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else). This means that textual JSON backends need to check if value needs JSON escaping, but otherwise can just be copied as is to output. Also, quoting that data format requires (like double-quotes for JSON) will be added around the value if and as necessary.Note that some backends may choose not to support this method: for example, if underlying destination is a
Writer
using this method would require UTF-8 decoding. In this case generator implementation may instead choose to throw aUnsupportedOperationException
due to ineffectiveness of having to decode input.- Specified by:
writeUTF8String
in classJsonGenerator
- Throws:
java.io.IOException
-
writeRaw
public void writeRaw(java.lang.String text) throws java.io.IOException
Description copied from class:JsonGenerator
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.- Specified by:
writeRaw
in classJsonGenerator
- Throws:
java.io.IOException
-
writeRaw
public void writeRaw(java.lang.String text, int offset, int len) throws java.io.IOException
Description copied from class:JsonGenerator
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.- Specified by:
writeRaw
in classJsonGenerator
- Throws:
java.io.IOException
-
writeRaw
public void writeRaw(SerializableString text) throws java.io.IOException
Description copied from class:JsonGenerator
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.The default implementation delegates to
JsonGenerator.writeRaw(String)
; other backends that support raw inclusion of text are encouraged to implement it in more efficient manner (especially if they use UTF-8 encoding).- Overrides:
writeRaw
in classJsonGenerator
- Throws:
java.io.IOException
-
writeRawValue
public void writeRawValue(SerializableString text) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeRawValue(String)
, but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.writeRaw(SerializableString)
.- Overrides:
writeRawValue
in classGeneratorBase
- Throws:
java.io.IOException
-
writeRaw
public final void writeRaw(char[] cbuf, int offset, int len) throws java.io.IOException
Description copied from class:JsonGenerator
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.- Specified by:
writeRaw
in classJsonGenerator
- Throws:
java.io.IOException
-
writeRaw
public void writeRaw(char ch) throws java.io.IOException
Description copied from class:JsonGenerator
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.- Specified by:
writeRaw
in classJsonGenerator
- Throws:
java.io.IOException
-
_writeSegmentedRaw
private final void _writeSegmentedRaw(char[] cbuf, int offset, int len) throws java.io.IOException
Helper method called when it is possible that output of raw section to output may cross buffer boundary- Throws:
java.io.IOException
-
_writeRawSegment
private void _writeRawSegment(char[] cbuf, int offset, int end) throws java.io.IOException
Helper method that is called for segmented write of raw content when explicitly outputting a segment of longer thing. Caller has to take care of ensuring there's no split surrogate pair at the end (that is, last char can not be first part of a surrogate char pair).- Throws:
java.io.IOException
- Since:
- 2.8.2
-
writeBinary
public void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws java.io.IOException, JsonGenerationException
Description copied from class:JsonGenerator
Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes). This method defaultsNote: because JSON Strings can not contain unescaped linefeeds, if linefeeds are included (as per last argument), they must be escaped. This adds overhead for decoding without improving readability. Alternatively if linefeeds are not included, resulting String value may violate the requirement of base64 RFC which mandates line-length of 76 characters and use of linefeeds. However, all
JsonParser
implementations are required to accept such "long line base64"; as do typical production-level base64 decoders.- Specified by:
writeBinary
in classJsonGenerator
- Parameters:
b64variant
- Base64 variant to use: defines details such as whether padding is used (and if so, using which character); what is the maximum line length before adding linefeed, and also the underlying alphabet to use.- Throws:
java.io.IOException
JsonGenerationException
-
writeBinary
public int writeBinary(Base64Variant b64variant, java.io.InputStream data, int dataLength) throws java.io.IOException, JsonGenerationException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeBinary(Base64Variant,byte[],int,int)
, but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.- Overrides:
writeBinary
in classGeneratorBase
- Parameters:
b64variant
- Base64 variant to usedata
- InputStream to use for reading binary data to write. Will not be closed after successful write operationdataLength
- (optional) number of bytes that will be available; or -1 to be indicate it is not known. If a positive length is given,data
MUST provide at least that many bytes: if not, an exception will be thrown. Note that implementations need not support cases where length is not known in advance; this depends on underlying data format: JSON output does NOT require length, other formats may.- Returns:
- Number of bytes read from
data
and written as binary payload - Throws:
java.io.IOException
JsonGenerationException
-
writeNumber
public void writeNumber(short s) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Overrides:
writeNumber
in classJsonGenerator
- Parameters:
s
- Number value to write- Throws:
java.io.IOException
-
_writeQuotedShort
private final void _writeQuotedShort(short s) throws java.io.IOException
- Throws:
java.io.IOException
-
writeNumber
public void writeNumber(int i) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
i
- Number value to write- Throws:
java.io.IOException
-
_writeQuotedInt
private final void _writeQuotedInt(int i) throws java.io.IOException
- Throws:
java.io.IOException
-
writeNumber
public void writeNumber(long l) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
l
- Number value to write- Throws:
java.io.IOException
-
_writeQuotedLong
private final void _writeQuotedLong(long l) throws java.io.IOException
- Throws:
java.io.IOException
-
writeNumber
public void writeNumber(java.math.BigInteger value) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
value
- Number value to write- Throws:
java.io.IOException
-
writeNumber
public void writeNumber(double d) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
d
- Number value to write- Throws:
java.io.IOException
-
writeNumber
public void writeNumber(float f) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
f
- Number value to write- Throws:
java.io.IOException
-
writeNumber
public void writeNumber(java.math.BigDecimal value) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
value
- Number value to write- Throws:
java.io.IOException
-
writeNumber
public void writeNumber(java.lang.String encodedValue) throws java.io.IOException
Description copied from class:JsonGenerator
Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types. Because numbers are not surrounded by double quotes, regularJsonGenerator.writeString(java.lang.String)
method can not be used; norJsonGenerator.writeRaw(java.lang.String)
because that does not properly handle value separators needed in Array or Object contexts.Note: because of lack of type safety, some generator implementations may not be able to implement this method. For example, if a binary JSON format is used, it may require type information for encoding; similarly for generator-wrappers around Java objects or JSON nodes. If implementation does not implement this method, it needs to throw
UnsupportedOperationException
.- Specified by:
writeNumber
in classJsonGenerator
- Throws:
java.io.IOException
-
writeNumber
public void writeNumber(char[] encodedValueBuffer, int offset, int length) throws java.io.IOException
Description copied from class:JsonGenerator
Overloaded version ofJsonGenerator.writeNumber(String)
with same semantics but possibly more efficient operation.- Overrides:
writeNumber
in classJsonGenerator
- Throws:
java.io.IOException
-
_writeQuotedRaw
private final void _writeQuotedRaw(java.lang.String value) throws java.io.IOException
- Throws:
java.io.IOException
-
_writeQuotedRaw
private void _writeQuotedRaw(char[] text, int offset, int length) throws java.io.IOException
- Throws:
java.io.IOException
-
writeBoolean
public void writeBoolean(boolean state) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting literal JSON boolean value (one of Strings 'true' and 'false'). Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeBoolean
in classJsonGenerator
- Throws:
java.io.IOException
-
writeNull
public void writeNull() throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting literal JSON null value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNull
in classJsonGenerator
- Throws:
java.io.IOException
-
_verifyValueWrite
protected final void _verifyValueWrite(java.lang.String typeMsg) throws java.io.IOException
Description copied from class:GeneratorBase
Method called before trying to write a value (scalar or structured), to verify that this is legal in current output state, as well as to output separators if and as necessary.- Specified by:
_verifyValueWrite
in classGeneratorBase
- Parameters:
typeMsg
- Additional message used for generating exception message if value output is NOT legal in current generator output state.- Throws:
java.io.IOException
-
flush
public void flush() throws java.io.IOException
Description copied from class:JsonGenerator
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.- Specified by:
flush
in interfacejava.io.Flushable
- Specified by:
flush
in classGeneratorBase
- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException
Description copied from class:JsonGenerator
Method called to close this generator, so that no more content can be written.Whether the underlying target (stream, writer) gets closed depends on whether this generator either manages the target (i.e. is the only one with access to the target -- case if caller passes a reference to the resource such as File, but not stream); or has feature
JsonGenerator.Feature.AUTO_CLOSE_TARGET
enabled. If either of above is true, the target is also closed. Otherwise (not managing, feature not enabled), target is not closed.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classGeneratorBase
- Throws:
java.io.IOException
-
_releaseBuffers
protected void _releaseBuffers()
Description copied from class:GeneratorBase
Method called to release any buffers generator may be holding, once generator is being closed.- Specified by:
_releaseBuffers
in classGeneratorBase
-
_writeBytes
private final void _writeBytes(byte[] bytes) throws java.io.IOException
- Throws:
java.io.IOException
-
_writeBytes
private final void _writeBytes(byte[] bytes, int offset, int len) throws java.io.IOException
- Throws:
java.io.IOException
-
_writeStringSegments
private final void _writeStringSegments(java.lang.String text, boolean addQuotes) throws java.io.IOException
Method called when String to write is long enough not to fit completely in temporary copy buffer. If so, we will actually copy it in small enough chunks so it can be directly fed to single-segment writes (instead of maximum slices that would fit in copy buffer)- Throws:
java.io.IOException
-
_writeStringSegments
private final void _writeStringSegments(char[] cbuf, int offset, int totalLen) throws java.io.IOException
Method called when character sequence to write is long enough that its maximum encoded and escaped form is not guaranteed to fit in the output buffer. If so, we will need to choose smaller output chunks to write at a time.- Throws:
java.io.IOException
-
_writeStringSegments
private final void _writeStringSegments(java.lang.String text, int offset, int totalLen) throws java.io.IOException
- Throws:
java.io.IOException
-
_writeStringSegment
private final void _writeStringSegment(char[] cbuf, int offset, int len) throws java.io.IOException
This method called when the string content is already in a char buffer, and its maximum total encoded and escaped length can not exceed size of the output buffer. Caller must ensure that there is enough space in output buffer, assuming case of all non-escaped ASCII characters, as well as potentially enough space for other cases (but not necessarily flushed)- Throws:
java.io.IOException
-
_writeStringSegment
private final void _writeStringSegment(java.lang.String text, int offset, int len) throws java.io.IOException
- Throws:
java.io.IOException
-
_writeStringSegment2
private final void _writeStringSegment2(char[] cbuf, int offset, int end) throws java.io.IOException
Secondary method called when content contains characters to escape, and/or multi-byte UTF-8 characters.- Throws:
java.io.IOException
-
_writeStringSegment2
private final void _writeStringSegment2(java.lang.String text, int offset, int end) throws java.io.IOException
- Throws:
java.io.IOException
-
_writeStringSegmentASCII2
private final void _writeStringSegmentASCII2(char[] cbuf, int offset, int end) throws java.io.IOException
Same as_writeStringSegment2(char[], ...)
- Throws:
java.io.IOException
-
_writeStringSegmentASCII2
private final void _writeStringSegmentASCII2(java.lang.String text, int offset, int end) throws java.io.IOException
- Throws:
java.io.IOException
-
_writeCustomStringSegment2
private final void _writeCustomStringSegment2(char[] cbuf, int offset, int end) throws java.io.IOException
Same as_writeStringSegmentASCII2(char[], ...)
- Throws:
java.io.IOException
-
_writeCustomStringSegment2
private final void _writeCustomStringSegment2(java.lang.String text, int offset, int end) throws java.io.IOException
- Throws:
java.io.IOException
-
_writeCustomEscape
private final int _writeCustomEscape(byte[] outputBuffer, int outputPtr, SerializableString esc, int remainingChars) throws java.io.IOException, JsonGenerationException
- Throws:
java.io.IOException
JsonGenerationException
-
_handleLongCustomEscape
private final int _handleLongCustomEscape(byte[] outputBuffer, int outputPtr, int outputEnd, byte[] raw, int remainingChars) throws java.io.IOException, JsonGenerationException
- Throws:
java.io.IOException
JsonGenerationException
-
_writeUTF8Segments
private final void _writeUTF8Segments(byte[] utf8, int offset, int totalLen) throws java.io.IOException, JsonGenerationException
Method called when UTF-8 encoded (but NOT yet escaped!) content is not guaranteed to fit in the output buffer after escaping; as such, we just need to chunk writes.- Throws:
java.io.IOException
JsonGenerationException
-
_writeUTF8Segment
private final void _writeUTF8Segment(byte[] utf8, int offset, int len) throws java.io.IOException, JsonGenerationException
- Throws:
java.io.IOException
JsonGenerationException
-
_writeUTF8Segment2
private final void _writeUTF8Segment2(byte[] utf8, int offset, int len) throws java.io.IOException, JsonGenerationException
- Throws:
java.io.IOException
JsonGenerationException
-
_writeBinary
protected final void _writeBinary(Base64Variant b64variant, byte[] input, int inputPtr, int inputEnd) throws java.io.IOException, JsonGenerationException
- Throws:
java.io.IOException
JsonGenerationException
-
_writeBinary
protected final int _writeBinary(Base64Variant b64variant, java.io.InputStream data, byte[] readBuffer, int bytesLeft) throws java.io.IOException, JsonGenerationException
- Throws:
java.io.IOException
JsonGenerationException
-
_writeBinary
protected final int _writeBinary(Base64Variant b64variant, java.io.InputStream data, byte[] readBuffer) throws java.io.IOException, JsonGenerationException
- Throws:
java.io.IOException
JsonGenerationException
-
_readMore
private final int _readMore(java.io.InputStream in, byte[] readBuffer, int inputPtr, int inputEnd, int maxRead) throws java.io.IOException
- Throws:
java.io.IOException
-
_outputRawMultiByteChar
private final int _outputRawMultiByteChar(int ch, char[] cbuf, int inputOffset, int inputEnd) throws java.io.IOException
Method called to output a character that is beyond range of 1- and 2-byte UTF-8 encodings, when outputting "raw" text (meaning it is not to be escaped or quoted)- Throws:
java.io.IOException
-
_outputSurrogates
protected final void _outputSurrogates(int surr1, int surr2) throws java.io.IOException
- Throws:
java.io.IOException
-
_outputMultiByteChar
private final int _outputMultiByteChar(int ch, int outputPtr) throws java.io.IOException
- Parameters:
ch
-outputPtr
- Position within output buffer to append multi-byte in- Returns:
- New output position after appending
- Throws:
java.io.IOException
-
_writeNull
private final void _writeNull() throws java.io.IOException
- Throws:
java.io.IOException
-
_writeGenericEscape
private int _writeGenericEscape(int charToEscape, int outputPtr) throws java.io.IOException
Method called to write a generic Unicode escape for given character.- Parameters:
charToEscape
- Character to escape using escape sequence (\\uXXXX)- Throws:
java.io.IOException
-
_flushBuffer
protected final void _flushBuffer() throws java.io.IOException
- Throws:
java.io.IOException
-
-