com.fasterxml.jackson.core.json

Class WriterBasedJsonGenerator

java.lang.Object

com.fasterxml.jackson.core.JsonGenerator

com.fasterxml.jackson.core.base.GeneratorBase

com.fasterxml.jackson.core.json.JsonGeneratorImpl

com.fasterxml.jackson.core.json.WriterBasedJsonGenerator

All Implemented Interfaces:

Versioned, Closeable, Flushable, AutoCloseable

public final class WriterBasedJsonGenerator
extends JsonGeneratorImpl

JsonGenerator that outputs JSON content using a Writer which handles character encoding.

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonGenerator

JsonGenerator.Feature

Field Summary

Fields

Modifier and Type	Field and Description
protected SerializableString	_currentEscape When custom escapes are used, this member variable is used internally to hold a reference to currently used escape
protected char[]	_entityBuffer Short (14 char) temporary buffer allocated if needed, for constructing escape sequences
protected char[]	_outputBuffer Intermediate buffer in which contents are buffered before being written using _writer.
protected int	_outputEnd End marker of the output buffer; one past the last valid position within the buffer.
protected int	_outputHead Pointer to the first buffered character to output
protected int	_outputTail Pointer to the position right beyond the last character to output (end marker; may point to position right beyond the end of the buffer)
protected Writer	_writer
protected static char[]	HEX_CHARS
protected static int	SHORT_WRITE

Fields inherited from class com.fasterxml.jackson.core.json.JsonGeneratorImpl

_characterEscapes, _ioContext, _maximumNonEscapedChar, _outputEscapes, _rootValueSeparator, sOutputEscapes

Fields inherited from class com.fasterxml.jackson.core.base.GeneratorBase

_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext, DERIVED_FEATURES_MASK, SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST

Fields inherited from class com.fasterxml.jackson.core.JsonGenerator

_cfgPrettyPrinter

Constructor Summary

Constructors

Constructor and Description
WriterBasedJsonGenerator(IOContext ctxt, int features, ObjectCodec codec, Writer w)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_flushBuffer()
protected void	_releaseBuffers() Method called to release any buffers generator may be holding, once generator is being closed.
protected void	_verifyPrettyValueWrite(String typeMsg)
protected void	_verifyValueWrite(String typeMsg) Method called before trying to write a value (scalar or structured), to verify that this is legal in current output state, as well as to output separators if and as necessary.
protected void	_writeBinary(Base64Variant b64variant, byte[] input, int inputPtr, int inputEnd)
protected int	_writeBinary(Base64Variant b64variant, InputStream data, byte[] readBuffer)
protected int	_writeBinary(Base64Variant b64variant, InputStream data, byte[] readBuffer, int bytesLeft)
protected void	_writeFieldName(SerializableString name, boolean commaBefore)
protected void	_writeFieldName(String name, boolean commaBefore)
protected void	_writePPFieldName(SerializableString name, boolean commaBefore)
protected void	_writePPFieldName(String name, boolean commaBefore) Specialized version of _writeFieldName, off-lined to keep the "fast path" as simple (and hopefully fast) as possible.
void	close() Method called to close this generator, so that no more content can be written.
void	flush() Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
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.
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	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 a JSON Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).
void	writeFieldName(SerializableString name) Method similar to JsonGenerator.writeFieldName(String), main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.
void	writeFieldName(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 value) Method for outputting indicate Json numeric value.
void	writeNumber(BigInteger value) Method for outputting given value as Json number.
void	writeNumber(double d) Method for outputting indicate Json numeric value.
void	writeNumber(float f) Method for outputting indicate Json numeric value.
void	writeNumber(int i) Method for outputting given value as Json number.
void	writeNumber(long l) Method for outputting given value as Json number.
void	writeNumber(short s) 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	writeRaw(char c) Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
void	writeRaw(char[] text, int offset, int len) Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
void	writeRaw(SerializableString text) Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
void	writeRaw(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 start, 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	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 a JSON 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 sstr) 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	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).

Methods inherited from class com.fasterxml.jackson.core.json.JsonGeneratorImpl

getCharacterEscapes, getHighestEscapedChar, setCharacterEscapes, setHighestNonEscapedChar, setRootValueSeparator, version, writeStringField

Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase

_decodeSurrogate, disable, enable, getCodec, getCurrentValue, getFeatureMask, getOutputContext, isClosed, isEnabled, setCodec, setCurrentValue, setFeatureMask, useDefaultPrettyPrinter, writeObject, writeRawValue, writeRawValue, writeRawValue, writeRawValue, writeTree

