com.fasterxml.jackson.core.json

Class UTF8JsonGenerator

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

All Implemented Interfaces:

Versioned, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class UTF8JsonGenerator
extends JsonGeneratorImpl

Nested Class Summary

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

JsonGenerator.Feature

Field Summary

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

SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST

Constructor Summary

Constructors

Constructor and Description
UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out) Deprecated.
UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable) Deprecated.
UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, char quoteChar)
UTF8JsonGenerator(IOContext ctxt, int features, ObjectCodec codec, java.io.OutputStream out, char quoteChar, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable)

Method Summary

Modifier and Type	Method and Description
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.
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.
java.lang.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, java.io.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 an 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(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(java.math.BigDecimal value) Method for outputting indicate JSON numeric value.
void	writeNumber(java.math.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(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	writeRaw(char ch) 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[] cbuf, 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(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 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(SerializableString text) Method similar to JsonGenerator.writeRawValue(String), but potentially more efficient as it may be able to use pre-encoded content (similar to JsonGenerator.writeRaw(SerializableString).
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	writeStartObject() Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).
void	writeStartObject(java.lang.Object forValue) 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(java.io.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(java.lang.String text) Method for outputting a String value.
void	writeUTF8String(byte[] text, int offset, int len) 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

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

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

getCodec, getCurrentValue, getFeatureMask, getOutputContext, isClosed, isEnabled, overrideStdFeatures, setCodec, setCurrentValue, setFeatureMask, useDefaultPrettyPrinter, writeObject, writeRawValue, writeRawValue, writeRawValue, writeTree

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

canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteFormattedNumbers, canWriteObjectId, canWriteTypeId, configure, copyCurrentEvent, copyCurrentStructure, getFormatFeatures, getPrettyPrinter, getSchema, isEnabled, overrideFormatFeatures, setPrettyPrinter, setSchema, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeEmbeddedObject, writeFieldId, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectId, writeObjectRef, writeOmittedField, writeStartArray, writeStartArray, writeStartObject, writeTypeId, writeTypePrefix, writeTypeSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

UTF8JsonGenerator

public UTF8JsonGenerator(IOContext ctxt,
                         int features,
                         ObjectCodec codec,
                         java.io.OutputStream out,
                         char quoteChar)

Since:

2.10

UTF8JsonGenerator

public UTF8JsonGenerator(IOContext ctxt,
                         int features,
                         ObjectCodec codec,
                         java.io.OutputStream out,
                         char quoteChar,
                         byte[] outputBuffer,
                         int outputOffset,
                         boolean bufferRecyclable)

Since:

2.10

UTF8JsonGenerator

@Deprecated
public UTF8JsonGenerator(IOContext ctxt,
                                     int features,
                                     ObjectCodec codec,
                                     java.io.OutputStream out)

Deprecated.

UTF8JsonGenerator

@Deprecated
public UTF8JsonGenerator(IOContext ctxt,
                                     int features,
                                     ObjectCodec codec,
                                     java.io.OutputStream out,
                                     byte[] outputBuffer,
                                     int outputOffset,
                                     boolean bufferRecyclable)

Deprecated.

Method Detail

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

getOutputBuffered

public int getOutputBuffered()

Description copied from class: JsonGenerator

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. Unit used is often the same as the unit of underlying target (that is, `byte` for 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)

Overrides:

getOutputBuffered in class JsonGenerator

Returns:

Amount of content buffered in internal units, if amount known and accessible; -1 if not accessible.

writeFieldName

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

Throws:

java.io.IOException

writeFieldName

public void writeFieldName(SerializableString name)
                    throws java.io.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:

java.io.IOException

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

Throws:

java.io.IOException

writeStartArray

public void writeStartArray(int size)
                     throws java.io.IOException

Description copied from class: JsonGenerator

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

Default implementation simply calls JsonGenerator.writeStartArray().

Overrides:

writeStartArray in class JsonGenerator

Parameters:

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.

Throws:

java.io.IOException

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

Throws:

java.io.IOException

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

Throws:

java.io.IOException

writeStartObject

public void writeStartObject(java.lang.Object forValue)
                      throws java.io.IOException

Description copied from class: JsonGenerator

Method for writing starting marker of an Object value to represent the given Java Object value. Argument is offered as metadata, but more importantly it should be assigned as the "current value" for the Object content that gets constructed and initialized.

Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.

Overrides:

writeStartObject in class GeneratorBase

Throws:

java.io.IOException

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

Throws:

java.io.IOException

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

Throws:

java.io.IOException

writeString

public void writeString(java.io.Reader reader,
                        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. If the reader is null, then write a null. If len is < 0, then write all contents of the reader. Otherwise, write only len characters.

Overrides:

writeString in class JsonGenerator

Throws:

java.io.IOException

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

Throws:

java.io.IOException

writeString

public final void writeString(SerializableString text)
                       throws java.io.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:

java.io.IOException

writeRawUTF8String

public void writeRawUTF8String(byte[] text,
                               int offset,
                               int length)
                        throws java.io.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:

java.io.IOException

writeUTF8String

public void writeUTF8String(byte[] text,
                            int offset,
                            int len)
                     throws java.io.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:

java.io.IOException

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, 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:

java.io.IOException

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, 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:

java.io.IOException

writeRaw

public void writeRaw(SerializableString 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, 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:

java.io.IOException

writeRawValue

public void writeRawValue(SerializableString text)
                   throws java.io.IOException

Description copied from class: JsonGenerator

Method similar to JsonGenerator.writeRawValue(String), but potentially more efficient as it may be able to use pre-encoded content (similar to JsonGenerator.writeRaw(SerializableString).

Overrides:

writeRawValue in class GeneratorBase

Throws:

java.io.IOException

writeRaw

public final void writeRaw(char[] cbuf,
                           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, 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:

java.io.IOException

writeRaw

public void writeRaw(char ch)
              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, 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:

java.io.IOException

writeBinary

public void writeBinary(Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws java.io.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:

java.io.IOException

JsonGenerationException

writeBinary

public int writeBinary(Base64Variant b64variant,
                       java.io.InputStream data,
                       int dataLength)
                throws java.io.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:

java.io.IOException

JsonGenerationException

writeNumber

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

Overrides:

writeNumber in class JsonGenerator

Parameters:

s - Number value to write

Throws:

java.io.IOException

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

Parameters:

i - Number value to write

Throws:

java.io.IOException

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

Parameters:

l - Number value to write

Throws:

java.io.IOException

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

Parameters:

value - Number value to write

Throws:

java.io.IOException

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

Parameters:

d - Number value to write

Throws:

java.io.IOException

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

Parameters:

f - Number value to write

Throws:

java.io.IOException

writeNumber

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

Parameters:

value - Number value to write

Throws:

java.io.IOException

writeNumber

public void writeNumber(java.lang.String encodedValue)
                 throws java.io.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:

java.io.IOException

writeBoolean

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

Throws:

java.io.IOException

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

Throws:

java.io.IOException

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 interface java.io.Flushable

Specified by:

flush in class GeneratorBase

Throws:

java.io.IOException

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 interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class GeneratorBase

Throws:

java.io.IOException