public class JsonGeneratorDelegate extends JsonGenerator
JsonGenerator.Feature| Modifier and Type | Field and Description |
|---|---|
protected JsonGenerator |
delegate
Delegate object that method calls are delegated to.
|
protected boolean |
delegateCopyMethods
Whether copy methods
(
copyCurrentEvent(com.fasterxml.jackson.core.JsonParser), copyCurrentStructure(com.fasterxml.jackson.core.JsonParser), writeTree(com.fasterxml.jackson.core.TreeNode) and writeObject(java.lang.Object))
are to be called (true), or handled by this object (false). |
_cfgPrettyPrinter| Constructor and Description |
|---|
JsonGeneratorDelegate(JsonGenerator d) |
JsonGeneratorDelegate(JsonGenerator d,
boolean delegateCopyMethods) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
canOmitFields()
Introspection method to call to check whether it is ok to omit
writing of Object fields or not.
|
boolean |
canUseSchema(FormatSchema schema)
Method that can be used to verify that given schema can be used with
this generator (using
JsonGenerator.setSchema(com.fasterxml.jackson.core.FormatSchema)). |
boolean |
canWriteBinaryNatively()
Introspection method that may be called to see if the underlying
data format supports "native" binary data; that is, an efficient
output of binary content without encoding.
|
boolean |
canWriteFormattedNumbers()
Introspection method to call to check whether it is possible
to write numbers using
JsonGenerator.writeNumber(java.lang.String)
using possible custom format, or not. |
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.
|
JsonGenerator |
delegate() |
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.
|
CharacterEscapes |
getCharacterEscapes()
Method for accessing custom escapes factory uses for
JsonGenerators
it creates. |
ObjectCodec |
getCodec()
Method for accessing the object used for writing Java
object as JSON content
(using method
JsonGenerator.writeObject(java.lang.Object)). |
Object |
getCurrentValue()
Helper method, usually equivalent to:
getOutputContext().getCurrentValue();
|
JsonGenerator |
getDelegate()
Deprecated.
|
int |
getFeatureMask()
Bulk access method for getting state of all standard (non-dataformat-specific)
JsonGenerator.Features. |
int |
getHighestEscapedChar()
Accessor method for testing what is the highest unescaped character
configured for this generator.
|
int |
getOutputBuffered()
Method for verifying amount of content that is buffered by generator
but not yet flushed to the underlying target (stream, writer),
in units (byte, char) that the generator implementation uses for buffering;
or -1 if this information is not available.
|
JsonStreamContext |
getOutputContext() |
Object |
getOutputTarget()
Method that can be used to get access to object that is used
as target for generated output; this is usually either
OutputStream or Writer, depending on what
generator was constructed with. |
PrettyPrinter |
getPrettyPrinter()
Accessor for checking whether this generator has a configured
PrettyPrinter; returns it if so, null if none configured. |
FormatSchema |
getSchema()
Method for accessing Schema that this parser uses, if any.
|
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.
|
JsonGenerator |
overrideFormatFeatures(int values,
int mask)
Bulk set method for (re)setting states of
FormatFeatures,
by specifying values (set / clear) along with a mask, to determine
which features to change, if any. |
JsonGenerator |
overrideStdFeatures(int values,
int mask)
Bulk set method for (re)setting states of features specified by
mask. |
JsonGenerator |
setCharacterEscapes(CharacterEscapes esc)
Method for defining custom escapes factory uses for
JsonGenerators
it creates. |
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)). |
void |
setCurrentValue(Object v)
Helper method, usually equivalent to:
getOutputContext().setCurrentValue(v);
|
JsonGenerator |
setFeatureMask(int mask)
Deprecated.
|
JsonGenerator |
setHighestNonEscapedChar(int charCode)
Method that can be called to request that generator escapes
all character codes above specified code point (if positive value);
or, to not escape any characters except for ones that must be
escaped for the data format (if -1).
|
JsonGenerator |
setPrettyPrinter(PrettyPrinter pp)
Method for setting a custom pretty printer, which is usually
used to add indentation for improved human readability.
|
JsonGenerator |
setRootValueSeparator(SerializableString sep)
Method that allows overriding String used for separating root-level
JSON values (default is single space character)
|
void |
setSchema(FormatSchema schema)
Method to call to make this generator use specified schema.
|
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 |
writeArray(double[] array,
int offset,
int length)
Value write method that can be called to write a single
array (sequence of
JsonToken.START_ARRAY, zero or
more JsonToken.VALUE_NUMBER_FLOAT, JsonToken.END_ARRAY) |
void |
writeArray(int[] array,
int offset,
int length)
Value write method that can be called to write a single
array (sequence of
JsonToken.START_ARRAY, zero or
more JsonToken.VALUE_NUMBER_INT, JsonToken.END_ARRAY) |
void |
writeArray(long[] array,
int offset,
int length)
Value write method that can be called to write a single
array (sequence of
JsonToken.START_ARRAY, zero or
more JsonToken.VALUE_NUMBER_INT, JsonToken.END_ARRAY) |
void |
writeArray(String[] array,
int offset,
int length)
Value write method that can be called to write a single
array (sequence of
JsonToken.START_ARRAY, zero or
more JsonToken.VALUE_STRING, JsonToken.END_ARRAY) |
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,
InputStream data,
int dataLength)
Method similar to
JsonGenerator.writeBinary(Base64Variant,byte[],int,int),
but where input is provided through a stream, allowing for incremental
writes without holding the whole input in memory. |
void |
writeBoolean(boolean state)
Method for outputting literal JSON boolean value (one of
Strings 'true' and 'false').
|
void |
writeEmbeddedObject(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 |
writeFieldId(long id)
Alternative to
JsonGenerator.writeFieldName(String) that may be used
in cases where property key is of numeric type; either where
underlying format supports such notion (some binary formats do,
unlike JSON), or for convenient conversion into String presentation. |
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(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 v)
Method for outputting indicate JSON numeric value.
|
void |
writeNumber(BigInteger v)
Method for outputting given value as JSON number.
|
void |
writeNumber(char[] encodedValueBuffer,
int offset,
int length)
Overloaded version of
JsonGenerator.writeNumber(String) with same semantics
but possibly more efficient operation. |
void |
writeNumber(double v)
Method for outputting indicate JSON numeric value.
|
void |
writeNumber(float v)
Method for outputting indicate JSON numeric value.
|
void |
writeNumber(int v)
Method for outputting given value as JSON number.
|
void |
writeNumber(long v)
Method for outputting given value as JSON number.
|
void |
writeNumber(short v)
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 pojo)
Method for writing given Java object (POJO) as Json.
|
void |
writeObjectId(Object id)
Method that can be called to output so-called native Object Id.
|
void |
writeObjectRef(Object id)
Method that can be called to output references to native Object Ids.
|
void |
writeOmittedField(String fieldName)
Method called to indicate that a property in this position was
skipped.
|
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 raw)
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 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(Object forValue) |
void |
writeStartArray(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(Object forValue)
Method for writing starting marker of an Object value
to represent the given Java Object value.
|
void |
writeStartObject(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(Reader reader,
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(TreeNode tree)
Method for writing given JSON tree (expressed as a tree
where given JsonNode is the root) using this generator.
|
void |
writeTypeId(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). |
_copyCurrentContents, _reportError, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, configure, getFormatFeatures, isEnabled, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeRawValue, writeStringField, writeTypePrefix, writeTypeSuffixprotected JsonGenerator delegate
protected boolean delegateCopyMethods
copyCurrentEvent(com.fasterxml.jackson.core.JsonParser), copyCurrentStructure(com.fasterxml.jackson.core.JsonParser), writeTree(com.fasterxml.jackson.core.TreeNode) and writeObject(java.lang.Object))
are to be called (true), or handled by this object (false).public JsonGeneratorDelegate(JsonGenerator d)
public JsonGeneratorDelegate(JsonGenerator d, boolean delegateCopyMethods)
delegateCopyMethods - Flag assigned to delagateCopyMethod
and which defines whether copy methods are handled locally (false), or
delegated to configuredpublic Object getCurrentValue()
JsonGenerator
getOutputContext().getCurrentValue();
Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.
getCurrentValue in class JsonGeneratorpublic void setCurrentValue(Object v)
JsonGenerator
getOutputContext().setCurrentValue(v);
setCurrentValue in class JsonGeneratorpublic ObjectCodec getCodec()
JsonGeneratorJsonGenerator.writeObject(java.lang.Object)).getCodec in class JsonGeneratorpublic JsonGenerator setCodec(ObjectCodec oc)
JsonGeneratorJsonGenerator.writeObject(java.lang.Object)).setCodec in class JsonGeneratorpublic void setSchema(FormatSchema schema)
JsonGenerator
If generator does not support specified schema, UnsupportedOperationException
is thrown.
setSchema in class JsonGeneratorschema - Schema to usepublic FormatSchema getSchema()
JsonGeneratorgetSchema in class JsonGeneratorpublic Version version()
JsonGeneratorversion in interface Versionedversion in class JsonGeneratorpublic Object getOutputTarget()
JsonGeneratorOutputStream or Writer, depending on what
generator was constructed with.
Note that returned value may be null in some cases; including
case where implementation does not want to exposed raw
source to caller.
In cases where output has been decorated, object returned here
is the decorated version; this allows some level of interaction
between users of generator and decorator object.
In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.
getOutputTarget in class JsonGeneratorpublic int getOutputBuffered()
JsonGeneratorOutputStream, `char` for Writer),
but may differ if buffering is done before encoding.
Default JSON-backed implementations do use matching units.
Note: non-JSON implementations will be retrofitted for 2.6 and beyond; please report if you see -1 (missing override)
getOutputBuffered in class JsonGeneratorpublic boolean canUseSchema(FormatSchema schema)
JsonGeneratorJsonGenerator.setSchema(com.fasterxml.jackson.core.FormatSchema)).canUseSchema in class JsonGeneratorschema - Schema to checkpublic 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 JsonGeneratorpublic 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 JsonGeneratorpublic boolean canWriteBinaryNatively()
JsonGeneratorDefault implementation returns false; overridden by data formats that do support native binary content.
canWriteBinaryNatively in class JsonGeneratorpublic boolean canOmitFields()
JsonGeneratorcanOmitFields in class JsonGeneratorpublic boolean canWriteFormattedNumbers()
JsonGeneratorJsonGenerator.writeNumber(java.lang.String)
using possible custom format, or not. Typically textual formats
allow this (and JSON specifically does), whereas binary formats
do not allow this (except by writing them as Strings).
Usual reason for calling this method is to check whether custom
formatting of numbers may be applied by higher-level code (databinding)
or not.canWriteFormattedNumbers in class JsonGeneratorpublic JsonGenerator enable(JsonGenerator.Feature f)
JsonGeneratorJsonGenerator.Feature for list of available features.enable in class JsonGeneratorpublic JsonGenerator disable(JsonGenerator.Feature f)
JsonGeneratorJsonGenerator.Feature for list of features)disable in class JsonGeneratorpublic boolean isEnabled(JsonGenerator.Feature f)
JsonGeneratorJsonGenerator.Feature for list of available features.isEnabled in class JsonGeneratorpublic 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 overrideFormatFeatures(int values, int mask)
JsonGeneratorFormatFeatures,
by specifying values (set / clear) along with a mask, to determine
which features to change, if any.
Default implementation will simply throw an exception to indicate that
the generator implementation does not support any FormatFeatures.
overrideFormatFeatures in class JsonGeneratorvalues - Bit mask of set/clear state for features to changemask - Bit mask of features to changepublic JsonGenerator setPrettyPrinter(PrettyPrinter pp)
JsonGenerator
To use the default pretty printer that comes with core
Jackson distribution, call JsonGenerator.useDefaultPrettyPrinter()
instead.
setPrettyPrinter in class JsonGeneratorpublic PrettyPrinter getPrettyPrinter()
JsonGeneratorPrettyPrinter; returns it if so, null if none configured.getPrettyPrinter in class JsonGeneratorpublic JsonGenerator useDefaultPrettyPrinter()
JsonGeneratorDefaultPrettyPrinter).useDefaultPrettyPrinter in class JsonGeneratorpublic JsonGenerator setHighestNonEscapedChar(int charCode)
JsonGeneratorNote that generators are NOT required to support setting of value higher than 127, because there are other ways to affect quoting (or lack thereof) of character codes between 0 and 127. Not all generators support concept of escaping, either; if so, calling this method will have no effect.
Default implementation does nothing; sub-classes need to redefine it according to rules of supported data format.
setHighestNonEscapedChar in class JsonGeneratorcharCode - Either -1 to indicate that no additional escaping
is to be done; or highest code point not to escape (meaning higher
ones will be), if positive value.public int getHighestEscapedChar()
JsonGeneratorgetHighestEscapedChar in class JsonGeneratorpublic CharacterEscapes getCharacterEscapes()
JsonGeneratorJsonGenerators
it creates.getCharacterEscapes in class JsonGeneratorpublic JsonGenerator setCharacterEscapes(CharacterEscapes esc)
JsonGeneratorJsonGenerators
it creates.
Default implementation does nothing and simply returns this instance.
setCharacterEscapes in class JsonGeneratorpublic JsonGenerator setRootValueSeparator(SerializableString sep)
JsonGenerator
Default implementation throws UnsupportedOperationException.
setRootValueSeparator in class JsonGeneratorsep - Separator to use, if any; null means that no separator is
automatically addedpublic void writeStartArray()
throws 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 JsonGeneratorIOExceptionpublic void writeStartArray(int size)
throws IOException
JsonGeneratorJsonGenerator.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 JsonGeneratorsize - 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.IOExceptionpublic void writeStartArray(Object forValue) throws IOException
writeStartArray in class JsonGeneratorIOExceptionpublic void writeStartArray(Object forValue, int size) throws IOException
writeStartArray in class JsonGeneratorIOExceptionpublic void writeEndArray()
throws IOException
JsonGeneratorMarker can be written if the innermost structured type is Array.
writeEndArray in class JsonGeneratorIOExceptionpublic void writeStartObject()
throws 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 JsonGeneratorIOExceptionpublic void writeStartObject(Object forValue) throws 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 JsonGeneratorIOExceptionpublic void writeStartObject(Object forValue, int size) throws 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 JsonGeneratorIOExceptionpublic void writeEndObject()
throws 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 JsonGeneratorIOExceptionpublic void writeFieldName(String name) throws 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 JsonGeneratorIOExceptionpublic void writeFieldName(SerializableString name) throws 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 JsonGeneratorIOExceptionpublic void writeFieldId(long id)
throws IOException
JsonGeneratorJsonGenerator.writeFieldName(String) that may be used
in cases where property key is of numeric type; either where
underlying format supports such notion (some binary formats do,
unlike JSON), or for convenient conversion into String presentation.
Default implementation will simply convert id into String
and call JsonGenerator.writeFieldName(String).writeFieldId in class JsonGeneratorIOExceptionpublic void writeArray(int[] array,
int offset,
int length)
throws IOException
JsonGeneratorJsonToken.START_ARRAY, zero or
more JsonToken.VALUE_NUMBER_INT, JsonToken.END_ARRAY)writeArray in class JsonGeneratorarray - Array that contains values to writeoffset - Offset of the first element to write, within arraylength - Number of elements in array to write, from `offset` to `offset + len - 1`IOExceptionpublic void writeArray(long[] array,
int offset,
int length)
throws IOException
JsonGeneratorJsonToken.START_ARRAY, zero or
more JsonToken.VALUE_NUMBER_INT, JsonToken.END_ARRAY)writeArray in class JsonGeneratorarray - Array that contains values to writeoffset - Offset of the first element to write, within arraylength - Number of elements in array to write, from `offset` to `offset + len - 1`IOExceptionpublic void writeArray(double[] array,
int offset,
int length)
throws IOException
JsonGeneratorJsonToken.START_ARRAY, zero or
more JsonToken.VALUE_NUMBER_FLOAT, JsonToken.END_ARRAY)writeArray in class JsonGeneratorarray - Array that contains values to writeoffset - Offset of the first element to write, within arraylength - Number of elements in array to write, from `offset` to `offset + len - 1`IOExceptionpublic void writeArray(String[] array, int offset, int length) throws IOException
JsonGeneratorJsonToken.START_ARRAY, zero or
more JsonToken.VALUE_STRING, JsonToken.END_ARRAY)writeArray in class JsonGeneratorarray - Array that contains values to writeoffset - Offset of the first element to write, within arraylength - Number of elements in array to write, from `offset` to `offset + len - 1`IOExceptionpublic void writeString(String text) throws IOException
JsonGeneratorwriteString in class JsonGeneratorIOExceptionpublic void writeString(Reader reader, int len) throws IOException
JsonGeneratorwriteString in class JsonGeneratorIOExceptionpublic void writeString(char[] text,
int offset,
int len)
throws IOException
JsonGeneratorwriteString in class JsonGeneratorIOExceptionpublic void writeString(SerializableString text) throws 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 JsonGeneratorIOExceptionpublic void writeRawUTF8String(byte[] text,
int offset,
int length)
throws 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 JsonGeneratorIOExceptionpublic void writeUTF8String(byte[] text,
int offset,
int length)
throws 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 JsonGeneratorIOExceptionpublic void writeRaw(String text) throws 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 JsonGeneratorIOExceptionpublic void writeRaw(String text, int offset, int len) throws 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 JsonGeneratorIOExceptionpublic void writeRaw(SerializableString raw) throws 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 JsonGeneratorIOExceptionpublic void writeRaw(char[] text,
int offset,
int len)
throws 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 JsonGeneratorIOExceptionpublic void writeRaw(char c)
throws 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 JsonGeneratorIOExceptionpublic void writeRawValue(String text) throws IOException
JsonGeneratorwriteRawValue in class JsonGeneratorIOExceptionpublic void writeRawValue(String text, int offset, int len) throws IOException
writeRawValue in class JsonGeneratorIOExceptionpublic void writeRawValue(char[] text,
int offset,
int len)
throws IOException
writeRawValue in class JsonGeneratorIOExceptionpublic void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws 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.IOExceptionpublic int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws IOException
JsonGeneratorJsonGenerator.writeBinary(Base64Variant,byte[],int,int),
but where input is provided through a stream, allowing for incremental
writes without holding the whole input in memory.writeBinary 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 payloadIOExceptionpublic void writeNumber(short v)
throws IOException
JsonGeneratorwriteNumber in class JsonGeneratorv - Number value to writeIOExceptionpublic void writeNumber(int v)
throws IOException
JsonGeneratorwriteNumber in class JsonGeneratorv - Number value to writeIOExceptionpublic void writeNumber(long v)
throws IOException
JsonGeneratorwriteNumber in class JsonGeneratorv - Number value to writeIOExceptionpublic void writeNumber(BigInteger v) throws IOException
JsonGeneratorwriteNumber in class JsonGeneratorv - Number value to writeIOExceptionpublic void writeNumber(double v)
throws IOException
JsonGeneratorwriteNumber in class JsonGeneratorv - Number value to writeIOExceptionpublic void writeNumber(float v)
throws IOException
JsonGeneratorwriteNumber in class JsonGeneratorv - Number value to writeIOExceptionpublic void writeNumber(BigDecimal v) throws IOException
JsonGeneratorwriteNumber in class JsonGeneratorv - Number value to writeIOExceptionpublic void writeNumber(String encodedValue) throws IOException, UnsupportedOperationException
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 JsonGeneratorUnsupportedOperationException - If underlying data format does not
support numbers serialized textually AND if generator is not allowed
to just output a String instead (Schema-based formats may require actual
number, for example)IOExceptionpublic void writeNumber(char[] encodedValueBuffer,
int offset,
int length)
throws IOException,
UnsupportedOperationException
JsonGeneratorJsonGenerator.writeNumber(String) with same semantics
but possibly more efficient operation.writeNumber in class JsonGeneratorIOExceptionUnsupportedOperationExceptionpublic void writeBoolean(boolean state)
throws IOException
JsonGeneratorwriteBoolean in class JsonGeneratorIOExceptionpublic void writeNull()
throws IOException
JsonGeneratorwriteNull in class JsonGeneratorIOExceptionpublic void writeOmittedField(String fieldName) throws IOException
JsonGeneratorfalse from JsonGenerator.canOmitFields().
Default implementation does nothing.
writeOmittedField in class JsonGeneratorIOExceptionpublic void writeObjectId(Object id) throws IOException
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 JsonGeneratorIOExceptionpublic void writeObjectRef(Object id) throws IOException
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.writeObjectRef in class JsonGeneratorIOExceptionpublic void writeTypeId(Object id) throws IOException
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 JsonGeneratorIOExceptionpublic void writeEmbeddedObject(Object object) throws IOException
JsonGeneratorwriteEmbeddedObject in class JsonGeneratorIOExceptionpublic void writeObject(Object pojo) throws IOException
JsonGeneratorwriteObject in class JsonGeneratorIOExceptionpublic void writeTree(TreeNode tree) throws 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 JsonGeneratorIOExceptionpublic void copyCurrentEvent(JsonParser p) throws 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 JsonGeneratorIOExceptionpublic void copyCurrentStructure(JsonParser p) throws 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 JsonGeneratorIOExceptionpublic JsonStreamContext getOutputContext()
getOutputContext in class JsonGeneratorpublic void flush()
throws IOException
JsonGeneratorflush in interface Flushableflush in class JsonGeneratorIOExceptionpublic 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 Closeableclose in interface AutoCloseableclose in class JsonGeneratorIOExceptionpublic boolean isClosed()
JsonGeneratorisClosed in class JsonGenerator@Deprecated public JsonGenerator getDelegate()
public JsonGenerator delegate()
Copyright © 2008–2020 FasterXML. All rights reserved.