public abstract class JsonGenerator extends Object implements Closeable, Flushable, Versioned
JsonFactory
instance.Modifier and Type | Class and Description |
---|---|
static class |
JsonGenerator.Feature
Enumeration that defines all togglable features for generators.
|
Modifier and Type | Field and Description |
---|---|
protected PrettyPrinter |
_cfgPrettyPrinter
Object that handles pretty-printing (usually additional
white space to make results more human-readable) during
output.
|
Modifier | Constructor and Description |
---|---|
protected |
JsonGenerator() |
Modifier and Type | Method and Description |
---|---|
protected void |
_reportError(String msg)
Helper method used for constructing and throwing
JsonGenerationException with given base message. |
protected void |
_reportUnsupportedOperation() |
protected void |
_throwInternal() |
protected void |
_verifyOffsets(int arrayLength,
int offset,
int length) |
protected void |
_writeSimpleObject(Object value)
Helper method to try to call appropriate write method for given
untyped Object.
|
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
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
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).
|
abstract void |
close()
Method called to close this generator, so that no more content
can be written.
|
JsonGenerator |
configure(JsonGenerator.Feature f,
boolean state)
Method for enabling or disabling specified feature:
check
JsonGenerator.Feature for list of available features. |
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.
|
abstract JsonGenerator |
disable(JsonGenerator.Feature f)
Method for disabling specified features
(check
JsonGenerator.Feature for list of features) |
abstract JsonGenerator |
enable(JsonGenerator.Feature f)
Method for enabling specified parser features:
check
JsonGenerator.Feature for list of available features. |
abstract 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
JsonGenerator s
it creates. |
abstract ObjectCodec |
getCodec()
Method for accessing the object used for writing Java
object as JSON content
(using method
writeObject(java.lang.Object) ). |
Object |
getCurrentValue()
Helper method, usually equivalent to:
getOutputContext().getCurrentValue();
|
abstract int |
getFeatureMask()
Bulk access method for getting state of all standard (non-dataformat-specific)
JsonGenerator.Feature s. |
int |
getFormatFeatures()
Bulk access method for getting state of all
FormatFeature s, format-specific
on/off configuration settings. |
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.
|
abstract 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.
|
abstract boolean |
isClosed()
Method that can be called to determine whether this generator
is closed or not.
|
abstract 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
FormatFeature s,
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
JsonGenerator s
it creates. |
abstract 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
writeObject(java.lang.Object) ). |
void |
setCurrentValue(Object v)
Helper method, usually equivalent to:
getOutputContext().setCurrentValue(v);
|
abstract JsonGenerator |
setFeatureMask(int values)
Deprecated.
Since 2.7, use
overrideStdFeatures(int, int) instead -- remove from 2.9 |
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.
|
abstract JsonGenerator |
useDefaultPrettyPrinter()
Convenience method for enabling pretty-printing using
the default pretty printer
(
DefaultPrettyPrinter ). |
abstract 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 |
writeArrayFieldStart(String fieldName)
Convenience method for outputting a field entry ("member")
(that will contain a JSON Array value), and the START_ARRAY marker.
|
abstract void |
writeBinary(Base64Variant bv,
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).
|
abstract int |
writeBinary(Base64Variant bv,
InputStream data,
int dataLength)
Method similar to
writeBinary(Base64Variant,byte[],int,int) ,
but where input is provided through a stream, allowing for incremental
writes without holding the whole input in memory. |
void |
writeBinary(byte[] data)
Similar to
writeBinary(Base64Variant,byte[],int,int) ,
but assumes default to using the Jackson default Base64 variant
(which is Base64Variants.MIME_NO_LINEFEEDS ). |
void |
writeBinary(byte[] data,
int offset,
int len)
Similar to
writeBinary(Base64Variant,byte[],int,int) ,
but default to using the Jackson default Base64 variant
(which is Base64Variants.MIME_NO_LINEFEEDS ). |
int |
writeBinary(InputStream data,
int dataLength)
Similar to
writeBinary(Base64Variant,InputStream,int) ,
but assumes default to using the Jackson default Base64 variant
(which is Base64Variants.MIME_NO_LINEFEEDS ). |
void |
writeBinaryField(String fieldName,
byte[] data)
Convenience method for outputting a field entry ("member")
that contains specified data in base64-encoded form.
|
abstract void |
writeBoolean(boolean state)
Method for outputting literal JSON boolean value (one of
Strings 'true' and 'false').
|
void |
writeBooleanField(String fieldName,
boolean value)
Convenience method for outputting a field entry ("member")
that has a boolean value.
|
void |
writeEmbeddedObject(Object object)
Method that can be called on backends that support passing opaque datatypes of
non-JSON formats
|
abstract void |
writeEndArray()
Method for writing closing marker of a JSON Array value
(character ']'; plus possible white space decoration
if pretty-printing is enabled).
|
abstract void |
writeEndObject()
Method for writing closing marker of a JSON Object value
(character '}'; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeFieldId(long id)
Alternative to
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. |
abstract void |
writeFieldName(SerializableString name)
Method similar to
writeFieldName(String) , main difference
being that it may perform better as some of processing (such as
quoting of certain characters, or encoding into external encoding
if supported by generator) can be done just once and reused for
later calls. |
abstract 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.
|
abstract void |
writeNull()
Method for outputting literal JSON null value.
|
void |
writeNullField(String fieldName)
Convenience method for outputting a field entry ("member")
that has JSON literal value null.
|
abstract void |
writeNumber(BigDecimal v)
Method for outputting indicate JSON numeric value.
|
abstract void |
writeNumber(BigInteger v)
Method for outputting given value as JSON number.
|
abstract void |
writeNumber(double v)
Method for outputting indicate JSON numeric value.
|
abstract void |
writeNumber(float v)
Method for outputting indicate JSON numeric value.
|
abstract void |
writeNumber(int v)
Method for outputting given value as JSON number.
|
abstract void |
writeNumber(long v)
Method for outputting given value as JSON number.
|
void |
writeNumber(short v)
Method for outputting given value as JSON number.
|
abstract 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 |
writeNumberField(String fieldName,
BigDecimal value)
Convenience method for outputting a field entry ("member")
that has the specified numeric value.
|
void |
writeNumberField(String fieldName,
double value)
Convenience method for outputting a field entry ("member")
that has the specified numeric value.
|
void |
writeNumberField(String fieldName,
float value)
Convenience method for outputting a field entry ("member")
that has the specified numeric value.
|
void |
writeNumberField(String fieldName,
int value)
Convenience method for outputting a field entry ("member")
that has the specified numeric value.
|
void |
writeNumberField(String fieldName,
long value)
Convenience method for outputting a field entry ("member")
that has the specified numeric value.
|
abstract void |
writeObject(Object pojo)
Method for writing given Java object (POJO) as Json.
|
void |
writeObjectField(String fieldName,
Object pojo)
Convenience method for outputting a field entry ("member")
that has contents of specific Java object as its value.
|
void |
writeObjectFieldStart(String fieldName)
Convenience method for outputting a field entry ("member")
(that will contain a JSON Object value), and the START_OBJECT marker.
|
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.
|
abstract 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).
|
abstract 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).
|
abstract 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).
|
abstract 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).
|
abstract void |
writeRawUTF8String(byte[] text,
int offset,
int length)
Method similar to
writeString(String) but that takes as
its input a UTF-8 encoded String that is to be output as-is, without additional
escaping (type of which depends on data format; backslashes for JSON). |
abstract void |
writeRawValue(char[] text,
int offset,
int len) |
void |
writeRawValue(SerializableString raw)
Method similar to
writeRawValue(String) , but potentially more
efficient as it may be able to use pre-encoded content (similar to
writeRaw(SerializableString) . |
abstract 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).
|
abstract void |
writeRawValue(String text,
int offset,
int len) |
abstract 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
writeStartArray() , but also specifying how many
elements will be written for the array before calling
writeEndArray() . |
abstract void |
writeStartObject()
Method for writing starting marker of a JSON Object value
(character '{'; plus possible white space decoration
if pretty-printing is enabled).
|
void |
writeStartObject(Object forValue)
Method for writing starting marker of a JSON Object value
(character '{'; plus possible white space decoration
if pretty-printing is enabled), to represent Java given
as the argument.
|
abstract void |
writeString(char[] text,
int offset,
int len)
Method for outputting a String value.
|
abstract void |
writeString(SerializableString text)
Method similar to
writeString(String) , but that takes
SerializableString which can make this potentially
more efficient to call as generator may be able to reuse
quoted and/or encoded representation. |
abstract void |
writeString(String text)
Method for outputting a String value.
|
void |
writeStringField(String fieldName,
String value)
Convenience method for outputting a field entry ("member")
that has a String value.
|
abstract void |
writeTree(TreeNode rootNode)
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.
|
abstract void |
writeUTF8String(byte[] text,
int offset,
int length)
Method similar to
writeString(String) but that takes as its input
a UTF-8 encoded String which has not been escaped using whatever
escaping scheme data format requires (for JSON that is backslash-escaping
for control characters and double-quotes; for other formats something else). |
protected PrettyPrinter _cfgPrettyPrinter
public abstract JsonGenerator setCodec(ObjectCodec oc)
writeObject(java.lang.Object)
).public abstract ObjectCodec getCodec()
writeObject(java.lang.Object)
).public abstract Version version()
public abstract JsonGenerator enable(JsonGenerator.Feature f)
JsonGenerator.Feature
for list of available features.public abstract JsonGenerator disable(JsonGenerator.Feature f)
JsonGenerator.Feature
for list of features)public final JsonGenerator configure(JsonGenerator.Feature f, boolean state)
JsonGenerator.Feature
for list of available features.public abstract boolean isEnabled(JsonGenerator.Feature f)
JsonGenerator.Feature
for list of available features.public abstract int getFeatureMask()
JsonGenerator.Feature
s.JsonGenerator.Feature
s.@Deprecated public abstract JsonGenerator setFeatureMask(int values)
overrideStdFeatures(int, int)
instead -- remove from 2.9JsonGenerator.Feature
svalues
- Bitmask that defines which JsonGenerator.Feature
s are enabled
and which disabledpublic JsonGenerator overrideStdFeatures(int values, int mask)
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.values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changepublic int getFormatFeatures()
FormatFeature
s, format-specific
on/off configuration settings.FormatFeature
s.public JsonGenerator overrideFormatFeatures(int values, int mask)
FormatFeature
s,
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 FormatFeature
s.
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changepublic void setSchema(FormatSchema schema)
If generator does not support specified schema, UnsupportedOperationException
is thrown.
schema
- Schema to useUnsupportedOperationException
- if generator does not support schemapublic FormatSchema getSchema()
public JsonGenerator setPrettyPrinter(PrettyPrinter pp)
To use the default pretty printer that comes with core
Jackson distribution, call useDefaultPrettyPrinter()
instead.
public PrettyPrinter getPrettyPrinter()
PrettyPrinter
; returns it if so, null if none configured.public abstract JsonGenerator useDefaultPrettyPrinter()
DefaultPrettyPrinter
).public JsonGenerator setHighestNonEscapedChar(int charCode)
Note that generators are NOT required to support setting of value higher than 127, because there are other ways to affect quoting (or lack thereof) of character codes between 0 and 127. Not all generators support concept of escaping, either; if so, calling this method will have no effect.
Default implementation does nothing; sub-classes need to redefine it according to rules of supported data format.
charCode
- Either -1 to indicate that no additional escaping
is to be done; or highest code point not to escape (meaning higher
ones will be), if positive value.public int getHighestEscapedChar()
public CharacterEscapes getCharacterEscapes()
JsonGenerator
s
it creates.public JsonGenerator setCharacterEscapes(CharacterEscapes esc)
JsonGenerator
s
it creates.
Default implementation does nothing and simply returns this instance.
public JsonGenerator setRootValueSeparator(SerializableString sep)
Default implementation throws UnsupportedOperationException
.
sep
- Separator to use, if any; null means that no separator is
automatically addedpublic Object getOutputTarget()
OutputStream
or Writer
, depending on what
generator was constructed with.
Note that returned value may be null in some cases; including
case where implementation does not want to exposed raw
source to caller.
In cases where output has been decorated, object returned here
is the decorated version; this allows some level of interaction
between users of generator and decorator object.
In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.
public int getOutputBuffered()
OutputStream
, `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)
public Object getCurrentValue()
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.
public void setCurrentValue(Object v)
getOutputContext().setCurrentValue(v);
public boolean canUseSchema(FormatSchema schema)
setSchema(com.fasterxml.jackson.core.FormatSchema)
).schema
- Schema to checkpublic boolean canWriteObjectId()
writeObjectId(java.lang.Object)
or 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.
public boolean canWriteTypeId()
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.
public boolean canWriteBinaryNatively()
Default implementation returns false; overridden by data formats that do support native binary content.
public boolean canOmitFields()
public boolean canWriteFormattedNumbers()
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.public abstract void writeStartArray() throws IOException
Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
IOException
public void writeStartArray(int size) throws IOException
writeStartArray()
, but also specifying how many
elements will be written for the array before calling
writeEndArray()
.
Default implementation simply calls writeStartArray()
.
size
- Number of elements this array will have: actual
number of values written (before matching call to
writeEndArray()
MUST match; generator MAY verify
this is the case.IOException
public abstract void writeEndArray() throws IOException
Marker can be written if the innermost structured type is Array.
IOException
public abstract void writeStartObject() throws IOException
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
IOException
public void writeStartObject(Object forValue) throws IOException
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
IOException
public abstract void writeEndObject() throws IOException
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).
IOException
public abstract void writeFieldName(String name) throws IOException
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).
IOException
public abstract void writeFieldName(SerializableString name) throws IOException
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.
IOException
public void writeFieldId(long id) throws IOException
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 writeFieldName(String)
.IOException
public void writeArray(int[] array, int offset, int length) throws IOException
JsonToken.START_ARRAY
, zero or
more JsonToken.VALUE_NUMBER_INT
, JsonToken.END_ARRAY
)array
- 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`IOException
public void writeArray(long[] array, int offset, int length) throws IOException
JsonToken.START_ARRAY
, zero or
more JsonToken.VALUE_NUMBER_INT
, JsonToken.END_ARRAY
)array
- 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`IOException
public void writeArray(double[] array, int offset, int length) throws IOException
JsonToken.START_ARRAY
, zero or
more JsonToken.VALUE_NUMBER_FLOAT
, JsonToken.END_ARRAY
)array
- 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`IOException
public abstract void writeString(String text) throws IOException
IOException
public abstract void writeString(char[] text, int offset, int len) throws IOException
IOException
public abstract void writeString(SerializableString text) throws IOException
writeString(String)
, but that takes
SerializableString
which can make this potentially
more efficient to call as generator may be able to reuse
quoted and/or encoded representation.
Default implementation just calls writeString(String)
;
sub-classes should override it with more efficient implementation
if possible.
IOException
public abstract void writeRawUTF8String(byte[] text, int offset, int length) throws IOException
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.
IOException
public abstract void writeUTF8String(byte[] text, int offset, int length) throws IOException
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.
IOException
public abstract void writeRaw(String text) throws IOException
writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
IOException
public abstract void writeRaw(String text, int offset, int len) throws IOException
writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
IOException
public abstract void writeRaw(char[] text, int offset, int len) throws IOException
writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
IOException
public abstract void writeRaw(char c) throws IOException
writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
IOException
public void writeRaw(SerializableString raw) throws IOException
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 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).
IOException
public abstract void writeRawValue(String text) throws IOException
IOException
public abstract void writeRawValue(String text, int offset, int len) throws IOException
IOException
public abstract void writeRawValue(char[] text, int offset, int len) throws IOException
IOException
public void writeRawValue(SerializableString raw) throws IOException
writeRawValue(String)
, but potentially more
efficient as it may be able to use pre-encoded content (similar to
writeRaw(SerializableString)
.IOException
public abstract void writeBinary(Base64Variant bv, byte[] data, int offset, int len) throws IOException
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.
bv
- Base64 variant to use: defines details such as
whether padding is used (and if so, using which character);
what is the maximum line length before adding linefeed,
and also the underlying alphabet to use.IOException
public void writeBinary(byte[] data, int offset, int len) throws IOException
writeBinary(Base64Variant,byte[],int,int)
,
but default to using the Jackson default Base64 variant
(which is Base64Variants.MIME_NO_LINEFEEDS
).IOException
public void writeBinary(byte[] data) throws IOException
writeBinary(Base64Variant,byte[],int,int)
,
but assumes default to using the Jackson default Base64 variant
(which is Base64Variants.MIME_NO_LINEFEEDS
). Also
assumes that whole byte array is to be output.IOException
public int writeBinary(InputStream data, int dataLength) throws IOException
writeBinary(Base64Variant,InputStream,int)
,
but assumes default to using the Jackson default Base64 variant
(which is Base64Variants.MIME_NO_LINEFEEDS
).data
- 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. 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 mayIOException
public abstract int writeBinary(Base64Variant bv, InputStream data, int dataLength) throws IOException
writeBinary(Base64Variant,byte[],int,int)
,
but where input is provided through a stream, allowing for incremental
writes without holding the whole input in memory.bv
- 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 payloadIOException
public void writeNumber(short v) throws IOException
v
- Number value to writeIOException
public abstract void writeNumber(int v) throws IOException
v
- Number value to writeIOException
public abstract void writeNumber(long v) throws IOException
v
- Number value to writeIOException
public abstract void writeNumber(BigInteger v) throws IOException
v
- Number value to writeIOException
public abstract void writeNumber(double v) throws IOException
v
- Number value to writeIOException
public abstract void writeNumber(float v) throws IOException
v
- Number value to writeIOException
public abstract void writeNumber(BigDecimal v) throws IOException
v
- Number value to writeIOException
public abstract void writeNumber(String encodedValue) throws IOException
writeString(java.lang.String)
method can not be used; nor
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
.
UnsupportedOperationException
- 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)IOException
public abstract void writeBoolean(boolean state) throws IOException
IOException
public abstract void writeNull() throws IOException
IOException
public void writeEmbeddedObject(Object object) throws IOException
IOException
public void writeObjectId(Object id) throws IOException
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.IOException
public void writeObjectRef(Object id) throws IOException
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.IOException
public void writeTypeId(Object id) throws IOException
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.IOException
public abstract void writeObject(Object pojo) throws IOException
IOException
public abstract void writeTree(TreeNode rootNode) throws IOException
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.IOException
public void writeStringField(String fieldName, String value) throws IOException
writeFieldName(fieldName); writeString(value);
Note: many performance-sensitive implementations override this method
IOException
public final void writeBooleanField(String fieldName, boolean value) throws IOException
writeFieldName(fieldName); writeBoolean(value);
IOException
public final void writeNullField(String fieldName) throws IOException
writeFieldName(fieldName); writeNull();
IOException
public final void writeNumberField(String fieldName, int value) throws IOException
writeFieldName(fieldName); writeNumber(value);
IOException
public final void writeNumberField(String fieldName, long value) throws IOException
writeFieldName(fieldName); writeNumber(value);
IOException
public final void writeNumberField(String fieldName, double value) throws IOException
writeFieldName(fieldName); writeNumber(value);
IOException
public final void writeNumberField(String fieldName, float value) throws IOException
writeFieldName(fieldName); writeNumber(value);
IOException
public final void writeNumberField(String fieldName, BigDecimal value) throws IOException
writeFieldName(fieldName); writeNumber(value);
IOException
public final void writeBinaryField(String fieldName, byte[] data) throws IOException
writeFieldName(fieldName); writeBinary(value);
IOException
public final void writeArrayFieldStart(String fieldName) throws IOException
writeFieldName(fieldName); writeStartArray();
Note: caller still has to take care to close the array (by calling {#link #writeEndArray}) after writing all values of the value Array.
IOException
public final void writeObjectFieldStart(String fieldName) throws IOException
writeFieldName(fieldName); writeStartObject();
Note: caller still has to take care to close the Object (by calling {#link #writeEndObject}) after writing all entries of the value Object.
IOException
public final void writeObjectField(String fieldName, Object pojo) throws IOException
writeFieldName(fieldName); writeObject(pojo);
IOException
public void writeOmittedField(String fieldName) throws IOException
false
from canOmitFields()
.
Default implementation does nothing.
IOException
public void copyCurrentEvent(JsonParser p) throws IOException
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)
IOException
public void copyCurrentStructure(JsonParser p) throws IOException
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.
IOException
public abstract JsonStreamContext getOutputContext()
public abstract void flush() throws IOException
flush
in interface Flushable
IOException
public abstract boolean isClosed()
public abstract void close() throws IOException
Whether the underlying target (stream, writer) gets closed depends
on whether this generator either manages the target (i.e. is the
only one with access to the target -- case if caller passes a
reference to the resource such as File, but not stream); or
has feature JsonGenerator.Feature.AUTO_CLOSE_TARGET
enabled.
If either of above is true, the target is also closed. Otherwise
(not managing, feature not enabled), target is not closed.
close
in interface Closeable
close
in interface AutoCloseable
IOException
protected void _reportError(String msg) throws JsonGenerationException
JsonGenerationException
with given base message.
Note that sub-classes may override this method to add more detail
or use a JsonGenerationException
sub-class.
JsonGenerationException
protected final void _throwInternal()
protected void _reportUnsupportedOperation()
protected final void _verifyOffsets(int arrayLength, int offset, int length)
protected void _writeSimpleObject(Object value) throws IOException
value
- Non-null value to writeIOException
Copyright © 2017 JBoss by Red Hat. All rights reserved.