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.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)
Deprecated.
Since 2.13: use
DeserializationContext.bufferAsCopyOfValue(com.fasterxml.jackson.core.JsonParser) instead. |
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 feature
(check
JsonGenerator.Feature for list of features) |
JsonGenerator |
enable(JsonGenerator.Feature f)
Method for enabling specified generator feature:
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.Features. |
JsonWriteContext |
getOutputContext()
Accessor for context object that provides information about low-level
logical position withing output token stream.
|
JacksonFeatureSet<StreamWriteCapability> |
getWriteCapabilities()
Accessor for getting metadata on capabilities of this generator, based on
underlying data format being read (directly or indirectly).
|
boolean |
isClosed()
Method that can be called to determine whether this generator
is closed or not.
|
boolean |
isEmpty()
Accessor for checking whether this buffer has one or more tokens
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 native
values that some data formats support; not used with JSON backend,
more common with binary 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)
Older alias for
JsonGenerator.writePOJO(Object) |
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(java.lang.Object forValue)
Method for writing start marker of an Array value, similar
to
JsonGenerator.writeStartArray(),
but also specifying the "current value"
to assign to the new Array context being created. |
void |
writeStartArray(java.lang.Object forValue,
int size)
Method for writing start marker of an Array value, similar
to
JsonGenerator.writeStartArray(), but also specifying the "current value"
to assign to the new Array context being created
as well as how many elements will be written for the array before calling
JsonGenerator.writeEndArray(). |
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). |
assignCurrentValue, canOmitFields, canUseSchema, canWriteFormattedNumbers, configure, currentValue, getCharacterEscapes, getCurrentValue, getFormatFeatures, getHighestEscapedChar, getOutputBuffered, getOutputTarget, getPrettyPrinter, getSchema, isEnabled, overrideFormatFeatures, setCharacterEscapes, setCurrentValue, setHighestNonEscapedChar, setPrettyPrinter, setRootValueSeparator, setSchema, writeArray, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeFieldId, writeNullField, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectRef, writeOmittedField, writePOJO, writePOJOField, writeRawValue, writeStartArray, writeString, writeStringField, writeTypePrefix, writeTypeSuffixpublic 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)
@Deprecated public static TokenBuffer asCopyOfValue(JsonParser p) throws java.io.IOException
DeserializationContext.bufferAsCopyOfValue(com.fasterxml.jackson.core.JsonParser) instead.TokenBuffer b = new TokenBuffer(p); b.copyCurrentStructure(p); return b;
java.io.IOExceptionpublic TokenBuffer overrideParentContext(JsonStreamContext ctxt)
public TokenBuffer forceUseOfBigDecimal(boolean b)
public Version version()
JsonGeneratorversion in interface Versionedversion in class JsonGeneratorjackson-core jar that contains the classpublic 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.IOExceptionpublic 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 boolean isEmpty()
public TokenBuffer append(TokenBuffer other) throws java.io.IOException
java.io.IOExceptionpublic 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.IOExceptionpublic TokenBuffer deserialize(JsonParser p, DeserializationContext ctxt) throws java.io.IOException
java.io.IOExceptionpublic java.lang.String toString()
toString in class java.lang.Objectpublic JsonGenerator enable(JsonGenerator.Feature f)
JsonGeneratorJsonGenerator.Feature for list of available features.enable in class JsonGeneratorf - Feature to enablepublic JsonGenerator disable(JsonGenerator.Feature f)
JsonGeneratorJsonGenerator.Feature for list of features)disable in class JsonGeneratorf - Feature to disablepublic boolean isEnabled(JsonGenerator.Feature f)
JsonGeneratorJsonGenerator.Feature for list of available features.isEnabled in class JsonGeneratorf - Feature to checkpublic int getFeatureMask()
JsonGeneratorJsonGenerator.Features.getFeatureMask in class JsonGeneratorJsonGenerator.Features.@Deprecated public JsonGenerator setFeatureMask(int mask)
JsonGeneratorJsonGenerator.FeaturessetFeatureMask in class JsonGeneratormask - Bitmask that defines which JsonGenerator.Features are enabled
and which disabledpublic JsonGenerator overrideStdFeatures(int values, int mask)
JsonGeneratormask.
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 JsonGeneratorvalues - Bit mask of set/clear state for features to changemask - Bit mask of features to changepublic JsonGenerator useDefaultPrettyPrinter()
JsonGeneratorDefaultPrettyPrinter).useDefaultPrettyPrinter in class JsonGeneratorpublic JsonGenerator setCodec(ObjectCodec oc)
JsonGeneratorJsonGenerator.writeObject(java.lang.Object)).setCodec in class JsonGeneratoroc - Codec to assign, if any; null if nonepublic ObjectCodec getCodec()
JsonGeneratorJsonGenerator.writeObject(java.lang.Object)).getCodec in class JsonGeneratornull if nonepublic final JsonWriteContext getOutputContext()
JsonGeneratorgetOutputContext in class JsonGeneratorJsonStreamContext) associated with this generatorpublic boolean canWriteBinaryNatively()
byte[], yes.canWriteBinaryNatively in class JsonGeneratorTrue if this generator is capable of writing "raw" Binary
Content
(this is typically determined by capabilities of the underlying format);
false if notpublic JacksonFeatureSet<StreamWriteCapability> getWriteCapabilities()
JsonGeneratorgetWriteCapabilities in class JsonGeneratorpublic void flush()
throws java.io.IOException
JsonGeneratorflush in interface java.io.Flushableflush in class JsonGeneratorjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic 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.Closeableclose in interface java.lang.AutoCloseableclose in class JsonGeneratorjava.io.IOException - if there is either an underlying I/O problempublic boolean isClosed()
JsonGeneratorisClosed in class JsonGeneratorTrue if this generator instance has been closedpublic final void writeStartArray()
throws java.io.IOException
JsonGeneratorArray values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartArray in class JsonGeneratorjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartArray(java.lang.Object forValue)
throws java.io.IOException
JsonGeneratorJsonGenerator.writeStartArray(),
but also specifying the "current value"
to assign to the new Array context being created.writeStartArray in class JsonGeneratorforValue - "Current value" to assign for the Array context being createdjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartArray(java.lang.Object forValue,
int size)
throws java.io.IOException
JsonGeneratorJsonGenerator.writeStartArray(), but also specifying the "current value"
to assign to the new Array context being created
as well as how many elements will be written for the array before calling
JsonGenerator.writeEndArray().writeStartArray in class JsonGeneratorforValue - "Current value" to assign for the Array context being createdsize - Number of elements this Array will have: actual
number of values written (before matching call to
JsonGenerator.writeEndArray() MUST match; generator MAY verify
this is the case (and SHOULD if format itself encodes length)java.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic final void writeEndArray()
throws java.io.IOException
JsonGeneratorMarker can be written if the innermost structured type is Array.
writeEndArray in class JsonGeneratorjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic final void writeStartObject()
throws java.io.IOException
JsonGeneratorObject values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject in class JsonGeneratorjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartObject(java.lang.Object forValue)
throws java.io.IOException
JsonGeneratorObject values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject in class JsonGeneratorforValue - "Current value" to assign for the Object context being createdjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartObject(java.lang.Object forValue,
int size)
throws java.io.IOException
JsonGeneratorObject values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject in class JsonGeneratorforValue - "Current value" to assign for the Object context being createdsize - Number of key/value pairs this Object will have: actual
number of entries written (before matching call to
JsonGenerator.writeEndObject() MUST match; generator MAY verify
this is the case (and SHOULD if format itself encodes length)java.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic final void writeEndObject()
throws java.io.IOException
JsonGeneratorMarker 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 JsonGeneratorjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic final void writeFieldName(java.lang.String name)
throws java.io.IOException
JsonGeneratorField 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 JsonGeneratorname - Field name to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeFieldName(SerializableString name) throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratorname - Field name to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeString(java.lang.String text)
throws java.io.IOException
JsonGeneratorwriteString in class JsonGeneratortext - Text value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeString(char[] text,
int offset,
int len)
throws java.io.IOException
JsonGeneratorwriteString in class JsonGeneratortext - Buffer that contains String value to writeoffset - Offset in buffer of the first character of String value to writelen - Length of the String value (in characters) to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeString(SerializableString text) throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratortext - Pre-encoded String value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRawUTF8String(byte[] text,
int offset,
int length)
throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratortext - Buffer that contains String value to writeoffset - Offset in buffer of the first byte of String value to writelength - Length of the String value (in characters) to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeUTF8String(byte[] text,
int offset,
int length)
throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratortext - Buffer that contains String value to writeoffset - Offset in buffer of the first byte of String value to writelength - Length of the String value (in characters) to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(java.lang.String text)
throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratortext - Textual contents to include as-is in output.java.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(java.lang.String text,
int offset,
int len)
throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratortext - String that has contents to include as-is in outputoffset - Offset within text of the first character to outputlen - Length of content (from text, starting at offset offset) to outputjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(SerializableString text) throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratortext - Pre-encoded textual contents to included in outputjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(char[] text,
int offset,
int len)
throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratortext - Buffer that has contents to include as-is in outputoffset - Offset within text of the first character to outputlen - Length of content (from text, starting at offset offset) to outputjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(char c)
throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratorc - Character to included in outputjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRawValue(java.lang.String text)
throws java.io.IOException
JsonGeneratorwriteRawValue in class JsonGeneratortext - Textual contents to included in outputjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRawValue(java.lang.String text,
int offset,
int len)
throws java.io.IOException
writeRawValue in class JsonGeneratorjava.io.IOExceptionpublic void writeRawValue(char[] text,
int offset,
int len)
throws java.io.IOException
writeRawValue in class JsonGeneratorjava.io.IOExceptionpublic void writeNumber(short i)
throws java.io.IOException
JsonGeneratorwriteNumber in class JsonGeneratori - Number value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(int i)
throws java.io.IOException
JsonGeneratorwriteNumber in class JsonGeneratori - Number value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(long l)
throws java.io.IOException
JsonGeneratorwriteNumber in class JsonGeneratorl - Number value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(double d)
throws java.io.IOException
JsonGeneratorwriteNumber in class JsonGeneratord - Number value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(float f)
throws java.io.IOException
JsonGeneratorwriteNumber in class JsonGeneratorf - Number value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(java.math.BigDecimal dec)
throws java.io.IOException
JsonGeneratorwriteNumber in class JsonGeneratordec - Number value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(java.math.BigInteger v)
throws java.io.IOException
JsonGeneratorwriteNumber in class JsonGeneratorv - Number value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(java.lang.String encodedValue)
throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratorencodedValue - Textual (possibly format) number representation to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeBoolean(boolean state)
throws java.io.IOException
JsonGeneratorwriteBoolean in class JsonGeneratorstate - Boolean value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNull()
throws java.io.IOException
JsonGeneratorwriteNull in class JsonGeneratorjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeObject(java.lang.Object value)
throws java.io.IOException
JsonGeneratorJsonGenerator.writePOJO(Object)writeObject in class JsonGeneratorvalue - Java value (usually POJO) to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeTree(TreeNode node) throws java.io.IOException
JsonGeneratorJsonGenerator.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 JsonGeneratornode - TreeNode to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic 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 JsonGeneratorb64variant - 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 in data of the first byte of data to writelen - Length of data to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic int writeBinary(Base64Variant b64variant, java.io.InputStream data, int dataLength)
UnsupportedOperationExceptionwriteBinary in class JsonGeneratorb64variant - 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()
JsonGeneratorJsonGenerator.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 JsonGeneratorTrue if this generator is capable of writing "native" Type Ids
(which is typically determined by capabilities of the underlying format),
false if notpublic boolean canWriteObjectId()
JsonGeneratorJsonGenerator.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 JsonGeneratorTrue if this generator is capable of writing "native" Object Ids
(which is typically determined by capabilities of the underlying format),
false if notpublic void writeTypeId(java.lang.Object id)
JsonGeneratorJsonGenerator.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 JsonGeneratorid - Native Type Id to writepublic void writeObjectId(java.lang.Object id)
JsonGeneratorJsonGenerator.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 JsonGeneratorid - Native Object Id to writepublic void writeEmbeddedObject(java.lang.Object object)
throws java.io.IOException
JsonGenerator
NOTE: this is NOT the method to call for serializing regular POJOs,
see JsonGenerator.writeObject(java.lang.Object) instead.
writeEmbeddedObject in class JsonGeneratorobject - Native format-specific value to writejava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void copyCurrentEvent(JsonParser p) throws java.io.IOException
JsonGeneratorCalling 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 JsonGeneratorp - Parser that points to event (token) to copyjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerpublic void copyCurrentStructure(JsonParser p) throws java.io.IOException
JsonGeneratorSo 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 JsonGeneratorp - Parser that points to the value to copyjava.io.IOException - if there is either an underlying I/O problem or encoding
issue at format layerCopyright © 2010 - 2023 Adobe. All Rights Reserved