java.lang.Object | |||
↳ | com.fasterxml.jackson.core.JsonGenerator | ||
↳ | com.fasterxml.jackson.core.base.GeneratorBase | ||
↳ | com.fasterxml.jackson.core.json.WriterBasedJsonGenerator |
JsonGenerator
that outputs JSON content using a java.io.Writer
which handles character encoding.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | SHORT_WRITE |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
HEX_CHARS | |||||||||||
_characterEscapes | Definition of custom character escapes to use for generators created by this factory, if any. | ||||||||||
_currentEscape | When custom escapes are used, this member variable can be used to store escape to use | ||||||||||
_entityBuffer | Short (14 char) temporary buffer allocated if needed, for constructing escape sequences | ||||||||||
_ioContext | |||||||||||
_maximumNonEscapedChar | Value between 128 (0x80) and 65535 (0xFFFF) that indicates highest Unicode code point that will not need escaping; or 0 to indicate that all characters can be represented without escaping. | ||||||||||
_outputBuffer | Intermediate buffer in which contents are buffered before
being written using _writer . |
||||||||||
_outputEnd | End marker of the output buffer; one past the last valid position within the buffer. | ||||||||||
_outputEscapes | Currently active set of output escape code definitions (whether and how to escape or not) for 7-bit ASCII range (first 128 character codes). | ||||||||||
_outputHead | Pointer to the first buffered character to output | ||||||||||
_outputTail | Pointer to the position right beyond the last character to output (end marker; may point to position right beyond the end of the buffer) | ||||||||||
_writer | |||||||||||
sOutputEscapes | This is the default set of escape codes, over 7-bit ASCII range (first 128 character codes), used for single-byte UTF-8 characters. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.fasterxml.jackson.core.base.GeneratorBase
| |||||||||||
From class
com.fasterxml.jackson.core.JsonGenerator
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method called to close this generator, so that no more content
can be written.
| |||||||||||
Method called to flush any buffered content to the underlying
target (output stream, writer), and to flush the target itself
as well.
| |||||||||||
Method for accessing custom escapes factory uses for
JsonGenerator s
it creates. | |||||||||||
Accessor method for testing what is the highest unescaped character
configured for this generator.
| |||||||||||
Method that can be used to get access to object that is used
as target for generated output; this is usually either
OutputStream or Writer , depending on what
generator was constructed with. | |||||||||||
Method for defining custom escapes factory uses for
JsonGenerator s
it creates. | |||||||||||
Method that can be called to request that generator escapes
all character codes above specified code point (if positive value);
or, to not escape any characters except for ones that must be
escaped for the data format (if -1).
| |||||||||||
Implemented with detection that tries to find "VERSION.txt" in same
package as the implementation class.
| |||||||||||
Method similar to
writeBinary(Base64Variant, byte[], int, int) ,
but where input is provided through a stream, allowing for incremental
writes without holding the whole input in memory. | |||||||||||
Method that will output given chunk of binary data as base64
encoded, as a complete String value (surrounded by double quotes).
| |||||||||||
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 a JSON Object value
(character '}'; plus possible white space decoration
if pretty-printing is enabled).
| |||||||||||
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.
| |||||||||||
Method similar to
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. | |||||||||||
Method for outputting literal Json null value.
| |||||||||||
Method for outputting given value as Json number.
| |||||||||||
Method for outputting given value as Json number.
| |||||||||||
Write method that can be used for custom numeric types that can
not be (easily?) converted to "standard" Java number types.
| |||||||||||
Method for outputting given value as Json number.
| |||||||||||
Method for outputting indicate Json numeric value.
| |||||||||||
Method for outputting indicate Json numeric value.
| |||||||||||
Method for outputting indicate Json numeric value.
| |||||||||||
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).
| |||||||||||
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 similar to
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 for writing starting marker of a JSON Array value
(character '['; plus possible white space decoration
if pretty-printing is enabled).
| |||||||||||
Method for writing starting marker of a JSON Object value
(character '{'; plus possible white space decoration
if pretty-printing is enabled).
| |||||||||||
Method for outputting a String value.
| |||||||||||
Method similar to
writeString(String) , but that takes
SerializableString which can make this potentially
more efficient to call as generator may be able to reuse
quoted and/or encoded representation. | |||||||||||
Method for outputting a String value.
| |||||||||||
Convenience method for outputting a field entry ("member")
that has a String value.
| |||||||||||
Method similar to
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). |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Specialized version of
_writeFieldName , off-lined
to keep the "fast path" as simple (and hopefully fast) as possible. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.fasterxml.jackson.core.base.GeneratorBase
| |||||||||||
From class
com.fasterxml.jackson.core.JsonGenerator
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
com.fasterxml.jackson.core.Versioned
| |||||||||||
From interface
java.io.Closeable
| |||||||||||
From interface
java.io.Flushable
| |||||||||||
From interface
java.lang.AutoCloseable
|
Definition of custom character escapes to use for generators created by this factory, if any. If null, standard data format specific escapes are used.
When custom escapes are used, this member variable can be used to store escape to use
Short (14 char) temporary buffer allocated if needed, for constructing escape sequences
Value between 128 (0x80) and 65535 (0xFFFF) that indicates highest Unicode code point that will not need escaping; or 0 to indicate that all characters can be represented without escaping. Typically used to force escaping of some portion of character set; for example to always escape non-ASCII characters (if value was 127).
NOTE: not all sub-classes make use of this setting.
Intermediate buffer in which contents are buffered before
being written using _writer
.
End marker of the output buffer; one past the last valid position within the buffer.
Currently active set of output escape code definitions (whether and how to escape or not) for 7-bit ASCII range (first 128 character codes). Defined separately to make potentially customizable
Pointer to the first buffered character to output
Pointer to the position right beyond the last character to output (end marker; may point to position right beyond the end of the buffer)
This is the default set of escape codes, over 7-bit ASCII range (first 128 character codes), used for single-byte UTF-8 characters.
Method called to close this generator, so that no more content can be written.
Whether the underlying target (stream, writer) gets closed depends
on whether this generator either manages the target (i.e. is the
only one with access to the target -- case if caller passes a
reference to the resource such as File, but not stream); or
has feature AUTO_CLOSE_TARGET
enabled.
If either of above is true, the target is also closed. Otherwise
(not managing, feature not enabled), target is not closed.
IOException |
---|
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
IOException |
---|
Method for accessing custom escapes factory uses for JsonGenerator
s
it creates.
Accessor method for testing what is the highest unescaped character configured for this generator. This may be either positive value (when escaping configuration has been set and is in effect), or 0 to indicate that no additional escaping is in effect. Some generators may not support additional escaping: for example, generators for binary formats that do not use escaping should simply return 0.
Method that can be used to get access to object that is used
as target for generated output; this is usually either
OutputStream
or Writer
, 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.
Method for defining custom escapes factory uses for JsonGenerator
s
it creates.
Method that can be called to request that generator escapes all character codes above specified code point (if positive value); or, to not escape any characters except for ones that must be escaped for the data format (if -1). To force escaping of all non-ASCII characters, for example, this method would be called with value of 127.
Note that generators are NOT required to support setting of value higher than 127, because there are other ways to affect quoting (or lack thereof) of character codes between 0 and 127. Not all generators support concept of escaping, either; if so, calling this method will have no effect.
Default implementation does nothing; sub-classes need to redefine it according to rules of supported data format.
charCode | Either -1 to indicate that no additional escaping is to be done; or highest code point not to escape (meaning higher ones will be), if positive value. |
---|
Implemented with detection that tries to find "VERSION.txt" in same package as the implementation class.
Method similar to writeBinary(Base64Variant, byte[], int, int)
,
but where input is provided through a stream, allowing for incremental
writes without holding the whole input in memory.
b64variant | Base64 variant to use |
---|---|
data | InputStream to use for reading binary data to write. Will not be closed after successful write operation |
dataLength | (optional) number of bytes that will be available;
or -1 to be indicate it is not known.
If a positive length is given, data MUST provide at least
that many bytes: if not, an exception will be thrown.
Note that implementations
need not support cases where length is not known in advance; this
depends on underlying data format: JSON output does NOT require length,
other formats may. |
data
and written as binary payloadMethod that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes). This method defaults
Note: because Json Strings can not contain unescaped linefeeds,
if linefeeds are included (as per last argument), they must be
escaped. This adds overhead for decoding without improving
readability.
Alternatively if linefeeds are not included,
resulting String value may violate the requirement of base64
RFC which mandates line-length of 76 characters and use of
linefeeds. However, all JsonParser
implementations
are required to accept such "long line base64"; as do
typical production-level base64 decoders.
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. |
---|
Method for outputting literal Json boolean value (one of Strings 'true' and 'false'). Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).
Marker can be written if the innermost structured type is Array.
Method for writing closing marker of a JSON 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).
Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.
Field names can only be written in Object context (check out JSON specification for details), when field name is expected (field names alternate with values).
Method similar to 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.
Method for outputting literal Json null value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
Method for outputting given value as Json number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
Method for outputting given value as Json number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
Write method that can be used for custom numeric types that can
not be (easily?) converted to "standard" Java number types.
Because numbers are not surrounded by double quotes, regular
writeString(char[], int, int)
method can not be used; nor
writeRaw(char)
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
.
Method for outputting given value as Json number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
Method for outputting indicate Json numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
Method for outputting indicate Json numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
Method for outputting indicate Json numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
If such separators are desired, use
writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
If such separators are desired, use
writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
If such separators are desired, use
writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
If such separators are desired, use
writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
Method similar to writeString(String)
but that takes as
its input a UTF-8 encoded String that is to be output as-is, without additional
escaping (type of which depends on data format; backslashes for JSON).
However, quoting that data format requires (like double-quotes for JSON) will be added
around the value if and as necessary.
Note that some backends may choose not to support this method: for
example, if underlying destination is a Writer
using this method would require UTF-8 decoding.
If so, implementation may instead choose to throw a
UnsupportedOperationException
due to ineffectiveness
of having to decode input.
Method for writing starting marker of a JSON Array value (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.
Method for writing starting marker of a JSON 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.
Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.
Method similar to writeString(String)
, but that takes
SerializableString
which can make this potentially
more efficient to call as generator may be able to reuse
quoted and/or encoded representation.
Default implementation just calls writeString(String)
;
sub-classes should override it with more efficient implementation
if possible.
Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.
Convenience method for outputting a field entry ("member") that has a String value. Equivalent to:
writeFieldName(fieldName); writeString(value);
Note: many performance-sensitive implementations override this method
Method similar to writeString(String)
but that takes as its input
a UTF-8 encoded String which has not been escaped using whatever
escaping scheme data format requires (for JSON that is backslash-escaping
for control characters and double-quotes; for other formats something else).
This means that textual JSON backends need to check if value needs
JSON escaping, but otherwise can just be copied as is to output.
Also, quoting that data format requires (like double-quotes for JSON) will be added
around the value if and as necessary.
Note that some backends may choose not to support this method: for
example, if underlying destination is a Writer
using this method would require UTF-8 decoding.
In this case
generator implementation may instead choose to throw a
UnsupportedOperationException
due to ineffectiveness
of having to decode input.
Specialized version of _writeFieldName
, off-lined
to keep the "fast path" as simple (and hopefully fast) as possible.