Class UTF8JsonGenerator
- All Implemented Interfaces:
Closeable, Flushable, AutoCloseable, Versioned
-
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 final 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 JsonGeneratorBase
_cfgNumbersAsStrings, _cfgUnqNames, _cfgWriteHexUppercase, _characterEscapes, _formatWriteFeatures, _maximumNonEscapedChar, _outputEscapes, _prettyPrinter, _rootValueSeparator, _streamWriteContext, DEFAULT_OUTPUT_ESCAPESFields inherited from class GeneratorBase
_closed, _ioContext, _objectWriteContext, _streamWriteConstraints, _streamWriteFeatures, DEFAULT_BINARY_WRITE_CAPABILITIES, DEFAULT_TEXTUAL_WRITE_CAPABILITIES, DEFAULT_WRITE_CAPABILITIES, MAX_BIG_DECIMAL_SCALE, SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST, WRITE_BINARY, WRITE_BOOLEAN, WRITE_NULL, WRITE_NUMBER, WRITE_RAW, WRITE_STRING -
Constructor Summary
ConstructorsConstructorDescriptionUTF8JsonGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, int streamWriteFeatures, int formatWriteFeatures, OutputStream out, SerializableString rootValueSep, CharacterEscapes charEsc, PrettyPrinter pp, int maxNonEscaped, char quoteChar) UTF8JsonGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, int streamWriteFeatures, int formatWriteFeatures, OutputStream out, SerializableString rootValueSep, CharacterEscapes charEsc, PrettyPrinter pp, int maxNonEscaped, char quoteChar, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidprotected final voidprivate final int_handleLongCustomEscape(byte[] outputBuffer, int outputPtr, int outputEnd, byte[] raw, int remainingChars) private static boolean_isEndOfSurrogatePair(int ch) 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 void_writePPName(String name) protected final voidprivate 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 cannot 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.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[]Method for defining custom escapes factory uses forJsonGenerators it creates.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.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).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.writeBoolean(boolean state) Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).Method for writing an Object Property name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.writeName(SerializableString name) Method similar toJsonGenerator.writeName(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.Method for outputting literal JSON null value.writeNumber(char[] encodedValueBuffer, int offset, int length) Overloaded version ofJsonGenerator.writeNumber(String)with same semantics but possibly more efficient operation.writeNumber(double d) Method for outputting indicate JSON numeric value.writeNumber(float f) Method for outputting indicate JSON numeric value.writeNumber(int i) Method for outputting given value as JSON number.writeNumber(long l) Method for outputting given value as JSON number.writeNumber(short s) Method for outputting given value as JSON number.writeNumber(String encodedValue) Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types; or, for special formatting with formats that allow this (CSV).writeNumber(BigDecimal value) Method for outputting indicate JSON numeric value.writeNumber(BigInteger value) Method for outputting given value as JSON number.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).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).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).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).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).writeRawUTF8String(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).Method similar toJsonGenerator.writeRawValue(String), but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.writeRaw(SerializableString).Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).writeStartArray(Object forValue) Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray(), but also specifying what is the Java object that the Array Object being written represents (if any);nullmay be passed if not known or not applicable.writeStartArray(Object forValue, int len) Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray(), but also specifying what is the Java object that the Array Object being written represents (if any) and how many elements will be written for the array before callingJsonGenerator.writeEndArray().Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).writeStartObject(Object forValue) Method for writing starting marker of an Object value to represent the given Java Object value.writeStartObject(Object forValue, int size) Method for writing starting marker of an Object value to represent the given Java Object value.writeString(char[] text, int offset, int len) Method for outputting a String value.writeString(Reader reader, int len) Method for outputting a String value.writeString(String text) Method for outputting a String value.Method 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.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 JsonGeneratorBase
_reportCantWriteValueExpectName, _verifyPrettyValueWrite, assignCurrentValue, currentValue, getCharacterEscapes, getHighestNonEscapedChar, getPrettyPrinter, has, isEnabled, streamWriteCapabilities, streamWriteContext, version, writePropertyIdMethods inherited from class GeneratorBase
_asString, _checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _checkRangeBoundsForString, _constructDefaultPrettyPrinter, _decodeSurrogate, _throwInternal, close, configure, ioContext, isClosed, isEnabled, objectWriteContext, streamWriteConstraints, streamWriteFeatures, writePOJO, writeRawValue, writeRawValue, writeRawValue, writeTreeMethods inherited from class JsonGenerator
_constructWriteException, _constructWriteException, _constructWriteException, _constructWriteException, _copyCurrentContents, _copyCurrentContentsExact, _copyCurrentFloatValue, _copyCurrentFloatValueExact, _copyCurrentIntValue, _copyCurrentStringValue, _reportArgumentError, _reportError, _reportUnsupportedOperation, _reportUnsupportedOperation, _verifyOffsets, _wrapIOFailure, _writeTypePrefixUsingNative, _writeTypePrefixUsingWrapper, canOmitProperties, canWriteObjectId, canWriteTypeId, copyCurrentEvent, copyCurrentEventExact, copyCurrentStructure, copyCurrentStructureExact, getSchema, writeArray, writeArray, writeArray, writeArray, writeArrayPropertyStart, writeBinary, writeBinary, writeBinary, writeBinaryProperty, writeBooleanProperty, writeEmbeddedObject, writeNullProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeObjectId, writeObjectPropertyStart, writeObjectRef, writeOmittedProperty, writePOJOProperty, writeStringProperty, 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 final byte _quoteCharCharacter used for quoting JSON Object property names and String values. -
_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(ObjectWriteContext writeCtxt, IOContext ioCtxt, int streamWriteFeatures, int formatWriteFeatures, OutputStream out, SerializableString rootValueSep, CharacterEscapes charEsc, PrettyPrinter pp, int maxNonEscaped, char quoteChar) -
UTF8JsonGenerator
public UTF8JsonGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, int streamWriteFeatures, int formatWriteFeatures, OutputStream out, SerializableString rootValueSep, CharacterEscapes charEsc, PrettyPrinter pp, int maxNonEscaped, char quoteChar, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable)
-
-
Method Details
-
setCharacterEscapes
Description copied from class:JsonGeneratorMethod for defining custom escapes factory uses forJsonGenerators it creates.Default implementation does nothing and simply returns this instance.
- Specified by:
setCharacterEscapesin classJsonGeneratorBase- Parameters:
esc-CharacterEscapesto configure this generator to use, if any;nullif none- Returns:
- This generator, to allow call chaining
-
streamWriteOutputTarget
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.
NOTE: was named
getOutputTarget()in Jackson 2.x.- Specified by:
streamWriteOutputTargetin classJsonGenerator- Returns:
- Output target this generator was configured with
-
streamWriteOutputBuffered
public int streamWriteOutputBuffered()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,byteforOutputStream,charforWriter), but may differ if buffering is done before encoding. Default JSON-backed implementations do use matching units.NOTE: was named
getOutputBuffered()in Jackson 2.x.- Specified by:
streamWriteOutputBufferedin classJsonGenerator- Returns:
- Amount of content buffered in internal units, if amount known and accessible; -1 if not accessible.
-
writeName
Description copied from class:JsonGeneratorMethod for writing an Object Property name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.Property names can only be written in Object context (check out JSON specification for details), when Object Property name is expected (property names alternate with values).
- Specified by:
writeNamein classJsonGenerator- Parameters:
name- Name of the Object Property to write- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
writeName
Description copied from class:JsonGeneratorMethod similar toJsonGenerator.writeName(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:
writeNamein classGeneratorBase- Parameters:
name- Pre-encoded name of the Object Property to write- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
_writeUnq
- Throws:
JacksonException
-
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 property name is expected.
- Specified by:
writeStartArrayin classJsonGenerator- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
writeStartArray
Description copied from class:JsonGeneratorMethod for writing start marker of an Array value, similar toJsonGenerator.writeStartArray(), but also specifying what is the Java object that the Array Object being written represents (if any);nullmay be passed if not known or not applicable. This value is accessible from context as "current value"- Specified by:
writeStartArrayin classJsonGenerator- Parameters:
forValue- Java Object that Array being written represents, if any (ornullif not known or not applicable)- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
writeStartArray
Description copied from class:JsonGeneratorMethod for writing start marker of an Array value, similar toJsonGenerator.writeStartArray(), but also specifying what is the Java object that the Array Object being written represents (if any) and how many elements will be written for the array before callingJsonGenerator.writeEndArray().- Overrides:
writeStartArrayin classJsonGeneratorBase- Parameters:
forValue- Java Object that Array being written represents, if any (ornullif not known or not applicable)len- 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)- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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 property name is expected.
- Specified by:
writeStartObjectin classJsonGenerator- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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 property name is expected.
- Specified by:
writeStartObjectin classJsonGenerator- Parameters:
forValue- Java Object that Object being written represents, if any (ornullif not known or not applicable)- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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 property name is expected.
- Overrides:
writeStartObjectin classJsonGeneratorBase- Parameters:
forValue- Object value to be written (assigned as "current value" for the Object context that gets created)size- 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)- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
_writePPName
- Throws:
JacksonException
-
_writePPName
- Throws:
JacksonException
-
writeString
Description copied from class:JsonGeneratorMethod for outputting a String value. Depending on context this means either array element, (object) property value or a stand-alone (root-level value) 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- String value to write- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
writeString
Description copied from class:JsonGeneratorMethod for outputting a String value. Depending on context this means either array element, (object) property 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 cannot be less than it: if not enough content available, aStreamWriteExceptionwill be thrown.- Overrides:
writeStringin classGeneratorBase- 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"- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
writeString
Description copied from class:JsonGeneratorMethod for outputting a String value. Depending on context this means either array element, (object) property 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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.- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
_writeSegmentedRaw
Helper method called when it is possible that output of raw section to output may cross buffer boundary- Throws:
JacksonException
-
_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 cannot be first part of a surrogate char pair).- Throws:
JacksonException
-
writeBinary
public JsonGenerator writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws JacksonException 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 cannot 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
writeBinary
public int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws JacksonException 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:
JacksonException
-
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 property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumberin classJsonGenerator- Parameters:
s- Number value to write- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
_writeQuotedShort
- Throws:
JacksonException
-
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 property 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
_writeQuotedInt
- Throws:
JacksonException
-
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 property 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
_writeQuotedLong
- Throws:
JacksonException
-
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 property 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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 property 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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 property 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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 property 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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; or, for special formatting with formats that allow this (CSV). Because numbers are not surrounded by double quotes, regularJsonGenerator.writeString(String)method cannot be used; norJsonGenerator.writeRaw(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 will not be able to implement this method. For example, some binary formats require type information for encoding; similarly for generator-wrappers around Java objects or
TreeNodes. If implementation does not implement this method, it should aStreamWriteException).- Specified by:
writeNumberin classJsonGenerator- Parameters:
encodedValue- Textual (possibly formatted) number representation to write- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
writeNumber
public JsonGenerator writeNumber(char[] encodedValueBuffer, int offset, int length) throws JacksonException 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
_writeQuotedRaw
- Throws:
JacksonException
-
_writeQuotedRaw
- Throws:
JacksonException
-
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 property 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- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
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 property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNullin classJsonGenerator- Returns:
- This generator, to allow call chaining
- Throws:
JacksonException
-
_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:
JacksonException- if there is a problem in trying to write a value
-
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 classJsonGenerator- Throws:
JacksonException
-
_closeInput
- Specified by:
_closeInputin classGeneratorBase- Throws:
JacksonException
-
_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:
JacksonException
-
_writeBytes
- Throws:
JacksonException
-
_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:
JacksonException
-
_writeStringSegments
private final void _writeStringSegments(char[] cbuf, int offset, int totalLen) throws JacksonException 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:
JacksonException
-
_writeStringSegments
private final void _writeStringSegments(String text, int offset, int totalLen) throws JacksonException - Throws:
JacksonException
-
_writeStringSegment
This method called when the string content is already in a char buffer, and its maximum total encoded and escaped length cannot 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:
JacksonException
-
_writeStringSegment
- Throws:
JacksonException
-
_writeStringSegment2
Secondary method called when content contains characters to escape, and/or multi-byte UTF-8 characters.- Throws:
JacksonException
-
_writeStringSegment2
- Throws:
JacksonException
-
_writeStringSegmentASCII2
private final void _writeStringSegmentASCII2(char[] cbuf, int offset, int end) throws JacksonException Same as_writeStringSegment2(char[], ...)invalid input: '<'/code., but with additional escaping for high-range code points- Throws:
JacksonException
-
_writeStringSegmentASCII2
private final void _writeStringSegmentASCII2(String text, int offset, int end) throws JacksonException - Throws:
JacksonException
-
_writeCustomStringSegment2
private final void _writeCustomStringSegment2(char[] cbuf, int offset, int end) throws JacksonException Same as_writeStringSegmentASCII2(char[], ...)invalid input: '<'/code., but with additional checking for completely custom escapes- Throws:
JacksonException
-
_writeCustomStringSegment2
private final void _writeCustomStringSegment2(String text, int offset, int end) throws JacksonException - Throws:
JacksonException
-
_writeCustomEscape
private final int _writeCustomEscape(byte[] outputBuffer, int outputPtr, SerializableString esc, int remainingChars) throws JacksonException - Throws:
JacksonException
-
_handleLongCustomEscape
private final int _handleLongCustomEscape(byte[] outputBuffer, int outputPtr, int outputEnd, byte[] raw, int remainingChars) throws JacksonException - Throws:
JacksonException
-
_writeUTF8Segments
private final void _writeUTF8Segments(byte[] utf8, int offset, int totalLen) throws JacksonException 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:
JacksonException
-
_writeUTF8Segment
- Throws:
JacksonException
-
_writeUTF8Segment2
- Throws:
JacksonException
-
_writeBinary
protected final void _writeBinary(Base64Variant b64variant, byte[] input, int inputPtr, int inputEnd) throws JacksonException - Throws:
JacksonException
-
_writeBinary
protected final int _writeBinary(Base64Variant b64variant, InputStream data, byte[] readBuffer, int bytesLeft) throws JacksonException - Throws:
JacksonException
-
_writeBinary
protected final int _writeBinary(Base64Variant b64variant, InputStream data, byte[] readBuffer) throws JacksonException - Throws:
JacksonException
-
_readMore
private final int _readMore(InputStream in, byte[] readBuffer, int inputPtr, int inputEnd, int maxRead) throws JacksonException - Throws:
JacksonException
-
_outputRawMultiByteChar
private final int _outputRawMultiByteChar(int ch, char[] cbuf, int inputOffset, int inputEnd) throws JacksonException 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:
JacksonException
-
_outputSurrogates
- Throws:
JacksonException
-
_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:
JacksonException
-
_writeNull
- Throws:
JacksonException
-
_writeGenericEscape
Method called to write a generic Unicode escape for given character.- Parameters:
charToEscape- Character to escape using escape sequence (\\uXXXX)- Throws:
JacksonException
-
_flushBuffer
- Throws:
JacksonException
-
getHexBytes
private byte[] getHexBytes() -
_isStartOfSurrogatePair
private static boolean _isStartOfSurrogatePair(int ch) -
_isEndOfSurrogatePair
private static boolean _isEndOfSurrogatePair(int ch)
-