Class ToXmlGenerator
- java.lang.Object
-
- com.fasterxml.jackson.core.JsonGenerator
-
- com.fasterxml.jackson.core.base.GeneratorBase
-
- com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator
-
- All Implemented Interfaces:
Versioned
,java.io.Closeable
,java.io.Flushable
,java.lang.AutoCloseable
public class ToXmlGenerator extends GeneratorBase
JsonGenerator
that outputs JAXB-style XML output instead of JSON content. Operation requires calling code (usually either standard Jackson serializers, or in some cases (likeBeanSerializer
) customized ones) to do additional configuration calls beyond regularJsonGenerator
API, mostly to pass namespace information.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ToXmlGenerator.Feature
Enumeration that defines all togglable extra XML-specific features
-
Field Summary
-
Fields inherited from class com.fasterxml.jackson.core.base.GeneratorBase
SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST
-
-
Constructor Summary
Constructors Constructor Description ToXmlGenerator(IOContext ctxt, int stdFeatures, int xmlFeatures, ObjectCodec codec, javax.xml.stream.XMLStreamWriter sw, XmlNameProcessor nameProcessor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
_handleEndObject()
void
_handleStartObject()
boolean
canWriteFormattedNumbers()
Introspection method to call to check whether it is possible to write numbers usingJsonGenerator.writeNumber(java.lang.String)
using possible custom format, or not.void
close()
Method called to close this generator, so that no more content can be written.ToXmlGenerator
configure(ToXmlGenerator.Feature f, boolean state)
ToXmlGenerator
disable(ToXmlGenerator.Feature f)
ToXmlGenerator
enable(ToXmlGenerator.Feature f)
void
finishWrappedValue(javax.xml.namespace.QName wrapperName, javax.xml.namespace.QName wrappedName)
Method called after a structured collection output has completedvoid
flush()
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.int
getFormatFeatures()
Bulk access method for getting state of allFormatFeature
s, format-specific on/off configuration settings.int
getOutputBuffered()
Stax2 does not expose buffered content amount, so we can only return-1
from herejava.lang.Object
getOutputTarget()
Method that can be used to get access to object that is used as target for generated output; this is usually eitherOutputStream
orWriter
, depending on what generator was constructed with.javax.xml.stream.XMLStreamWriter
getStaxWriter()
Method that allows application direct access to underlying StaxXMLStreamWriter
.JacksonFeatureSet<StreamWriteCapability>
getWriteCapabilities()
Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).void
initGenerator()
Method called before writing any other output, to optionally output XML declaration.boolean
inRoot()
boolean
isEnabled(ToXmlGenerator.Feature f)
JsonGenerator
overrideFormatFeatures(int values, int mask)
Bulk set method for (re)setting states ofFormatFeature
s, by specifying values (set / clear) along with a mask, to determine which features to change, if any.void
setNextIsAttribute(boolean isAttribute)
void
setNextIsCData(boolean isCData)
void
setNextIsUnwrapped(boolean isUnwrapped)
void
setNextName(javax.xml.namespace.QName name)
boolean
setNextNameIfMissing(javax.xml.namespace.QName name)
Method that does same assetNextName(javax.xml.namespace.QName)
, unless a name has already been set.JsonGenerator
setPrettyPrinter(PrettyPrinter pp)
Method for setting a custom pretty printer, which is usually used to add indentation for improved human readability.void
startWrappedValue(javax.xml.namespace.QName wrapperName, javax.xml.namespace.QName wrappedName)
Methdod called when a structured (collection, array, map) is being output.StreamWriteConstraints
streamWriteConstraints()
Get the constraints to apply when performing streaming writes.void
writeBinary(Base64Variant b64variant, byte[] data, int offset, int len)
Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes).int
writeBinary(Base64Variant b64variant, java.io.InputStream data, int dataLength)
Method similar toJsonGenerator.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 value)
Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').void
writeEndArray()
Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).void
writeEndObject()
Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).void
writeFieldName(SerializableString name)
Method similar toJsonGenerator.writeFieldName(String)
, main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.void
writeFieldName(java.lang.String name)
Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.void
writeNull()
Method for outputting literal JSON null value.void
writeNumber(double d)
Method for outputting indicate JSON numeric value.void
writeNumber(float f)
Method for outputting indicate JSON numeric value.void
writeNumber(int i)
Method for outputting given value as JSON number.void
writeNumber(long l)
Method for outputting given value as JSON number.void
writeNumber(java.lang.String encodedValue)
Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types.void
writeNumber(java.math.BigDecimal dec)
Method for outputting indicate JSON numeric value.void
writeNumber(java.math.BigInteger value)
Method for outputting given value as JSON number.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(java.lang.String text)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).void
writeRaw(java.lang.String text, int offset, int len)
Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).void
writeRawUTF8String(byte[] text, int offset, int length)
Method similar toJsonGenerator.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(SerializableString text)
Method similar toJsonGenerator.writeRawValue(String)
, but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.writeRaw(SerializableString)
.void
writeRawValue(java.lang.String text)
Method that will force generator to copy input text verbatim without any modifications, but assuming it must constitute a single legal JSON value (number, string, boolean, null, Array or List).void
writeRawValue(java.lang.String text, int offset, int len)
void
writeRepeatedFieldName()
Trivial helper method called when to add a replicated wrapper namevoid
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
writeStartObject()
Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).void
writeString(char[] text, int offset, int len)
Method for outputting a String value.void
writeString(SerializableString text)
Method similar toJsonGenerator.writeString(String)
, but that takesSerializableString
which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.void
writeString(java.lang.String text)
Method for outputting a String value.void
writeStringField(java.lang.String fieldName, java.lang.String value)
Convenience method for outputting a field entry ("member") that has a String value.void
writeUTF8String(byte[] text, int offset, int length)
Method similar toJsonGenerator.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).-
Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase
disable, enable, getCodec, getCurrentValue, getFeatureMask, getOutputContext, isClosed, isEnabled, overrideStdFeatures, setCodec, setCurrentValue, setFeatureMask, useDefaultPrettyPrinter, version, writeObject, writeStartObject, writeTree
-
Methods inherited from class com.fasterxml.jackson.core.JsonGenerator
assignCurrentValue, canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteObjectId, canWriteTypeId, configure, copyCurrentEvent, copyCurrentEventExact, copyCurrentStructure, currentValue, getCharacterEscapes, getHighestEscapedChar, getPrettyPrinter, getSchema, isEnabled, setCharacterEscapes, setHighestNonEscapedChar, setRootValueSeparator, setSchema, writeArray, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeEmbeddedObject, writeFieldId, writeNullField, writeNumber, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectId, writeObjectRef, writeOmittedField, writePOJO, writePOJOField, writeRaw, writeStartArray, writeStartArray, writeStartArray, writeStartObject, writeString, writeTypeId, writeTypePrefix, writeTypeSuffix
-
-
-
-
Constructor Detail
-
ToXmlGenerator
public ToXmlGenerator(IOContext ctxt, int stdFeatures, int xmlFeatures, ObjectCodec codec, javax.xml.stream.XMLStreamWriter sw, XmlNameProcessor nameProcessor)
-
-
Method Detail
-
initGenerator
public void initGenerator() throws java.io.IOException
Method called before writing any other output, to optionally output XML declaration.- Throws:
java.io.IOException
-
setPrettyPrinter
public JsonGenerator setPrettyPrinter(PrettyPrinter pp)
Description copied from class:JsonGenerator
Method for setting a custom pretty printer, which is usually used to add indentation for improved human readability. By default, generator does not do pretty printing.To use the default pretty printer that comes with core Jackson distribution, call
JsonGenerator.useDefaultPrettyPrinter()
instead.- Overrides:
setPrettyPrinter
in classJsonGenerator
- Parameters:
pp
-PrettyPrinter
to assign, if any;null
if none- Returns:
- This generator, to allow call chaining
-
getOutputTarget
public java.lang.Object getOutputTarget()
Description copied from class:JsonGenerator
Method that can be used to get access to object that is used as target for generated output; this is usually eitherOutputStream
orWriter
, 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.
- Overrides:
getOutputTarget
in classJsonGenerator
- Returns:
- Output target this generator was configured with
-
getOutputBuffered
public int getOutputBuffered()
Stax2 does not expose buffered content amount, so we can only return-1
from here- Overrides:
getOutputBuffered
in classJsonGenerator
- Returns:
- Amount of content buffered in internal units, if amount known and accessible; -1 if not accessible.
-
getFormatFeatures
public int getFormatFeatures()
Description copied from class:JsonGenerator
Bulk access method for getting state of allFormatFeature
s, format-specific on/off configuration settings.- Overrides:
getFormatFeatures
in classJsonGenerator
- Returns:
- Bit mask that defines current states of all standard
FormatFeature
s.
-
overrideFormatFeatures
public JsonGenerator overrideFormatFeatures(int values, int mask)
Description copied from class:JsonGenerator
Bulk set method for (re)setting states ofFormatFeature
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.- Overrides:
overrideFormatFeatures
in classJsonGenerator
- Parameters:
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to change- Returns:
- This generator, to allow call chaining
-
streamWriteConstraints
public StreamWriteConstraints streamWriteConstraints()
Description copied from class:JsonGenerator
Get the constraints to apply when performing streaming writes.- Overrides:
streamWriteConstraints
in classJsonGenerator
-
enable
public ToXmlGenerator enable(ToXmlGenerator.Feature f)
-
disable
public ToXmlGenerator disable(ToXmlGenerator.Feature f)
-
isEnabled
public final boolean isEnabled(ToXmlGenerator.Feature f)
-
configure
public ToXmlGenerator configure(ToXmlGenerator.Feature f, boolean state)
-
canWriteFormattedNumbers
public boolean canWriteFormattedNumbers()
Description copied from class:JsonGenerator
Introspection method to call to check whether it is possible to write numbers usingJsonGenerator.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.- Overrides:
canWriteFormattedNumbers
in classJsonGenerator
- Returns:
True
if this generator is capable of writing "formatted" numbers (and if so, need to be passed usingJsonGenerator.writeNumber(String)
, that is, passed asString
);false
if not
-
getWriteCapabilities
public JacksonFeatureSet<StreamWriteCapability> getWriteCapabilities()
Description copied from class:JsonGenerator
Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).- Overrides:
getWriteCapabilities
in classJsonGenerator
- Returns:
- Set of write capabilities for content written using this generator
-
inRoot
public boolean inRoot()
-
getStaxWriter
public javax.xml.stream.XMLStreamWriter getStaxWriter()
Method that allows application direct access to underlying StaxXMLStreamWriter
. Note that use of writer is discouraged, and may interfere with processing of this writer; however, occasionally it may be necessary.Note: writer instance will always be of type
XMLStreamWriter2
(including Typed Access API) so upcasts are safe.
-
setNextIsAttribute
public void setNextIsAttribute(boolean isAttribute)
-
setNextIsUnwrapped
public void setNextIsUnwrapped(boolean isUnwrapped)
-
setNextIsCData
public void setNextIsCData(boolean isCData)
-
setNextName
public final void setNextName(javax.xml.namespace.QName name)
-
setNextNameIfMissing
public final boolean setNextNameIfMissing(javax.xml.namespace.QName name)
Method that does same assetNextName(javax.xml.namespace.QName)
, unless a name has already been set.- Since:
- 2.1.2
-
startWrappedValue
public void startWrappedValue(javax.xml.namespace.QName wrapperName, javax.xml.namespace.QName wrappedName) throws java.io.IOException
Methdod called when a structured (collection, array, map) is being output.- Parameters:
wrapperName
- Element used as wrapper around elements, if any (null if none)wrappedName
- Element used around individual content items (can not be null)- Throws:
java.io.IOException
-
finishWrappedValue
public void finishWrappedValue(javax.xml.namespace.QName wrapperName, javax.xml.namespace.QName wrappedName) throws java.io.IOException
Method called after a structured collection output has completed- Throws:
java.io.IOException
-
writeRepeatedFieldName
public void writeRepeatedFieldName() throws java.io.IOException
Trivial helper method called when to add a replicated wrapper name- Throws:
java.io.IOException
- Since:
- 2.2
-
writeFieldName
public final void writeFieldName(java.lang.String name) throws java.io.IOException
Description copied from class:JsonGenerator
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.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).
- Specified by:
writeFieldName
in classJsonGenerator
- Parameters:
name
- Field name to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStringField
public final void writeStringField(java.lang.String fieldName, java.lang.String value) throws java.io.IOException
Description copied from class:JsonGenerator
Convenience method for outputting a field entry ("member") that has a String value. Equivalent to:writeFieldName(fieldName); writeString(value);
- Overrides:
writeStringField
in classJsonGenerator
- Parameters:
fieldName
- Name of the field to writevalue
- String value of the field to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartArray
public final void writeStartArray() throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
- Specified by:
writeStartArray
in classJsonGenerator
- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeEndArray
public final void writeEndArray() throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).Marker can be written if the innermost structured type is Array.
- Specified by:
writeEndArray
in classJsonGenerator
- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartObject
public final void writeStartObject() throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
- Specified by:
writeStartObject
in classJsonGenerator
- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeEndObject
public final void writeEndObject() throws java.io.IOException
Description copied from class:JsonGenerator
Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).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).
- Specified by:
writeEndObject
in classJsonGenerator
- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
_handleStartObject
public final void _handleStartObject() throws java.io.IOException
- Throws:
java.io.IOException
-
_handleEndObject
public final void _handleEndObject() throws java.io.IOException
- Throws:
java.io.IOException
-
writeFieldName
public void writeFieldName(SerializableString name) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.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.
- Overrides:
writeFieldName
in classGeneratorBase
- Parameters:
name
- Field name to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
public void writeString(java.lang.String text) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.- Specified by:
writeString
in classJsonGenerator
- Parameters:
text
- Text value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
public void writeString(char[] text, int offset, int len) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.- Specified by:
writeString
in classJsonGenerator
- Parameters:
text
- Buffer that contains String value to writeoffset
- Offset inbuffer
of the first character of String value to writelen
- Length of the String value (in characters) to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
public void writeString(SerializableString text) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeString(String)
, but that takesSerializableString
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.- Overrides:
writeString
in classGeneratorBase
- Parameters:
text
- Pre-encoded String value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawUTF8String
public void writeRawUTF8String(byte[] text, int offset, int length) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.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 aUnsupportedOperationException
due to ineffectiveness of having to decode input.- Specified by:
writeRawUTF8String
in classJsonGenerator
- Parameters:
text
- Buffer that contains String value to writeoffset
- Offset inbuffer
of the first byte of String value to writelength
- Length of the String value (in characters) to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeUTF8String
public void writeUTF8String(byte[] text, int offset, int length) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.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 aUnsupportedOperationException
due to ineffectiveness of having to decode input.- Specified by:
writeUTF8String
in classJsonGenerator
- Parameters:
text
- Buffer that contains String value to writeoffset
- Offset inbuffer
of the first byte of String value to writelength
- Length of the String value (in characters) to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawValue
public void writeRawValue(java.lang.String text) throws java.io.IOException
Description copied from class:JsonGenerator
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). Assuming this, proper separators are added if and as needed (comma or colon), and generator state updated to reflect this.- Overrides:
writeRawValue
in classGeneratorBase
- Parameters:
text
- Textual contents to included in output- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawValue
public void writeRawValue(java.lang.String text, int offset, int len) throws java.io.IOException
- Overrides:
writeRawValue
in classGeneratorBase
- Throws:
java.io.IOException
-
writeRawValue
public void writeRawValue(char[] text, int offset, int len) throws java.io.IOException
- Overrides:
writeRawValue
in classGeneratorBase
- Throws:
java.io.IOException
-
writeRawValue
public void writeRawValue(SerializableString text) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeRawValue(String)
, but potentially more efficient as it may be able to use pre-encoded content (similar toJsonGenerator.writeRaw(SerializableString)
.- Overrides:
writeRawValue
in classGeneratorBase
- Parameters:
text
- Pre-encoded textual contents to included in output- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
public void writeRaw(java.lang.String text) throws java.io.IOException
Description copied from class:JsonGenerator
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). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.- Specified by:
writeRaw
in classJsonGenerator
- Parameters:
text
- Textual contents to include as-is in output.- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
public void writeRaw(java.lang.String text, int offset, int len) throws java.io.IOException
Description copied from class:JsonGenerator
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). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.- Specified by:
writeRaw
in classJsonGenerator
- Parameters:
text
- String that has contents to include as-is in outputoffset
- Offset withintext
of the first character to outputlen
- Length of content (fromtext
, starting at offsetoffset
) to output- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
public void writeRaw(char[] text, int offset, int len) throws java.io.IOException
Description copied from class:JsonGenerator
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). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.- Specified by:
writeRaw
in classJsonGenerator
- Parameters:
text
- Buffer that has contents to include as-is in outputoffset
- Offset withintext
of the first character to outputlen
- Length of content (fromtext
, starting at offsetoffset
) to output- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
public void writeRaw(char c) throws java.io.IOException
Description copied from class:JsonGenerator
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). If such separators are desired, useJsonGenerator.writeRawValue(String)
instead.Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw
UnsupportedOperationException
.- Specified by:
writeRaw
in classJsonGenerator
- Parameters:
c
- Character to included in output- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeBinary
public void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws java.io.IOException
Description copied from class:JsonGenerator
Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes). This method defaultsNote: 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.- Specified by:
writeBinary
in classJsonGenerator
- Parameters:
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 indata
of the first byte of data to writelen
- Length of data to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeBinary
public int writeBinary(Base64Variant b64variant, java.io.InputStream data, int dataLength) throws java.io.IOException
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeBinary(Base64Variant,byte[],int,int)
, but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.- Overrides:
writeBinary
in classGeneratorBase
- Parameters:
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.- Returns:
- Number of bytes read from
data
and written as binary payload - Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeBoolean
public void writeBoolean(boolean value) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting literal JSON boolean value (one of Strings 'true' and 'false'). Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeBoolean
in classJsonGenerator
- Parameters:
value
- Boolean value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNull
public void writeNull() throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting literal JSON null value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNull
in classJsonGenerator
- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
public void writeNumber(int i) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
i
- Number value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
public void writeNumber(long l) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
l
- Number value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
public void writeNumber(double d) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
d
- Number value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
public void writeNumber(float f) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
f
- Number value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
public void writeNumber(java.math.BigDecimal dec) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
dec
- Number value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
public void writeNumber(java.math.BigInteger value) throws java.io.IOException
Description copied from class:JsonGenerator
Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
value
- Number value to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
public void writeNumber(java.lang.String encodedValue) throws java.io.IOException, java.lang.UnsupportedOperationException
Description copied from class:JsonGenerator
Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types. Because numbers are not surrounded by double quotes, regularJsonGenerator.writeString(java.lang.String)
method can not be used; norJsonGenerator.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
.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
encodedValue
- Textual (possibly format) number representation to write- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layerjava.lang.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)
-
flush
public void flush() throws java.io.IOException
Description copied from class:JsonGenerator
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.- Specified by:
flush
in interfacejava.io.Flushable
- Specified by:
flush
in classGeneratorBase
- Throws:
java.io.IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
close
public void close() throws java.io.IOException
Description copied from class:JsonGenerator
Method called to close this generator, so that no more content can be written.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.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classGeneratorBase
- Throws:
java.io.IOException
- if there is either an underlying I/O problem
-
-