Methods inherited from class com.fasterxml.jackson.core.JsonGenerator

_reportError, _reportUnsupportedOperation, _throwInternal, _writeSimpleObject, canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteObjectId, canWriteTypeId, configure, copyCurrentEvent, copyCurrentStructure, getPrettyPrinter, getSchema, setPrettyPrinter, setSchema, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectId, writeObjectRef, writeOmittedField, writeStartArray, writeTypeId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHORT_WRITE

protected static final int SHORT_WRITE

See Also:

Constant Field Values

HEX_CHARS

protected static final char[] HEX_CHARS

_writer

protected final Writer _writer

_outputBuffer

protected char[] _outputBuffer

Intermediate buffer in which contents are buffered before being written using _writer.

_outputHead

protected int _outputHead

Pointer to the first buffered character to output

_outputTail

protected int _outputTail

Pointer to the position right beyond the last character to output (end marker; may point to position right beyond the end of the buffer)

_outputEnd

protected int _outputEnd

End marker of the output buffer; one past the last valid position within the buffer.

_entityBuffer

protected char[] _entityBuffer

Short (14 char) temporary buffer allocated if needed, for constructing escape sequences

_currentEscape

protected SerializableString _currentEscape

When custom escapes are used, this member variable is used internally to hold a reference to currently used escape

Constructor Detail

WriterBasedJsonGenerator

public WriterBasedJsonGenerator(IOContext ctxt,
                        int features,
                        ObjectCodec codec,
                        Writer w)

Method Detail

getOutputTarget

public 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 either 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.

Overrides:

getOutputTarget in class JsonGenerator

writeFieldName

public void writeFieldName(String name)
                    throws 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 class JsonGenerator

Throws:

IOException

writeFieldName

public void writeFieldName(SerializableString name)
                    throws IOException

Description copied from class: JsonGenerator

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.

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 class GeneratorBase

Throws:

IOException

writeStartArray

public void writeStartArray()
                     throws IOException,
                            JsonGenerationException

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 class JsonGenerator

Throws:

IOException

JsonGenerationException

writeEndArray

public void writeEndArray()
                   throws IOException,
                          JsonGenerationException

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 class JsonGenerator

Throws:

IOException

JsonGenerationException

writeStartObject

public void writeStartObject()
                      throws IOException,
                             JsonGenerationException

Description copied from class: JsonGenerator

Method for writing starting marker of a JSON 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 class JsonGenerator

Throws:

IOException

JsonGenerationException

writeEndObject

public void writeEndObject()
                    throws IOException,
                           JsonGenerationException

Description copied from class: JsonGenerator

Method for writing closing marker of a JSON 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 class JsonGenerator

Throws:

IOException

JsonGenerationException

_writeFieldName

protected void _writeFieldName(String name,
                   boolean commaBefore)
                        throws IOException

Throws:

IOException

_writeFieldName

protected void _writeFieldName(SerializableString name,
                   boolean commaBefore)
                        throws IOException

Throws:

IOException

_writePPFieldName

protected void _writePPFieldName(String name,
                     boolean commaBefore)
                          throws IOException,
                                 JsonGenerationException

Specialized version of _writeFieldName, off-lined to keep the "fast path" as simple (and hopefully fast) as possible.

Throws:

IOException

JsonGenerationException

_writePPFieldName

protected void _writePPFieldName(SerializableString name,
                     boolean commaBefore)
                          throws IOException,
                                 JsonGenerationException

Throws:

IOException

JsonGenerationException

writeString

public void writeString(String text)
                 throws 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 class JsonGenerator

Throws:

IOException

writeString

public void writeString(char[] text,
               int offset,
               int len)
                 throws 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 class JsonGenerator

Throws:

IOException

writeString

public void writeString(SerializableString sstr)
                 throws IOException

Description copied from class: JsonGenerator

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.

Default implementation just calls JsonGenerator.writeString(String); sub-classes should override it with more efficient implementation if possible.

Overrides:

writeString in class GeneratorBase

Throws:

IOException

writeRawUTF8String

public void writeRawUTF8String(byte[] text,
                      int offset,
                      int length)
                        throws IOException

Description copied from class: JsonGenerator

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). 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.

Specified by:

writeRawUTF8String in class JsonGenerator

Throws:

IOException

writeUTF8String

public void writeUTF8String(byte[] text,
                   int offset,
                   int length)
                     throws IOException

Description copied from class: JsonGenerator

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). 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.

Specified by:

