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.
Note that before version 2.0, this class was located in the "core" bundle, not data-binding; but since it was only used by data binding, was moved here to reduce size of core package
JsonGenerator.Feature
Constructor and Description |
---|
TokenBuffer(JsonParser p) |
TokenBuffer(JsonParser p,
DeserializationContext ctxt) |
TokenBuffer(ObjectCodec codec,
boolean hasNativeIds) |
Modifier and Type | Method and Description |
---|---|
TokenBuffer |
append(TokenBuffer other)
Helper method that will append contents of given buffer into this
buffer.
|
static TokenBuffer |
asCopyOfValue(JsonParser p)
Convenience method, equivalent to:
|
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. |
JsonParser |
asParserOnFirstToken()
Same as:
|
boolean |
canWriteBinaryNatively()
Since we can efficiently store
byte[] , yes. |
boolean |
canWriteObjectId()
Introspection method that may be called to see if the underlying
data format supports some kind of Object Ids natively (many do not;
for example, JSON doesn't).
|
boolean |
canWriteTypeId()
Introspection method that may be called to see if the underlying
data format supports some kind of Type Ids natively (many do not;
for example, JSON doesn't).
|
void |
close()
Method called to close this generator, so that no more content
can be written.
|
void |
copyCurrentEvent(JsonParser p)
Method for copying contents of the current event that
the given parser instance points to.
|
void |
copyCurrentStructure(JsonParser p)
Method for copying contents of the current event
and following events that it encloses
the given parser instance points to.
|
TokenBuffer |
deserialize(JsonParser p,
DeserializationContext ctxt)
Helper method used by standard deserializer.
|
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. |
JsonToken |
firstToken() |
void |
flush()
Method called to flush any buffered content to the underlying
target (output stream, writer), and to flush the target itself
as well.
|
TokenBuffer |
forceUseOfBigDecimal(boolean b) |
ObjectCodec |
getCodec()
Method for accessing the object used for writing Java
object as JSON content
(using method
JsonGenerator.writeObject(java.lang.Object) ). |
int |
getFeatureMask()
Bulk access method for getting state of all standard (non-dataformat-specific)
JsonGenerator.Feature s. |
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.
|
TokenBuffer |
overrideParentContext(JsonStreamContext ctxt)
Method that allows explicitly specifying parent parse context to associate
with contents of this buffer.
|
JsonGenerator |
overrideStdFeatures(int values,
int mask)
Bulk set method for (re)setting states of features specified by
mask . |
void |
serialize(JsonGenerator gen)
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) ). |
JsonGenerator |
setFeatureMask(int mask)
Deprecated.
|
java.lang.String |
toString() |
JsonGenerator |
useDefaultPrettyPrinter()
Convenience method for enabling pretty-printing using
the default pretty printer
(
DefaultPrettyPrinter ). |
Version |
version()
Accessor for finding out version of the bundle that provided this generator instance.
|
void |
writeBinary(Base64Variant b64variant,
byte[] data,
int offset,
int len)
Method that will output given chunk of binary data as base64
encoded, as a complete String value (surrounded by double quotes).
|
int |
writeBinary(Base64Variant b64variant,
java.io.InputStream data,
int dataLength)
Although we could support this method, it does not necessarily make
sense: we cannot make good use of streaming because buffer must
hold all the data.
|
void |
writeBoolean(boolean state)
Method for outputting literal JSON boolean value (one of
Strings 'true' and 'false').
|
void |
writeEmbeddedObject(java.lang.Object object)
Method that can be called on backends that support passing opaque datatypes of
non-JSON formats
|
void |
writeEndArray()
Method for writing closing marker of a JSON Array value
(character ']'; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeEndObject()
Method for writing closing marker of an Object value
(character '}'; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeFieldName(SerializableString name)
Method similar 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(java.lang.String name)
Method for writing a field name (JSON String surrounded by
double quotes: syntactically identical to a JSON String value),
possibly decorated by white space if pretty-printing is enabled.
|
void |
writeNull()
Method for outputting literal JSON null value.
|
void |
writeNumber(java.math.BigDecimal dec)
Method for outputting indicate JSON numeric value.
|
void |
writeNumber(java.math.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(short i)
Method for outputting given value as JSON number.
|
void |
writeNumber(java.lang.String encodedValue)
Write method that can be used for custom numeric types that can
not be (easily?) converted to "standard" Java number types.
|
void |
writeObject(java.lang.Object value)
Method for writing given Java object (POJO) as Json.
|
void |
writeObjectId(java.lang.Object id)
Method that can be called to output so-called native Object Id.
|
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(SerializableString text)
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
|
void |
writeRaw(java.lang.String text)
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
|
void |
writeRaw(java.lang.String text,
int offset,
int len)
Method that will force generator to copy
input text verbatim with no modifications (including
that no escaping is done and no separators are added even
if context [array, object] would otherwise require such).
|
void |
writeRawUTF8String(byte[] text,
int offset,
int length)
Method similar 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(java.lang.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(java.lang.String text,
int offset,
int len) |
void |
writeStartArray()
Method for writing starting marker of a Array value
(for JSON this is character '['; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeStartArray(int size)
Method for writing start marker of an Array value, similar
to
JsonGenerator.writeStartArray() , but also specifying how many
elements will be written for the array before calling
JsonGenerator.writeEndArray() . |
void |
writeStartArray(java.lang.Object forValue) |
void |
writeStartArray(java.lang.Object forValue,
int size) |
void |
writeStartObject()
Method for writing starting marker of an Object value
(character '{'; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeStartObject(java.lang.Object forValue)
Method for writing starting marker of an Object value
to represent the given Java Object value.
|
void |
writeStartObject(java.lang.Object forValue,
int size)
Method for writing starting marker of an Object value
to represent the given Java Object value.
|
void |
writeString(char[] text,
int offset,
int len)
Method for outputting a String value.
|
void |
writeString(SerializableString text)
Method similar 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(java.lang.String text)
Method for outputting a String value.
|
void |
writeTree(TreeNode node)
Method for writing given JSON tree (expressed as a tree
where given JsonNode is the root) using this generator.
|
void |
writeTypeId(java.lang.Object id)
Method that can be called to output so-called native Type Id.
|
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). |
canOmitFields, canUseSchema, canWriteFormattedNumbers, configure, getCharacterEscapes, getCurrentValue, getFormatFeatures, getHighestEscapedChar, getOutputBuffered, getOutputTarget, getPrettyPrinter, getSchema, isEnabled, overrideFormatFeatures, setCharacterEscapes, setCurrentValue, setHighestNonEscapedChar, setPrettyPrinter, setRootValueSeparator, setSchema, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeFieldId, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectRef, writeOmittedField, writeRawValue, writeString, writeStringField, writeTypePrefix, writeTypeSuffix
public TokenBuffer(ObjectCodec codec, boolean hasNativeIds)
codec
- Object codec to use for stream-based object
conversion through parser/generator interfaces. If null,
such methods cannot be used.hasNativeIds
- Whether resulting JsonParser
(if created)
is considered to support native type and object idspublic TokenBuffer(JsonParser p)
public TokenBuffer(JsonParser p, DeserializationContext ctxt)
public static TokenBuffer asCopyOfValue(JsonParser p) throws java.io.IOException
TokenBuffer b = new TokenBuffer(p); b.copyCurrentStructure(p); return b;
java.io.IOException
public TokenBuffer overrideParentContext(JsonStreamContext ctxt)
public TokenBuffer forceUseOfBigDecimal(boolean b)
public Version version()
JsonGenerator
version
in interface Versioned
version
in class JsonGenerator
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 asParserOnFirstToken() throws java.io.IOException
JsonParser p = asParser(); p.nextToken(); return p;
java.io.IOException
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 cannot be used.public JsonParser asParser(JsonParser src)
src
- Parser to use for accessing source information
like location, configured codecpublic JsonToken firstToken()
public TokenBuffer append(TokenBuffer other) throws java.io.IOException
java.io.IOException
public void serialize(JsonGenerator gen) throws java.io.IOException
JsonGenerator
.
Note: this method would be enough to implement
JsonSerializer
for TokenBuffer
type;
but we cannot have upwards
references (from core to mapper package); and as such we also
cannot take second argument.
java.io.IOException
public TokenBuffer deserialize(JsonParser p, DeserializationContext ctxt) throws java.io.IOException
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
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 int getFeatureMask()
JsonGenerator
JsonGenerator.Feature
s.getFeatureMask
in class JsonGenerator
JsonGenerator.Feature
s.@Deprecated public JsonGenerator setFeatureMask(int mask)
JsonGenerator
JsonGenerator.Feature
ssetFeatureMask
in class JsonGenerator
mask
- Bitmask that defines which JsonGenerator.Feature
s are enabled
and which disabledpublic JsonGenerator overrideStdFeatures(int values, int mask)
JsonGenerator
mask
.
Functionally equivalent to
int oldState = getFeatureMask();
int newState = (oldState & ~mask) | (values & mask);
setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.overrideStdFeatures
in class JsonGenerator
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changepublic 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 boolean canWriteBinaryNatively()
byte[]
, yes.canWriteBinaryNatively
in class JsonGenerator
public void flush() throws java.io.IOException
JsonGenerator
flush
in interface java.io.Flushable
flush
in class JsonGenerator
java.io.IOException
public void close() throws java.io.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 java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in class JsonGenerator
java.io.IOException
public boolean isClosed()
JsonGenerator
isClosed
in class JsonGenerator
public final void writeStartArray() throws java.io.IOException
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
java.io.IOException
public final void writeStartArray(int size) throws java.io.IOException
JsonGenerator
JsonGenerator.writeStartArray()
, but also specifying how many
elements will be written for the array before calling
JsonGenerator.writeEndArray()
.
Default implementation simply calls JsonGenerator.writeStartArray()
.
writeStartArray
in class JsonGenerator
size
- Number of elements this array will have: actual
number of values written (before matching call to
JsonGenerator.writeEndArray()
MUST match; generator MAY verify
this is the case.java.io.IOException
public void writeStartArray(java.lang.Object forValue) throws java.io.IOException
writeStartArray
in class JsonGenerator
java.io.IOException
public void writeStartArray(java.lang.Object forValue, int size) throws java.io.IOException
writeStartArray
in class JsonGenerator
java.io.IOException
public final void writeEndArray() throws java.io.IOException
JsonGenerator
Marker can be written if the innermost structured type is Array.
writeEndArray
in class JsonGenerator
java.io.IOException
public final void writeStartObject() throws java.io.IOException
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
java.io.IOException
public void writeStartObject(java.lang.Object forValue) throws java.io.IOException
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
java.io.IOException
public void writeStartObject(java.lang.Object forValue, int size) throws java.io.IOException
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
java.io.IOException
public final void writeEndObject() throws java.io.IOException
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
java.io.IOException
public final void writeFieldName(java.lang.String name) throws java.io.IOException
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
java.io.IOException
public void writeFieldName(SerializableString name) throws java.io.IOException
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
java.io.IOException
public void writeString(java.lang.String text) throws java.io.IOException
JsonGenerator
writeString
in class JsonGenerator
java.io.IOException
public void writeString(char[] text, int offset, int len) throws java.io.IOException
JsonGenerator
writeString
in class JsonGenerator
java.io.IOException
public void writeString(SerializableString text) throws java.io.IOException
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
java.io.IOException
public void writeRawUTF8String(byte[] text, int offset, int length) throws java.io.IOException
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
java.io.IOException
public void writeUTF8String(byte[] text, int offset, int length) throws java.io.IOException
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
java.io.IOException
public void writeRaw(java.lang.String text) throws java.io.IOException
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
java.io.IOException
public void writeRaw(java.lang.String text, int offset, int len) throws java.io.IOException
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
java.io.IOException
public void writeRaw(SerializableString text) throws java.io.IOException
JsonGenerator
JsonGenerator.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).
writeRaw
in class JsonGenerator
java.io.IOException
public void writeRaw(char[] text, int offset, int len) throws java.io.IOException
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
java.io.IOException
public void writeRaw(char c) throws java.io.IOException
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
java.io.IOException
public void writeRawValue(java.lang.String text) throws java.io.IOException
JsonGenerator
writeRawValue
in class JsonGenerator
java.io.IOException
public void writeRawValue(java.lang.String text, int offset, int len) throws java.io.IOException
writeRawValue
in class JsonGenerator
java.io.IOException
public void writeRawValue(char[] text, int offset, int len) throws java.io.IOException
writeRawValue
in class JsonGenerator
java.io.IOException
public void writeNumber(short i) throws java.io.IOException
JsonGenerator
writeNumber
in class JsonGenerator
i
- Number value to writejava.io.IOException
public void writeNumber(int i) throws java.io.IOException
JsonGenerator
writeNumber
in class JsonGenerator
i
- Number value to writejava.io.IOException
public void writeNumber(long l) throws java.io.IOException
JsonGenerator
writeNumber
in class JsonGenerator
l
- Number value to writejava.io.IOException
public void writeNumber(double d) throws java.io.IOException
JsonGenerator
writeNumber
in class JsonGenerator
d
- Number value to writejava.io.IOException
public void writeNumber(float f) throws java.io.IOException
JsonGenerator
writeNumber
in class JsonGenerator
f
- Number value to writejava.io.IOException
public void writeNumber(java.math.BigDecimal dec) throws java.io.IOException
JsonGenerator
writeNumber
in class JsonGenerator
dec
- Number value to writejava.io.IOException
public void writeNumber(java.math.BigInteger v) throws java.io.IOException
JsonGenerator
writeNumber
in class JsonGenerator
v
- Number value to writejava.io.IOException
public void writeNumber(java.lang.String encodedValue) throws java.io.IOException
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
java.io.IOException
public void writeBoolean(boolean state) throws java.io.IOException
JsonGenerator
writeBoolean
in class JsonGenerator
java.io.IOException
public void writeNull() throws java.io.IOException
JsonGenerator
writeNull
in class JsonGenerator
java.io.IOException
public void writeObject(java.lang.Object value) throws java.io.IOException
JsonGenerator
writeObject
in class JsonGenerator
java.io.IOException
public void writeTree(TreeNode node) throws java.io.IOException
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
java.io.IOException
public void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws java.io.IOException
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.java.io.IOException
public int writeBinary(Base64Variant b64variant, java.io.InputStream data, int dataLength)
UnsupportedOperationException
writeBinary
in class JsonGenerator
b64variant
- Base64 variant to usedata
- InputStream to use for reading binary data to write.
Will not be closed after successful write operationdataLength
- (optional) number of bytes that will be available;
or -1 to be indicate it is not known.
If a positive length is given, data
MUST provide at least
that many bytes: if not, an exception will be thrown.
Note that implementations
need not support cases where length is not known in advance; this
depends on underlying data format: JSON output does NOT require length,
other formats may.data
and written as binary payloadpublic boolean canWriteTypeId()
JsonGenerator
JsonGenerator.writeTypeId(java.lang.Object)
.
Default implementation returns false; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native type ids.
canWriteTypeId
in class JsonGenerator
public boolean canWriteObjectId()
JsonGenerator
JsonGenerator.writeObjectId(java.lang.Object)
or JsonGenerator.writeObjectRef(java.lang.Object)
.
Default implementation returns false; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native object ids.
canWriteObjectId
in class JsonGenerator
public void writeTypeId(java.lang.Object id)
JsonGenerator
JsonGenerator.canWriteTypeId()
), as not all data formats
have native type id support; and some may only allow them in
certain positions or locations.
If output is not allowed by the data format in this position,
a JsonGenerationException
will be thrown.writeTypeId
in class JsonGenerator
public void writeObjectId(java.lang.Object id)
JsonGenerator
JsonGenerator.canWriteObjectId()
), as not all data formats
have native type id support; and some may only allow them in
certain positions or locations.
If output is not allowed by the data format in this position,
a JsonGenerationException
will be thrown.writeObjectId
in class JsonGenerator
public void writeEmbeddedObject(java.lang.Object object) throws java.io.IOException
JsonGenerator
writeEmbeddedObject
in class JsonGenerator
java.io.IOException
public void copyCurrentEvent(JsonParser p) throws java.io.IOException
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
java.io.IOException
public void copyCurrentStructure(JsonParser p) throws java.io.IOException
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
java.io.IOException
Copyright © 2010 - 2020 Adobe. All Rights Reserved