public class TokenBuffer extends JsonGenerator
JsonToken
sequences, needed for temporary buffering.
Space efficient for different sequence lengths (especially so for smaller
ones; but not significantly less efficient for larger), highly efficient
for linear iteration and appending. Implemented as segmented/chunked
linked list of tokens; only modifications are via appends.Modifier and Type | Class and Description |
---|---|
protected static class |
TokenBuffer.Parser |
protected static class |
TokenBuffer.Segment
Individual segment of TokenBuffer that can store up to 16 tokens
(limited by 4 bits per token type marker requirement).
|
JsonGenerator.Feature
Modifier and Type | Field and Description |
---|---|
protected int |
_appendOffset
Offset within last segment,
|
protected boolean |
_closed |
protected TokenBuffer.Segment |
_first
First segment, for contents this buffer has
|
protected int |
_generatorFeatures
Bit flag composed of bits that indicate which
JsonGenerator.Feature s
are enabled. |
protected TokenBuffer.Segment |
_last
Last segment of this buffer, one that is used
for appending more tokens
|
protected ObjectCodec |
_objectCodec
Object codec to use for stream-based object
conversion through parser/generator interfaces.
|
protected JsonWriteContext |
_writeContext |
protected static int |
DEFAULT_PARSER_FEATURES |
_cfgPrettyPrinter
Constructor and Description |
---|
TokenBuffer(ObjectCodec codec) |
Modifier and Type | Method and Description |
---|---|
protected void |
_append(JsonToken type) |
protected void |
_append(JsonToken type,
Object value) |
protected void |
_reportUnsupportedOperation() |
JsonParser |
asParser()
Method used to create a
JsonParser that can read contents
stored in this buffer. |
JsonParser |
asParser(JsonParser src) |
JsonParser |
asParser(ObjectCodec codec)
Method used to create a
JsonParser that can read contents
stored in this buffer. |
void |
close()
Method called to close this generator, so that no more content
can be written.
|
void |
copyCurrentEvent(JsonParser jp)
Method for copying contents of the current event that
the given parser instance points to.
|
void |
copyCurrentStructure(JsonParser jp)
Method for copying contents of the current event
and following events that it encloses
the given parser instance points to.
|
JsonGenerator |
disable(JsonGenerator.Feature f)
Method for disabling specified features
(check
JsonGenerator.Feature for list of features) |
JsonGenerator |
enable(JsonGenerator.Feature f)
Method for enabling specified parser features:
check
JsonGenerator.Feature for list of available features. |
void |
flush()
Method called to flush any buffered content to the underlying
target (output stream, writer), and to flush the target itself
as well.
|
ObjectCodec |
getCodec()
Method for accessing the object used for writing Java
object as Json content
(using method
JsonGenerator.writeObject(java.lang.Object) ). |
JsonWriteContext |
getOutputContext() |
boolean |
isClosed()
Method that can be called to determine whether this generator
is closed or not.
|
boolean |
isEnabled(JsonGenerator.Feature f)
Method for checking whether given feature is enabled.
|
void |
serialize(JsonGenerator jgen)
Helper method that will write all contents of this buffer
using given
JsonGenerator . |
JsonGenerator |
setCodec(ObjectCodec oc)
Method that can be called to set or reset the object to
use for writing Java objects as JsonContent
(using method
JsonGenerator.writeObject(java.lang.Object) ). |
String |
toString() |
JsonGenerator |
useDefaultPrettyPrinter()
Convenience method for enabling pretty-printing using
the default pretty printer
(
DefaultPrettyPrinter ). |
void |
writeBinary(Base64Variant b64variant,
byte[] data,
int offset,
int len)
Method that will output given chunk of binary data as base64
encoded, as a complete String value (surrounded by double quotes).
|
void |
writeBoolean(boolean state)
Method for outputting literal Json boolean value (one of
Strings 'true' and 'false').
|
void |
writeEndArray()
Method for writing closing marker of a JSON Array value
(character ']'; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeEndObject()
Method for writing closing marker of a JSON Object value
(character '}'; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeFieldName(SerializableString name)
Method similar to
JsonGenerator.writeFieldName(String) , main difference
being that it may perform better as some of processing (such as
quoting of certain characters, or encoding into external encoding
if supported by generator) can be done just once and reused for
later calls. |
void |
writeFieldName(SerializedString name)
Method similar to
JsonGenerator.writeFieldName(String) , main difference
being that it may perform better as some of processing (such as
quoting of certain characters, or encoding into external encoding
if supported by generator) can be done just once and reused for
later calls. |
void |
writeFieldName(String name)
Method for writing a field name (JSON String surrounded by
double quotes: syntactically identical to a JSON String value),
possibly decorated by white space if pretty-printing is enabled.
|
void |
writeNull()
Method for outputting literal Json null value.
|
void |
writeNumber(BigDecimal dec)
Method for outputting indicate Json numeric value.
|
void |
writeNumber(BigInteger v)
Method for outputting given value as Json number.
|
void |
writeNumber(double d)
Method for outputting indicate Json numeric value.
|
void |
writeNumber(float f)
Method for outputting indicate Json numeric value.
|
void |
writeNumber(int i)
Method for outputting given value as Json number.
|
void |
writeNumber(long l)
Method for outputting given value as Json number.
|
void |
writeNumber(String encodedValue)
Write method that can be used for custom numeric types that can
not be (easily?) converted to "standard" Java number types.
|
void |
writeObject(Object value)
Method for writing given Java object (POJO) as Json.
|
void |
writeRaw(char c)
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
|
void |
writeRaw(char[] text,
int offset,
int len)
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
|
void |
writeRaw(String text)
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
|
void |
writeRaw(String text,
int offset,
int len)
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
|
void |
writeRawUTF8String(byte[] text,
int offset,
int length)
Method similar to
JsonGenerator.writeString(String) but that takes as
its input a UTF-8 encoded String that is to be output as-is, without additional
escaping (type of which depends on data format; backslashes for JSON). |
void |
writeRawValue(char[] text,
int offset,
int len) |
void |
writeRawValue(String text)
Method that will force generator to copy
input text verbatim without any modifications, but assuming
it must constitute a single legal JSON value (number, string,
boolean, null, Array or List).
|
void |
writeRawValue(String text,
int offset,
int len) |
void |
writeStartArray()
Method for writing starting marker of a JSON Array value
(character '['; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeStartObject()
Method for writing starting marker of a JSON Object value
(character '{'; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeString(char[] text,
int offset,
int len)
Method for outputting a String value.
|
void |
writeString(SerializableString text)
Method similar to
JsonGenerator.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. |
void |
writeString(String text)
Method for outputting a String value.
|
void |
writeTree(JsonNode rootNode)
Method for writing given JSON tree (expressed as a tree
where given JsonNode is the root) using this generator.
|
void |
writeUTF8String(byte[] text,
int offset,
int length)
Method similar to
JsonGenerator.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). |
canUseSchema, configure, disableFeature, enableFeature, getCharacterEscapes, getHighestEscapedChar, getOutputTarget, isFeatureEnabled, setCharacterEscapes, setFeature, setHighestNonEscapedChar, setPrettyPrinter, setSchema, version, writeArrayFieldStart, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeStringField
protected static final int DEFAULT_PARSER_FEATURES
protected ObjectCodec _objectCodec
protected int _generatorFeatures
JsonGenerator.Feature
s
are enabled.
NOTE: most features have no effect on this class
protected boolean _closed
protected TokenBuffer.Segment _first
protected TokenBuffer.Segment _last
protected int _appendOffset
protected JsonWriteContext _writeContext
public TokenBuffer(ObjectCodec codec)
codec
- Object codec to use for stream-based object
conversion through parser/generator interfaces. If null,
such methods can not be used.public JsonParser asParser()
JsonParser
that can read contents
stored in this buffer. Will use default _objectCodec
for
object conversions.
Note: instances are not synchronized, that is, they are not thread-safe if there are concurrent appends to the underlying buffer.
public JsonParser asParser(ObjectCodec codec)
JsonParser
that can read contents
stored in this buffer.
Note: instances are not synchronized, that is, they are not thread-safe if there are concurrent appends to the underlying buffer.
codec
- Object codec to use for stream-based object
conversion through parser/generator interfaces. If null,
such methods can not be used.public JsonParser asParser(JsonParser src)
src
- Parser to use for accessing source information
like location, configured codecpublic void serialize(JsonGenerator jgen) throws IOException, JsonGenerationException
JsonGenerator
.
Note: this method would be enough to implement
JsonSerializer
for TokenBuffer
type;
but we can not have upwards
references (from core to mapper package); and as such we also
can not take second argument.
IOException
JsonGenerationException
public JsonGenerator enable(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of available features.enable
in class JsonGenerator
public JsonGenerator disable(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of features)disable
in class JsonGenerator
public boolean isEnabled(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of available features.isEnabled
in class JsonGenerator
public JsonGenerator useDefaultPrettyPrinter()
JsonGenerator
DefaultPrettyPrinter
).useDefaultPrettyPrinter
in class JsonGenerator
public JsonGenerator setCodec(ObjectCodec oc)
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
).setCodec
in class JsonGenerator
public ObjectCodec getCodec()
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
).getCodec
in class JsonGenerator
public final JsonWriteContext getOutputContext()
getOutputContext
in class JsonGenerator
public void flush() throws IOException
JsonGenerator
flush
in class JsonGenerator
IOException
public void close() throws IOException
JsonGenerator
Whether the underlying target (stream, writer) gets closed depends
on whether this generator either manages the target (i.e. is the
only one with access to the target -- case if caller passes a
reference to the resource such as File, but not stream); or
has feature JsonGenerator.Feature.AUTO_CLOSE_TARGET
enabled.
If either of above is true, the target is also closed. Otherwise
(not managing, feature not enabled), target is not closed.
close
in interface Closeable
close
in interface AutoCloseable
close
in class JsonGenerator
IOException
public boolean isClosed()
JsonGenerator
isClosed
in class JsonGenerator
public final void writeStartArray() throws IOException, JsonGenerationException
JsonGenerator
Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartArray
in class JsonGenerator
IOException
JsonGenerationException
public final void writeEndArray() throws IOException, JsonGenerationException
JsonGenerator
Marker can be written if the innermost structured type is Array.
writeEndArray
in class JsonGenerator
IOException
JsonGenerationException
public final void writeStartObject() throws IOException, JsonGenerationException
JsonGenerator
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject
in class JsonGenerator
IOException
JsonGenerationException
public final void writeEndObject() throws IOException, JsonGenerationException
JsonGenerator
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).
writeEndObject
in class JsonGenerator
IOException
JsonGenerationException
public final void writeFieldName(String name) throws IOException, JsonGenerationException
JsonGenerator
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).
writeFieldName
in class JsonGenerator
IOException
JsonGenerationException
public void writeFieldName(SerializableString name) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.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.
writeFieldName
in class JsonGenerator
IOException
JsonGenerationException
public void writeFieldName(SerializedString name) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.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.
writeFieldName
in class JsonGenerator
IOException
JsonGenerationException
public void writeString(String text) throws IOException, JsonGenerationException
JsonGenerator
writeString
in class JsonGenerator
IOException
JsonGenerationException
public void writeString(char[] text, int offset, int len) throws IOException, JsonGenerationException
JsonGenerator
writeString
in class JsonGenerator
IOException
JsonGenerationException
public void writeString(SerializableString text) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.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 JsonGenerator.writeString(String)
;
sub-classes should override it with more efficient implementation
if possible.
writeString
in class JsonGenerator
IOException
JsonGenerationException
public void writeRawUTF8String(byte[] text, int offset, int length) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.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.
writeRawUTF8String
in class JsonGenerator
IOException
JsonGenerationException
public void writeUTF8String(byte[] text, int offset, int length) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.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.
writeUTF8String
in class JsonGenerator
IOException
JsonGenerationException
public void writeRaw(String text) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
writeRaw
in class JsonGenerator
IOException
JsonGenerationException
public void writeRaw(String text, int offset, int len) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
writeRaw
in class JsonGenerator
IOException
JsonGenerationException
public void writeRaw(char[] text, int offset, int len) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
writeRaw
in class JsonGenerator
IOException
JsonGenerationException
public void writeRaw(char c) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
writeRaw
in class JsonGenerator
IOException
JsonGenerationException
public void writeRawValue(String text) throws IOException, JsonGenerationException
JsonGenerator
writeRawValue
in class JsonGenerator
IOException
JsonGenerationException
public void writeRawValue(String text, int offset, int len) throws IOException, JsonGenerationException
writeRawValue
in class JsonGenerator
IOException
JsonGenerationException
public void writeRawValue(char[] text, int offset, int len) throws IOException, JsonGenerationException
writeRawValue
in class JsonGenerator
IOException
JsonGenerationException
public void writeNumber(int i) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public void writeNumber(long l) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public void writeNumber(double d) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public void writeNumber(float f) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public void writeNumber(BigDecimal dec) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public void writeNumber(BigInteger v) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public void writeNumber(String encodedValue) throws IOException, JsonGenerationException
JsonGenerator
JsonGenerator.writeString(java.lang.String)
method can not be used; nor
JsonGenerator.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
.
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public void writeBoolean(boolean state) throws IOException, JsonGenerationException
JsonGenerator
writeBoolean
in class JsonGenerator
IOException
JsonGenerationException
public void writeNull() throws IOException, JsonGenerationException
JsonGenerator
writeNull
in class JsonGenerator
IOException
JsonGenerationException
public void writeObject(Object value) throws IOException, JsonProcessingException
JsonGenerator
writeObject
in class JsonGenerator
IOException
JsonProcessingException
public void writeTree(JsonNode rootNode) throws IOException, JsonProcessingException
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
with given node, but is added
for convenience and to make code more explicit in cases
where it deals specifically with trees.writeTree
in class JsonGenerator
IOException
JsonProcessingException
public void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws IOException, JsonGenerationException
JsonGenerator
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.
writeBinary
in class JsonGenerator
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.IOException
JsonGenerationException
public void copyCurrentEvent(JsonParser jp) throws IOException, JsonProcessingException
JsonGenerator
Calling this method will not advance the given parser, although it may cause parser to internally process more data (if it lazy loads contents of value events, for example)
copyCurrentEvent
in class JsonGenerator
IOException
JsonProcessingException
public void copyCurrentStructure(JsonParser jp) throws IOException, JsonProcessingException
JsonGenerator
So what constitutes enclosing? Here is the list of events that have associated enclosed events that will get copied:
JsonToken.START_OBJECT
:
all events up to and including matching (closing)
JsonToken.END_OBJECT
will be copied
JsonToken.START_ARRAY
all events up to and including matching (closing)
JsonToken.END_ARRAY
will be copied
JsonToken.FIELD_NAME
the logical value (which
can consist of a single scalar value; or a sequence of related
events for structured types (Json Arrays, Objects)) will
be copied along with the name itself. So essentially the
whole field entry (name and value) will be copied.
After calling this method, parser will point to the last event that was copied. This will either be the event parser already pointed to (if there were no enclosed events), or the last enclosed event copied.
copyCurrentStructure
in class JsonGenerator
IOException
JsonProcessingException
protected final void _append(JsonToken type)
protected void _reportUnsupportedOperation()