writeUTF8String in class JsonGenerator

Throws:

IOException

writeRaw

public void writeRaw(String text)
              throws 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, use JsonGenerator.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 class JsonGenerator

Throws:

IOException

writeRaw

public void writeRaw(String text,
            int start,
            int len)
              throws 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, use JsonGenerator.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 class JsonGenerator

Throws:

IOException

writeRaw

public void writeRaw(SerializableString text)
              throws 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, use 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).

Overrides:

writeRaw in class JsonGenerator

Throws:

IOException

writeRaw

public void writeRaw(char[] text,
            int offset,
            int len)
              throws 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, use JsonGenerator.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 class JsonGenerator

Throws:

IOException

writeRaw

public void writeRaw(char c)
              throws 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, use JsonGenerator.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 class JsonGenerator

Throws:

IOException

writeBinary

public void writeBinary(Base64Variant b64variant,
               byte[] data,
               int offset,
               int len)
                 throws IOException,
                        JsonGenerationException

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 defaults

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.

Specified by:

writeBinary in class JsonGenerator

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.

Throws:

IOException

JsonGenerationException

writeBinary

public int writeBinary(Base64Variant b64variant,
              InputStream data,
              int dataLength)
                throws IOException,
                       JsonGenerationException

Description copied from class: JsonGenerator

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.

Overrides:

writeBinary in class GeneratorBase

Parameters:

b64variant - Base64 variant to use

data - InputStream to use for reading binary data to write. Will not be closed after successful write operation

dataLength - (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:

IOException

JsonGenerationException

writeNumber

public void writeNumber(short s)
                 throws 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.

Overrides:

writeNumber in class JsonGenerator

Throws:

IOException

writeNumber

public void writeNumber(int i)
                 throws 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 class JsonGenerator

Throws:

IOException

writeNumber

public void writeNumber(long l)
                 throws 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 class JsonGenerator

Throws:

IOException

writeNumber

public void writeNumber(BigInteger value)
                 throws 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 class JsonGenerator

Throws:

IOException

writeNumber

public void writeNumber(double d)
                 throws 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 class JsonGenerator

Throws:

IOException

writeNumber

public void writeNumber(float f)
                 throws 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 class JsonGenerator

Throws:

IOException

writeNumber

public void writeNumber(BigDecimal value)
                 throws 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 class JsonGenerator

Throws:

IOException

writeNumber

public void writeNumber(String encodedValue)
                 throws IOException

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, regular 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.

Specified by:

writeNumber in class JsonGenerator

Throws:

IOException

writeBoolean

public void writeBoolean(boolean state)
                  throws 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 class JsonGenerator

Throws:

IOException

writeNull

public void writeNull()
               throws 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 class JsonGenerator

Throws:

IOException

_verifyValueWrite

protected void _verifyValueWrite(String typeMsg)
                          throws IOException

Description copied from class: GeneratorBase

Method called before trying to write a value (scalar or structured), to verify that this is legal in current output state, as well as to output separators if and as necessary.

Specified by:

_verifyValueWrite in class GeneratorBase

Parameters:

typeMsg - Additional message used for generating exception message if value output is NOT legal in current generator output state.

Throws:

IOException

_verifyPrettyValueWrite

protected void _verifyPrettyValueWrite(String typeMsg)
                                throws IOException

Throws:

IOException

flush

public void flush()
           throws 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 interface Flushable

Specified by:

flush in class GeneratorBase

Throws:

IOException

close

public void close()
           throws 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 interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class GeneratorBase

Throws:

IOException

_releaseBuffers

protected void _releaseBuffers()

Description copied from class: GeneratorBase

Method called to release any buffers generator may be holding, once generator is being closed.

Specified by:

_releaseBuffers in class GeneratorBase

_writeBinary

protected void _writeBinary(Base64Variant b64variant,
                byte[] input,
                int inputPtr,
                int inputEnd)
                     throws IOException,
                            JsonGenerationException

Throws:

IOException

JsonGenerationException

_writeBinary

protected int _writeBinary(Base64Variant b64variant,
               InputStream data,
               byte[] readBuffer,
               int bytesLeft)
                    throws IOException,
                           JsonGenerationException

Throws:

IOException

JsonGenerationException

_writeBinary

protected int _writeBinary(Base64Variant b64variant,
               InputStream data,
               byte[] readBuffer)
                    throws IOException,
                           JsonGenerationException

Throws:

IOException

JsonGenerationException

_flushBuffer

protected void _flushBuffer()
                     throws IOException

Throws:

IOException