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, DEFAULT_BINARY_WRITE_CAPABILITIES, DEFAULT_TEXTUAL_WRITE_CAPABILITIES, DEFAULT_WRITE_CAPABILITIES
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 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. |
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. |
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.Feature s. |
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()
Accessor for context object that provides information about low-level
logical position withing output token stream.
|
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 generator uses, if any;
null if none. |
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 |
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. |
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 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 |
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)
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(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(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, writeTypeSuffix
protected 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)
d
- Underlying generator to delegate calls todelegateCopyMethods
- 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 or generators; 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 JsonGenerator
public void setCurrentValue(Object v)
JsonGenerator
getOutputContext().setCurrentValue(v);
setCurrentValue
in class JsonGenerator
v
- Current value to assign for the current context of this generatorpublic ObjectCodec getCodec()
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
).getCodec
in class JsonGenerator
null
if nonepublic JsonGenerator setCodec(ObjectCodec oc)
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
).setCodec
in class JsonGenerator
oc
- Codec to assign, if any; null
if nonepublic void setSchema(FormatSchema schema)
JsonGenerator
If generator does not support specified schema, UnsupportedOperationException
is thrown.
setSchema
in class JsonGenerator
schema
- Schema to usepublic FormatSchema getSchema()
JsonGenerator
null
if none.
Default implementation returns null.getSchema
in class JsonGenerator
null
if nonepublic Version version()
JsonGenerator
version
in interface Versioned
version
in class JsonGenerator
jackson-core
jar that contains the classpublic Object getOutputTarget()
JsonGenerator
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.
getOutputTarget
in class JsonGenerator
public int getOutputBuffered()
JsonGenerator
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)
getOutputBuffered
in class JsonGenerator
public boolean canUseSchema(FormatSchema schema)
JsonGenerator
JsonGenerator.setSchema(com.fasterxml.jackson.core.FormatSchema)
).canUseSchema
in class JsonGenerator
schema
- Schema to checkpublic boolean canWriteTypeId()
JsonGenerator
JsonGenerator.writeTypeId(java.lang.Object)
.
Default implementation returns false; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native type ids.
canWriteTypeId
in class JsonGenerator
True
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()
JsonGenerator
JsonGenerator.writeObjectId(java.lang.Object)
or JsonGenerator.writeObjectRef(java.lang.Object)
.
Default implementation returns false; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native object ids.
canWriteObjectId
in class JsonGenerator
True
if this generator is capable of writing "native" Object Ids
(which is typically determined by capabilities of the underlying format),
false
if notpublic boolean canWriteBinaryNatively()
JsonGenerator
Default implementation returns false; overridden by data formats that do support native binary content.
canWriteBinaryNatively
in class JsonGenerator
True
if this generator is capable of writing "raw" Binary
Content
(this is typically determined by capabilities of the underlying format);
false
if notpublic boolean canOmitFields()
JsonGenerator
canOmitFields
in class JsonGenerator
True
if this generator is allowed to only write values
of some Object fields and omit the rest; false
if notpublic boolean canWriteFormattedNumbers()
JsonGenerator
JsonGenerator.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 JsonGenerator
True
if this generator is capable of writing "formatted"
numbers (and if so, need to be passed using
JsonGenerator.writeNumber(String)
, that is, passed as String
);
false
if notpublic JacksonFeatureSet<StreamWriteCapability> getWriteCapabilities()
JsonGenerator
getWriteCapabilities
in class JsonGenerator
public JsonGenerator enable(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of available features.enable
in class JsonGenerator
f
- Feature to enablepublic JsonGenerator disable(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of features)disable
in class JsonGenerator
f
- Feature to disablepublic boolean isEnabled(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of available features.isEnabled
in class JsonGenerator
f
- Feature to checkpublic int getFeatureMask()
JsonGenerator
JsonGenerator.Feature
s.getFeatureMask
in class JsonGenerator
JsonGenerator.Feature
s.@Deprecated public JsonGenerator setFeatureMask(int mask)
JsonGenerator
JsonGenerator.Feature
ssetFeatureMask
in class JsonGenerator
mask
- Bitmask that defines which JsonGenerator.Feature
s are enabled
and which disabledpublic JsonGenerator overrideStdFeatures(int values, int mask)
JsonGenerator
mask
.
Functionally equivalent to
int oldState = getFeatureMask();
int newState = (oldState & ~mask) | (values & mask);
setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.overrideStdFeatures
in class JsonGenerator
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changepublic JsonGenerator overrideFormatFeatures(int values, int mask)
JsonGenerator
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.
overrideFormatFeatures
in class JsonGenerator
values
- 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 JsonGenerator
pp
- PrettyPrinter
to assign, if any; null
if nonepublic PrettyPrinter getPrettyPrinter()
JsonGenerator
PrettyPrinter
; returns it if so, null if none configured.getPrettyPrinter
in class JsonGenerator
PrettyPrinter
configured for this generator, if any; null
if nonepublic JsonGenerator useDefaultPrettyPrinter()
JsonGenerator
DefaultPrettyPrinter
).useDefaultPrettyPrinter
in class JsonGenerator
public JsonGenerator setHighestNonEscapedChar(int charCode)
JsonGenerator
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.
setHighestNonEscapedChar
in class JsonGenerator
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()
JsonGenerator
getHighestEscapedChar
in class JsonGenerator
public CharacterEscapes getCharacterEscapes()
JsonGenerator
JsonGenerator
s
it creates.getCharacterEscapes
in class JsonGenerator
CharacterEscapes
configured for this generator, if any; null
if nonepublic JsonGenerator setCharacterEscapes(CharacterEscapes esc)
JsonGenerator
JsonGenerator
s
it creates.
Default implementation does nothing and simply returns this instance.
setCharacterEscapes
in class JsonGenerator
esc
- CharacterEscapes
to configure this generator to use, if any; null
if nonepublic JsonGenerator setRootValueSeparator(SerializableString sep)
JsonGenerator
Default implementation throws UnsupportedOperationException
.
setRootValueSeparator
in class JsonGenerator
sep
- Separator to use, if any; null means that no separator is
automatically addedpublic void writeStartArray() throws IOException
JsonGenerator
Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartArray
in class JsonGenerator
IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartArray(int size) throws IOException
JsonGenerator
JsonGenerator.writeStartArray()
,
but also specifying how many
elements will be written for the array before calling
JsonGenerator.writeEndArray()
.
Default implementation simply calls JsonGenerator.writeStartArray()
.
writeStartArray
in class JsonGenerator
size
- Number of elements this array will have: actual
number of values written (before matching call to
JsonGenerator.writeEndArray()
MUST match; generator MAY verify
this is the case (and SHOULD if format itself encodes length)IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartArray(Object forValue) throws IOException
JsonGenerator
JsonGenerator.writeStartArray()
,
but also specifying the "current value"
to assign to the new Array context being created.writeStartArray
in class JsonGenerator
forValue
- "Current value" to assign for the Array context being createdIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartArray(Object forValue, int size) throws IOException
JsonGenerator
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()
.writeStartArray
in class JsonGenerator
forValue
- "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)IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeEndArray() throws IOException
JsonGenerator
Marker can be written if the innermost structured type is Array.
writeEndArray
in class JsonGenerator
IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartObject() throws IOException
JsonGenerator
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject
in class JsonGenerator
IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartObject(Object forValue) throws IOException
JsonGenerator
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject
in class JsonGenerator
forValue
- "Current value" to assign for the Object context being createdIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeStartObject(Object forValue, int size) throws IOException
JsonGenerator
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject
in class JsonGenerator
forValue
- "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)IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeEndObject() throws IOException
JsonGenerator
Marker can be written if the innermost structured type is Object, and the last written event was either a complete value, or START-OBJECT marker (see JSON specification for more details).
writeEndObject
in class JsonGenerator
IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeFieldName(String name) throws IOException
JsonGenerator
Field names can only be written in Object context (check out JSON specification for details), when field name is expected (field names alternate with values).
writeFieldName
in class JsonGenerator
name
- Field name to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeFieldName(SerializableString name) throws IOException
JsonGenerator
JsonGenerator.writeFieldName(String)
, main difference
being that it may perform better as some of processing (such as
quoting of certain characters, or encoding into external encoding
if supported by generator) can be done just once and reused for
later calls.
Default implementation simple uses unprocessed name container in serialized String; implementations are strongly encouraged to make use of more efficient methods argument object has.
writeFieldName
in class JsonGenerator
name
- Field name to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeFieldId(long id) throws IOException
JsonGenerator
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.
Default implementation will simply convert id into String
and call JsonGenerator.writeFieldName(String)
.writeFieldId
in class JsonGenerator
id
- Field id to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeArray(int[] array, int offset, int length) throws IOException
JsonGenerator
JsonToken.START_ARRAY
, zero or
more JsonToken.VALUE_NUMBER_INT
, JsonToken.END_ARRAY
)writeArray
in class JsonGenerator
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
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeArray(long[] array, int offset, int length) throws IOException
JsonGenerator
JsonToken.START_ARRAY
, zero or
more JsonToken.VALUE_NUMBER_INT
, JsonToken.END_ARRAY
)writeArray
in class JsonGenerator
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
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeArray(double[] array, int offset, int length) throws IOException
JsonGenerator
JsonToken.START_ARRAY
, zero or
more JsonToken.VALUE_NUMBER_FLOAT
, JsonToken.END_ARRAY
)writeArray
in class JsonGenerator
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
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeArray(String[] array, int offset, int length) throws IOException
JsonGenerator
JsonToken.START_ARRAY
, zero or
more JsonToken.VALUE_STRING
, JsonToken.END_ARRAY
)writeArray
in class JsonGenerator
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
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeString(String text) throws IOException
JsonGenerator
writeString
in class JsonGenerator
text
- Text value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeString(Reader reader, int len) throws IOException
JsonGenerator
len
is < 0, then write all contents of the reader.
Otherwise, write only len characters.
Note: actual length of content available may exceed len
but
can not be less than it: if not enough content available, a
JsonGenerationException
will be thrown.
writeString
in class JsonGenerator
reader
- Reader to use for reading Text value to writelen
- Maximum Length of Text value to read (in char
s, non-negative)
if known; -1
to indicate "read and write it all"IOException
- if there is either an underlying I/O problem or encoding
issue at format layer; or if length (len
) is specified but
reader
does not provide enough contentpublic void writeString(char[] text, int offset, int len) throws IOException
JsonGenerator
writeString
in class JsonGenerator
text
- 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 writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeString(SerializableString text) throws IOException
JsonGenerator
JsonGenerator.writeString(String)
, but that takes
SerializableString
which can make this potentially
more efficient to call as generator may be able to reuse
quoted and/or encoded representation.
Default implementation just calls JsonGenerator.writeString(String)
;
sub-classes should override it with more efficient implementation
if possible.
writeString
in class JsonGenerator
text
- Pre-encoded String value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRawUTF8String(byte[] text, int offset, int length) throws IOException
JsonGenerator
JsonGenerator.writeString(String)
but that takes as
its input a UTF-8 encoded String that is to be output as-is, without additional
escaping (type of which depends on data format; backslashes for JSON).
However, quoting that data format requires (like double-quotes for JSON) will be added
around the value if and as necessary.
Note that some backends may choose not to support this method: for
example, if underlying destination is a Writer
using this method would require UTF-8 decoding.
If so, implementation may instead choose to throw a
UnsupportedOperationException
due to ineffectiveness
of having to decode input.
writeRawUTF8String
in class JsonGenerator
text
- 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 writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeUTF8String(byte[] text, int offset, int length) throws IOException
JsonGenerator
JsonGenerator.writeString(String)
but that takes as its input
a UTF-8 encoded String which has not been escaped using whatever
escaping scheme data format requires (for JSON that is backslash-escaping
for control characters and double-quotes; for other formats something else).
This means that textual JSON backends need to check if value needs
JSON escaping, but otherwise can just be copied as is to output.
Also, quoting that data format requires (like double-quotes for JSON) will be added
around the value if and as necessary.
Note that some backends may choose not to support this method: for
example, if underlying destination is a Writer
using this method would require UTF-8 decoding.
In this case
generator implementation may instead choose to throw a
UnsupportedOperationException
due to ineffectiveness
of having to decode input.
writeUTF8String
in class JsonGenerator
text
- 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 writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(String text) throws IOException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
writeRaw
in class JsonGenerator
text
- Textual contents to include as-is in output.IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(String text, int offset, int len) throws IOException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
writeRaw
in class JsonGenerator
text
- 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 outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(SerializableString raw) throws IOException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
The default implementation delegates to JsonGenerator.writeRaw(String)
;
other backends that support raw inclusion of text are encouraged
to implement it in more efficient manner (especially if they
use UTF-8 encoding).
writeRaw
in class JsonGenerator
raw
- Pre-encoded textual contents to included in outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(char[] text, int offset, int len) throws IOException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
writeRaw
in class JsonGenerator
text
- 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 outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRaw(char c) throws IOException
JsonGenerator
JsonGenerator.writeRawValue(String)
instead.
Note that not all generator implementations necessarily support
such by-pass methods: those that do not will throw
UnsupportedOperationException
.
writeRaw
in class JsonGenerator
c
- Character to included in outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRawValue(String text) throws IOException
JsonGenerator
writeRawValue
in class JsonGenerator
text
- Textual contents to included in outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeRawValue(String text, int offset, int len) throws IOException
writeRawValue
in class JsonGenerator
IOException
public void writeRawValue(char[] text, int offset, int len) throws IOException
writeRawValue
in class JsonGenerator
IOException
public 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 JsonGenerator
b64variant
- Base64 variant to use: defines details such as
whether padding is used (and if so, using which character);
what is the maximum line length before adding linefeed,
and also the underlying alphabet to use.data
- Buffer that contains binary data to writeoffset
- Offset in data
of the first byte of data to writelen
- Length of data to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws IOException
JsonGenerator
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.writeBinary
in class JsonGenerator
b64variant
- Base64 variant to usedata
- InputStream to use for reading binary data to write.
Will not be closed after successful write operationdataLength
- (optional) number of bytes that will be available;
or -1 to be indicate it is not known.
If a positive length is given, data
MUST provide at least
that many bytes: if not, an exception will be thrown.
Note that implementations
need not support cases where length is not known in advance; this
depends on underlying data format: JSON output does NOT require length,
other formats may.data
and written as binary payloadIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(short v) throws IOException
JsonGenerator
writeNumber
in class JsonGenerator
v
- Number value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(int v) throws IOException
JsonGenerator
writeNumber
in class JsonGenerator
v
- Number value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(long v) throws IOException
JsonGenerator
writeNumber
in class JsonGenerator
v
- Number value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(BigInteger v) throws IOException
JsonGenerator
writeNumber
in class JsonGenerator
v
- Number value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(double v) throws IOException
JsonGenerator
writeNumber
in class JsonGenerator
v
- Number value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(float v) throws IOException
JsonGenerator
writeNumber
in class JsonGenerator
v
- Number value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(BigDecimal v) throws IOException
JsonGenerator
writeNumber
in class JsonGenerator
v
- Number value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNumber(String encodedValue) throws IOException, UnsupportedOperationException
JsonGenerator
JsonGenerator.writeString(java.lang.String)
method can not be used; nor
JsonGenerator.writeRaw(java.lang.String)
because that does not properly handle
value separators needed in Array or Object contexts.
Note: because of lack of type safety, some generator
implementations may not be able to implement this
method. For example, if a binary JSON format is used,
it may require type information for encoding; similarly
for generator-wrappers around Java objects or JSON nodes.
If implementation does not implement this method,
it needs to throw UnsupportedOperationException
.
writeNumber
in class JsonGenerator
encodedValue
- Textual (possibly format) number representation to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerUnsupportedOperationException
- 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)public void writeNumber(char[] encodedValueBuffer, int offset, int length) throws IOException, UnsupportedOperationException
JsonGenerator
JsonGenerator.writeNumber(String)
with same semantics
but possibly more efficient operation.writeNumber
in class JsonGenerator
encodedValueBuffer
- Buffer that contains the textual number representation to writeoffset
- Offset of the first character of value to writelength
- Length of the value (in characters) to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerUnsupportedOperationException
public void writeBoolean(boolean state) throws IOException
JsonGenerator
writeBoolean
in class JsonGenerator
state
- Boolean value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeNull() throws IOException
JsonGenerator
writeNull
in class JsonGenerator
IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeOmittedField(String fieldName) throws IOException
JsonGenerator
false
from JsonGenerator.canOmitFields()
.
Default implementation does nothing.
writeOmittedField
in class JsonGenerator
fieldName
- Name of the field omittedIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeObjectId(Object id) throws IOException
JsonGenerator
JsonGenerator.canWriteObjectId()
), as not all data formats
have native type id support; and some may only allow them in
certain positions or locations.
If output is not allowed by the data format in this position,
a JsonGenerationException
will be thrown.writeObjectId
in class JsonGenerator
id
- Native Object Id to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerJsonGenerationException
- if Object ID output is not allowed
(either at all, or specifically in this position in output)public void writeObjectRef(Object id) throws IOException
JsonGenerator
JsonGenerator.canWriteObjectId()
), as not all data formats
have native type id support; and some may only allow them in
certain positions or locations.
If output is not allowed by the data format in this position,
a JsonGenerationException
will be thrown.writeObjectRef
in class JsonGenerator
id
- Referenced value, for which Object Id is expected to be writtenIOException
- if there is either an underlying I/O problem or encoding
issue at format layerJsonGenerationException
- if Object ID output is not allowed
(either at all, or specifically in this position in output)public void writeTypeId(Object id) throws IOException
JsonGenerator
JsonGenerator.canWriteTypeId()
), as not all data formats
have native type id support; and some may only allow them in
certain positions or locations.
If output is not allowed by the data format in this position,
a JsonGenerationException
will be thrown.writeTypeId
in class JsonGenerator
id
- Native Type Id to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerJsonGenerationException
- if Type ID output is not allowed
(either at all, or specifically in this position in output)public void writeEmbeddedObject(Object object) throws IOException
JsonGenerator
NOTE: this is NOT the method to call for serializing regular POJOs,
see JsonGenerator.writeObject(java.lang.Object)
instead.
writeEmbeddedObject
in class JsonGenerator
object
- Native format-specific value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeObject(Object pojo) throws IOException
JsonGenerator
writeObject
in class JsonGenerator
pojo
- General POJO value to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void writeTree(TreeNode tree) throws IOException
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
with given node, but is added
for convenience and to make code more explicit in cases
where it deals specifically with trees.writeTree
in class JsonGenerator
tree
- TreeNode
to writeIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void copyCurrentEvent(JsonParser p) throws IOException
JsonGenerator
Calling this method will not advance the given parser, although it may cause parser to internally process more data (if it lazy loads contents of value events, for example)
copyCurrentEvent
in class JsonGenerator
p
- Parser that points to event (token) to copyIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void copyCurrentStructure(JsonParser p) throws IOException
JsonGenerator
So what constitutes enclosing? Here is the list of events that have associated enclosed events that will get copied:
JsonToken.START_OBJECT
:
all events up to and including matching (closing)
JsonToken.END_OBJECT
will be copied
JsonToken.START_ARRAY
all events up to and including matching (closing)
JsonToken.END_ARRAY
will be copied
JsonToken.FIELD_NAME
the logical value (which
can consist of a single scalar value; or a sequence of related
events for structured types (JSON Arrays, Objects)) will
be copied along with the name itself. So essentially the
whole field entry (name and value) will be copied.
After calling this method, parser will point to the last event that was copied. This will either be the event parser already pointed to (if there were no enclosed events), or the last enclosed event copied.
copyCurrentStructure
in class JsonGenerator
p
- Parser that points to the value to copyIOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic JsonStreamContext getOutputContext()
JsonGenerator
getOutputContext
in class JsonGenerator
JsonStreamContext
) associated with this generatorpublic void flush() throws IOException
JsonGenerator
flush
in interface Flushable
flush
in class JsonGenerator
IOException
- if there is either an underlying I/O problem or encoding
issue at format layerpublic void close() throws IOException
JsonGenerator
Whether the underlying target (stream, writer) gets closed depends
on whether this generator either manages the target (i.e. is the
only one with access to the target -- case if caller passes a
reference to the resource such as File, but not stream); or
has feature JsonGenerator.Feature.AUTO_CLOSE_TARGET
enabled.
If either of above is true, the target is also closed. Otherwise
(not managing, feature not enabled), target is not closed.
close
in interface Closeable
close
in interface AutoCloseable
close
in class JsonGenerator
IOException
- if there is either an underlying I/O problempublic boolean isClosed()
JsonGenerator
isClosed
in class JsonGenerator
True
if this generator instance has been closed@Deprecated public JsonGenerator getDelegate()
public JsonGenerator delegate()
Copyright © 2021 JBoss by Red Hat. All rights reserved.