Class UTF8JsonGenerator
- All Implemented Interfaces:
Versioned,Closeable,Flushable,AutoCloseable
-
Nested Class Summary
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonGenerator
JsonGenerator.Feature -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanFlag that indicates whether the output buffer is recycable (and needs to be returned to recycler once we are done) or not.protected char[]Intermediate buffer in which characters of a String are copied before being encoded.protected final intLength of_charBufferprotected byte[]6 character temporary buffer allocated if needed, for constructing escape sequencesprotected byte[]Intermediate buffer in which contents are buffered before being written using_outputStream.protected final intEnd marker of the output buffer; one past the last valid position within the buffer.protected final intMaximum number ofchars that we know will always fit in the output buffer after escapingprotected final OutputStreamUnderlying output stream used for writing JSON content.protected intPointer to the position right beyond the last character to output (end marker; may be past the buffer)protected byteCharacter used for quoting JSON Object property names and String values.private static final byteprivate static final byteprivate static final byteprivate static final byteprivate static final byteprivate static final byteprivate static final byteprivate static final byteprivate static final byteprivate static final byte[]private static final byte[]private static final byte[]private static final intprivate static final byte[]private static final byte[]Fields inherited from class com.fasterxml.jackson.core.json.JsonGeneratorImpl
_cfgUnqNames, _cfgWriteHexUppercase, _characterEscapes, _maximumNonEscapedChar, _outputEscapes, _rootValueSeparator, _streamWriteConstraints, JSON_WRITE_CAPABILITIES, sOutputEscapesFields inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_cfgNumbersAsStrings, _closed, _features, _ioContext, _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_STRINGFields inherited from class com.fasterxml.jackson.core.JsonGenerator
_cfgPrettyPrinter, DEFAULT_BINARY_WRITE_CAPABILITIES, DEFAULT_TEXTUAL_WRITE_CAPABILITIES, DEFAULT_WRITE_CAPABILITIES -
Constructor Summary
ConstructorsConstructorDescriptionUTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out) Deprecated.UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable) Deprecated.UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out, char quoteChar) UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out, char quoteChar, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable) -
Method Summary
Modifier and TypeMethodDescriptionprotected final voidprivate final int_handleLongCustomEscape(byte[] outputBuffer, int outputPtr, int outputEnd, byte[] raw, int remainingChars) private static boolean_isStartOfSurrogatePair(int ch) private final int_outputMultiByteChar(int ch, int outputPtr) private final 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)private int_outputSurrogatePair(char highSurrogate, char lowSurrogate, int outputPtr) protected final void_outputSurrogates(int surr1, int surr2) private final int_readMore(InputStream in, byte[] readBuffer, int inputPtr, int inputEnd, int maxRead) protected voidMethod called to release any buffers generator may be holding, once generator is being closed.protected final void_verifyValueWrite(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 final void_writeBinary(Base64Variant b64variant, byte[] input, int inputPtr, int inputEnd) protected final int_writeBinary(Base64Variant b64variant, InputStream data, byte[] readBuffer) protected final int_writeBinary(Base64Variant b64variant, InputStream data, byte[] readBuffer, int bytesLeft) private final void_writeBytes(byte[] bytes) private final void_writeBytes(byte[] bytes, int offset, int len) private final int_writeCustomEscape(byte[] outputBuffer, int outputPtr, SerializableString esc, int remainingChars) private final void_writeCustomStringSegment2(char[] cbuf, int offset, int end) Same as_writeStringSegmentASCII2(char[], ...)invalid input: '<'/code., but with additional checking for completely custom escapesprivate final void_writeCustomStringSegment2(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 final voidprotected final voidprotected final void_writePPFieldName(String name) private final void_writeQuotedInt(int i) private final void_writeQuotedLong(long l) private void_writeQuotedRaw(char[] text, int offset, int length) private final void_writeQuotedRaw(String value) private final 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 final 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 final 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 final void_writeStringSegment(String text, int offset, int len) private final 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 final void_writeStringSegment2(String text, int offset, int end) private final void_writeStringSegmentASCII2(char[] cbuf, int offset, int end) Same as_writeStringSegment2(char[], ...)invalid input: '<'/code., but with additional escaping for high-range code pointsprivate final void_writeStringSegmentASCII2(String text, int offset, int end) private final 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 final void_writeStringSegments(String text, boolean addQuotes) Method called when String to write is long enough not to fit completely in temporary copy buffer.private final void_writeStringSegments(String text, int offset, int totalLen) private final void_writeUnq(SerializableString name) private final void_writeUTF8Segment(byte[] utf8, int offset, int len) private final void_writeUTF8Segment2(byte[] utf8, int offset, int len) private final 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.voidclose()Method called to close this generator, so that no more content can be written.voidflush()Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.private byte[]intMethod 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.Method that can be used to get access to object that is used as target for generated output; this is usually eitherOutputStreamorWriter, depending on what generator was constructed with.voidwriteBinary(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).intwriteBinary(Base64Variant b64variant, 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.voidwriteBoolean(boolean state) Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').final voidMethod for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).final voidMethod for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).voidMethod 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.voidwriteFieldName(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.voidMethod for outputting literal JSON null value.voidwriteNumber(char[] encodedValueBuffer, int offset, int length) Overloaded version ofJsonGenerator.writeNumber(String)with same semantics but possibly more efficient operation.voidwriteNumber(double d) Method for outputting indicate JSON numeric value.voidwriteNumber(float f) Method for outputting indicate JSON numeric value.voidwriteNumber(int i) Method for outputting given value as JSON number.voidwriteNumber(long l) Method for outputting given value as JSON number.voidwriteNumber(short s) Method for outputting given value as JSON number.voidwriteNumber(String encodedValue) Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types.voidwriteNumber(BigDecimal value) Method for outputting indicate JSON numeric value.voidwriteNumber(BigInteger value) Method for outputting given value as JSON number.voidwriteRaw(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).final voidwriteRaw(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).voidwriteRaw(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).voidMethod 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).voidMethod 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).voidwriteRawUTF8String(byte[] text, int offset, int len) 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).voidMethod similar toJsonGenerator.writeRawValue(String), but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.writeRaw(SerializableString).final voidMethod for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).final voidwriteStartArray(Object currentValue) Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray(), but also specifying the "current value" to assign to the new Array context being created.voidwriteStartArray(Object currentValue, int size) Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray(), but also specifying the "current value" to assign to the new Array context being created as well as how many elements will be written for the array before callingJsonGenerator.writeEndArray().final voidMethod for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).voidwriteStartObject(Object forValue) Method for writing starting marker of an Object value to represent the given Java Object value.voidwriteStartObject(Object forValue, int size) Method for writing starting marker of an Object value to represent the given Java Object value.voidwriteString(char[] text, int offset, int len) Method for outputting a String value.final voidMethod similar toJsonGenerator.writeString(String), but that takesSerializableStringwhich can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.voidwriteString(Reader reader, int len) Method for outputting a String value.voidwriteString(String text) Method for outputting a String value.voidwriteUTF8String(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, getWriteCapabilities, setCharacterEscapes, setHighestNonEscapedChar, setRootValueSeparator, streamWriteConstraints, versionMethods inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_asString, _checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _checkRangeBoundsForString, _constructDefaultPrettyPrinter, _decodeSurrogate, assignCurrentValue, currentValue, getCodec, getFeatureMask, getOutputContext, ioContext, isClosed, isEnabled, overrideStdFeatures, setCodec, setFeatureMask, useDefaultPrettyPrinter, writeObject, writeRawValue, writeRawValue, writeRawValue, writeTreeMethods inherited from class com.fasterxml.jackson.core.JsonGenerator
_constructWriteException, _constructWriteException, _constructWriteException, _constructWriteException, _copyCurrentContents, _copyCurrentFloatValue, _copyCurrentFloatValueExact, _copyCurrentIntValue, _copyCurrentStringValue, _reportError, _reportUnsupportedOperation, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteFormattedNumbers, canWriteObjectId, canWriteTypeId, configure, copyCurrentEvent, copyCurrentEventExact, copyCurrentStructure, getCurrentValue, getFormatFeatures, getPrettyPrinter, getSchema, isEnabled, overrideFormatFeatures, setCurrentValue, 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, writePOJO, writePOJOField, writeStartArray, writeStringField, writeTypeId, writeTypePrefix, writeTypeSuffix
-
Field Details
-
BYTE_u
private static final byte BYTE_u- See Also:
-
BYTE_0
private static final byte BYTE_0- See Also:
-
BYTE_LBRACKET
private static final byte BYTE_LBRACKET- See Also:
-
BYTE_RBRACKET
private static final byte BYTE_RBRACKET- See Also:
-
BYTE_LCURLY
private static final byte BYTE_LCURLY- See Also:
-
BYTE_RCURLY
private static final byte BYTE_RCURLY- See Also:
-
BYTE_BACKSLASH
private static final byte BYTE_BACKSLASH- See Also:
-
BYTE_COMMA
private static final byte BYTE_COMMA- See Also:
-
BYTE_COLON
private static final byte BYTE_COLON- See Also:
-
MAX_BYTES_TO_BUFFER
private static final int MAX_BYTES_TO_BUFFER- See Also:
-
HEX_BYTES_UPPER
private static final byte[] HEX_BYTES_UPPER -
HEX_BYTES_LOWER
private static final byte[] HEX_BYTES_LOWER -
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
Underlying output stream used for writing JSON content. -
_quoteChar
protected byte _quoteCharCharacter used for quoting JSON Object property names and String values.- Since:
- 2.8
-
_outputBuffer
protected byte[] _outputBufferIntermediate buffer in which contents are buffered before being written using_outputStream. -
_outputTail
protected int _outputTailPointer to the position right beyond the last character to output (end marker; may be past the buffer) -
_outputEnd
protected final int _outputEndEnd marker of the output buffer; one past the last valid position within the buffer. -
_outputMaxContiguous
protected final int _outputMaxContiguousMaximum number ofchars that we know will always fit in the output buffer after escaping -
_charBuffer
protected char[] _charBufferIntermediate buffer in which characters of a String are copied before being encoded. -
_charBufferLength
protected final int _charBufferLengthLength of_charBuffer -
_entityBuffer
protected byte[] _entityBuffer6 character temporary buffer allocated if needed, for constructing escape sequences -
_bufferRecyclable
protected boolean _bufferRecyclableFlag that indicates whether the output buffer is recycable (and needs to be returned to recycler once we are done) or not.
-
-
Constructor Details
-
UTF8JsonGenerator
public UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out, char quoteChar) -
UTF8JsonGenerator
public UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out, char quoteChar, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable) -
UTF8JsonGenerator
@Deprecated public UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out) Deprecated. -
UTF8JsonGenerator
@Deprecated public UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable) Deprecated.
-
-
Method Details
-
getOutputTarget
Description copied from class:JsonGeneratorMethod that can be used to get access to object that is used as target for generated output; this is usually eitherOutputStreamorWriter, 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:
getOutputTargetin classJsonGenerator- Returns:
- Output target this generator was configured with
-
getOutputBuffered
public int getOutputBuffered()Description copied from class:JsonGeneratorMethod 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:
getOutputBufferedin classJsonGenerator- Returns:
- Amount of content buffered in internal units, if amount known and accessible; -1 if not accessible.
-
writeFieldName
Description copied from class:JsonGeneratorMethod 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:
writeFieldNamein classJsonGenerator- Parameters:
name- Field name to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeFieldName
Description copied from class:JsonGeneratorMethod 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:
writeFieldNamein classGeneratorBase- Parameters:
name- Field name to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
_writeUnq
- Throws:
IOException
-
writeStartArray
Description copied from class:JsonGeneratorMethod 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:
writeStartArrayin classJsonGenerator- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartArray
Description copied from class:JsonGeneratorMethod for writing start marker of an Array value, similar toJsonGenerator.writeStartArray(), but also specifying the "current value" to assign to the new Array context being created.- Overrides:
writeStartArrayin classJsonGenerator- Parameters:
currentValue- "Current value" to assign for the Array context being created- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartArray
Description copied from class:JsonGeneratorMethod for writing start marker of an Array value, similar toJsonGenerator.writeStartArray(), but also specifying the "current value" to assign to the new Array context being created as well as how many elements will be written for the array before callingJsonGenerator.writeEndArray().- Overrides:
writeStartArrayin classJsonGenerator- Parameters:
currentValue- "Current value" to assign for the Array context being createdsize- 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 (and SHOULD if format itself encodes length)- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeEndArray
Description copied from class:JsonGeneratorMethod 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:
writeEndArrayin classJsonGenerator- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartObject
Description copied from class:JsonGeneratorMethod 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:
writeStartObjectin classJsonGenerator- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartObject
Description copied from class:JsonGeneratorMethod 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:
writeStartObjectin classGeneratorBase- Parameters:
forValue- "Current value" to assign for the Object context being created- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartObject
Description copied from class:JsonGeneratorMethod 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. In addition, caller knows number of key/value pairs ("properties") that will get written for the Object value: this is relevant for some format backends (but not, as an example, for JSON).Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
- Overrides:
writeStartObjectin classJsonGenerator- Parameters:
forValue- "Current value" to assign for the Object context being createdsize- Number of key/value pairs this Object will have: actual number of entries written (before matching call toJsonGenerator.writeEndObject()MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length)- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeEndObject
Description copied from class:JsonGeneratorMethod 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:
writeEndObjectin classJsonGenerator- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
_writePPFieldName
- Throws:
IOException
-
_writePPFieldName
- Throws:
IOException
-
writeString
Description copied from class:JsonGeneratorMethod 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:
writeStringin classJsonGenerator- Parameters:
text- Text value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
Description copied from class:JsonGeneratorMethod 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. Iflenis < 0, then write all contents of the reader. Otherwise, write only len characters.Note: actual length of content available may exceed
lenbut can not be less than it: if not enough content available, aJsonGenerationExceptionwill be thrown.- Overrides:
writeStringin classJsonGenerator- Parameters:
reader- Reader to use for reading Text value to writelen- Maximum Length of Text value to read (inchars, non-negative) if known;-1to indicate "read and write it all"- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer; or if length (len) is specified butreaderdoes not provide enough content
-
writeString
Description copied from class:JsonGeneratorMethod 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:
writeStringin classJsonGenerator- Parameters:
text- Buffer that contains String value to writeoffset- Offset inbufferof the first character of String value to writelen- Length of the String value (in characters) to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
Description copied from class:JsonGeneratorMethod similar toJsonGenerator.writeString(String), but that takesSerializableStringwhich 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:
writeStringin classGeneratorBase- Parameters:
text- Pre-encoded String value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawUTF8String
Description copied from class:JsonGeneratorMethod 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
Writerusing this method would require UTF-8 decoding. If so, implementation may instead choose to throw aUnsupportedOperationExceptiondue to ineffectiveness of having to decode input.- Specified by:
writeRawUTF8Stringin classJsonGenerator- Parameters:
text- Buffer that contains String value to writeoffset- Offset inbufferof the first byte of String value to writelen- Length of the String value (in characters) to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeUTF8String
Description copied from class:JsonGeneratorMethod 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
Writerusing this method would require UTF-8 decoding. In this case generator implementation may instead choose to throw aUnsupportedOperationExceptiondue to ineffectiveness of having to decode input.- Specified by:
writeUTF8Stringin classJsonGenerator- Parameters:
text- Buffer that contains String value to writeoffset- Offset inbufferof the first byte of String value to writelen- Length of the String value (in characters) to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
Description copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Parameters:
text- Textual contents to include as-is in output.- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
Description copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Parameters:
text- String that has contents to include as-is in outputoffset- Offset withintextof the first character to outputlen- Length of content (fromtext, starting at offsetoffset) to output- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
Description copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Parameters:
text- Pre-encoded textual contents to included in output- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawValue
Description copied from class:JsonGeneratorMethod similar toJsonGenerator.writeRawValue(String), but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.writeRaw(SerializableString).- Overrides:
writeRawValuein classGeneratorBase- Parameters:
text- Pre-encoded textual contents to included in output- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
Description copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Parameters:
cbuf- Buffer that has contents to include as-is in outputoffset- Offset withintextof the first character to outputlen- Length of content (fromtext, starting at offsetoffset) to output- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
Description copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Parameters:
ch- Character to included in output- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
_writeSegmentedRaw
Helper method called when it is possible that output of raw section to output may cross buffer boundary- Throws:
IOException
-
_writeRawSegment
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:
IOException- Since:
- 2.8.2
-
writeBinary
public void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws IOException, JsonGenerationException Description copied from class:JsonGeneratorMethod 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
JsonParserimplementations are required to accept such "long line base64"; as do typical production-level base64 decoders.- Specified by:
writeBinaryin 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.data- Buffer that contains binary data to writeoffset- Offset indataof the first byte of data to writelen- Length of data to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layerJsonGenerationException
-
writeBinary
public int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws IOException, JsonGenerationException Description copied from class:JsonGeneratorMethod 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:
writeBinaryin 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,dataMUST 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
dataand written as binary payload - Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layerJsonGenerationException
-
writeNumber
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Parameters:
s- Number value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
_writeQuotedShort
- Throws:
IOException
-
writeNumber
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Parameters:
i- Number value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
_writeQuotedInt
- Throws:
IOException
-
writeNumber
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Parameters:
l- Number value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
_writeQuotedLong
- Throws:
IOException
-
writeNumber
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Parameters:
value- Number value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Parameters:
d- Number value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Parameters:
f- Number value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Parameters:
value- Number value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
Description copied from class:JsonGeneratorWrite 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:
writeNumberin classJsonGenerator- Parameters:
encodedValue- Textual (possibly formatted) number representation to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
Description copied from class:JsonGeneratorOverloaded version ofJsonGenerator.writeNumber(String)with same semantics but possibly more efficient operation.- Overrides:
writeNumberin classJsonGenerator- Parameters:
encodedValueBuffer- Buffer that contains the textual number representation to writeoffset- Offset of the first character of value to writelength- Length of the value (in characters) to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
_writeQuotedRaw
- Throws:
IOException
-
_writeQuotedRaw
- Throws:
IOException
-
writeBoolean
Description copied from class:JsonGeneratorMethod 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:
writeBooleanin classJsonGenerator- Parameters:
state- Boolean value to write- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNull
Description copied from class:JsonGeneratorMethod 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:
writeNullin classJsonGenerator- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
_verifyValueWrite
Description copied from class:GeneratorBaseMethod 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:
_verifyValueWritein classGeneratorBase- Parameters:
typeMsg- Additional message used for generating exception message if value output is NOT legal in current generator output state.- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
flush
Description copied from class:JsonGeneratorMethod called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.- Specified by:
flushin interfaceFlushable- Specified by:
flushin classGeneratorBase- Throws:
IOException- if there is either an underlying I/O problem or encoding issue at format layer
-
close
Description copied from class:JsonGeneratorMethod 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_TARGETenabled. If either of above is true, the target is also closed. Otherwise (not managing, feature not enabled), target is not closed.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classGeneratorBase- Throws:
IOException- if there is either an underlying I/O problem
-
_releaseBuffers
protected void _releaseBuffers()Description copied from class:GeneratorBaseMethod called to release any buffers generator may be holding, once generator is being closed.- Specified by:
_releaseBuffersin classGeneratorBase
-
_writeBytes
- Throws:
IOException
-
_writeBytes
- Throws:
IOException
-
_writeStringSegments
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:
IOException
-
_writeStringSegments
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:
IOException
-
_writeStringSegments
- Throws:
IOException
-
_writeStringSegment
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:
IOException
-
_writeStringSegment
- Throws:
IOException
-
_writeStringSegment2
Secondary method called when content contains characters to escape, and/or multi-byte UTF-8 characters.- Throws:
IOException
-
_writeStringSegment2
- Throws:
IOException
-
_writeStringSegmentASCII2
Same as_writeStringSegment2(char[], ...)invalid input: '<'/code., but with additional escaping for high-range code points- Throws:
IOException
-
_writeStringSegmentASCII2
- Throws:
IOException
-
_writeCustomStringSegment2
Same as_writeStringSegmentASCII2(char[], ...)invalid input: '<'/code., but with additional checking for completely custom escapes- Throws:
IOException
-
_writeCustomStringSegment2
- Throws:
IOException
-
_writeCustomEscape
private final int _writeCustomEscape(byte[] outputBuffer, int outputPtr, SerializableString esc, int remainingChars) throws IOException, JsonGenerationException - Throws:
IOExceptionJsonGenerationException
-
_handleLongCustomEscape
private final int _handleLongCustomEscape(byte[] outputBuffer, int outputPtr, int outputEnd, byte[] raw, int remainingChars) throws IOException, JsonGenerationException - Throws:
IOExceptionJsonGenerationException
-
_writeUTF8Segments
private final void _writeUTF8Segments(byte[] utf8, int offset, int totalLen) throws 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:
IOExceptionJsonGenerationException
-
_writeUTF8Segment
private final void _writeUTF8Segment(byte[] utf8, int offset, int len) throws IOException, JsonGenerationException - Throws:
IOExceptionJsonGenerationException
-
_writeUTF8Segment2
private final void _writeUTF8Segment2(byte[] utf8, int offset, int len) throws IOException, JsonGenerationException - Throws:
IOExceptionJsonGenerationException
-
_writeBinary
protected final void _writeBinary(Base64Variant b64variant, byte[] input, int inputPtr, int inputEnd) throws IOException, JsonGenerationException - Throws:
IOExceptionJsonGenerationException
-
_writeBinary
protected final int _writeBinary(Base64Variant b64variant, InputStream data, byte[] readBuffer, int bytesLeft) throws IOException, JsonGenerationException - Throws:
IOExceptionJsonGenerationException
-
_writeBinary
protected final int _writeBinary(Base64Variant b64variant, InputStream data, byte[] readBuffer) throws IOException, JsonGenerationException - Throws:
IOExceptionJsonGenerationException
-
_readMore
private final int _readMore(InputStream in, byte[] readBuffer, int inputPtr, int inputEnd, int maxRead) throws IOException - Throws:
IOException
-
_outputRawMultiByteChar
private final int _outputRawMultiByteChar(int ch, char[] cbuf, int inputOffset, int inputEnd) throws 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:
IOException
-
_outputSurrogates
- Throws:
IOException
-
_outputSurrogatePair
private int _outputSurrogatePair(char highSurrogate, char lowSurrogate, int outputPtr) -
_outputMultiByteChar
- Parameters:
ch-outputPtr- Position within output buffer to append multi-byte in- Returns:
- New output position after appending
- Throws:
IOException
-
_writeNull
- Throws:
IOException
-
_writeGenericEscape
Method called to write a generic Unicode escape for given character.- Parameters:
charToEscape- Character to escape using escape sequence (\\uXXXX)- Throws:
IOException
-
_flushBuffer
- Throws:
IOException
-
getHexBytes
private byte[] getHexBytes() -
_isStartOfSurrogatePair
private static boolean _isStartOfSurrogatePair(int ch)
-