JsonGenerator (Jackson-core 2.7.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.fasterxml.jackson.core
Class JsonGenerator

java.lang.Object
  com.fasterxml.jackson.core.JsonGenerator

All Implemented Interfaces:: Versioned, Closeable, Flushable

Direct Known Subclasses:: GeneratorBase, JsonGeneratorDelegate

public abstract class JsonGenerator
extends Object
implements Closeable, Flushable, Versioned
extends Object
implements Closeable, Flushable, Versioned

Base class that defines public API for writing JSON content. Instances are created using factory methods of a JsonFactory instance.

Author:: Tatu Saloranta

Nested Class Summary
`static class`	`JsonGenerator.Feature` Enumeration that defines all togglable features for generators.

Field Summary
`protected PrettyPrinter`	`_cfgPrettyPrinter` Object that handles pretty-printing (usually additional white space to make results more human-readable) during output.

Constructor Summary
`protected`	`JsonGenerator()`

Method Summary
`protected void`	`_reportError(String msg)` Helper method used for constructing and throwing `JsonGenerationException` with given base message.
`protected void`	`_reportUnsupportedOperation()`
`protected void`	`_throwInternal()`
`protected void`	`_writeSimpleObject(Object value)` Helper method to try to call appropriate write method for given untyped Object.
`boolean`	`canOmitFields()` Introspection method to call to check whether it is ok to omit writing of Object fields or not.
`boolean`	`canUseSchema(FormatSchema schema)` Method that can be used to verify that given schema can be used with this generator (using `setSchema(com.fasterxml.jackson.core.FormatSchema)`).
`boolean`	`canWriteBinaryNatively()` Introspection method that may be called to see if the underlying data format supports "native" binary data; that is, an efficient output of binary content without encoding.
`boolean`	`canWriteObjectId()` Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).
`boolean`	`canWriteTypeId()` Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't).
`abstract void`	`close()` Method called to close this generator, so that no more content can be written.
`JsonGenerator`	`configure(JsonGenerator.Feature f, boolean state)` Method for enabling or disabling specified feature: check `JsonGenerator.Feature` for list of available features.
`void`	`copyCurrentEvent(JsonParser p)` Method for copying contents of the current event that the given parser instance points to.
`void`	`copyCurrentStructure(JsonParser p)` Method for copying contents of the current event and following events that it encloses the given parser instance points to.
`abstract JsonGenerator`	`disable(JsonGenerator.Feature f)` Method for disabling specified features (check `JsonGenerator.Feature` for list of features)
`abstract JsonGenerator`	`enable(JsonGenerator.Feature f)` Method for enabling specified parser features: check `JsonGenerator.Feature` for list of available features.
`abstract void`	`flush()` Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
`CharacterEscapes`	`getCharacterEscapes()` Method for accessing custom escapes factory uses for `JsonGenerator`s it creates.
`abstract ObjectCodec`	`getCodec()` Method for accessing the object used for writing Java object as JSON content (using method `writeObject(java.lang.Object)`).
`Object`	`getCurrentValue()` Helper method, usually equivalent to: `getOutputContext().getCurrentValue();`
`abstract int`	`getFeatureMask()` Bulk access method for getting state of all standard (non-dataformat-specific) `JsonGenerator.Feature`s.
`int`	`getFormatFeatures()` Bulk access method for getting state of all `FormatFeature`s, format-specific on/off configuration settings.
`int`	`getHighestEscapedChar()` Accessor method for testing what is the highest unescaped character configured for this generator.
`int`	`getOutputBuffered()` Method for verifying amount of content that is buffered by generator but not yet flushed to the underlying target (stream, writer), in units (byte, char) that the generator implementation uses for buffering; or -1 if this information is not available.
`abstract JsonStreamContext`	`getOutputContext()`
`Object`	`getOutputTarget()` Method that can be used to get access to object that is used as target for generated output; this is usually either `OutputStream` or `Writer`, depending on what generator was constructed with.
`PrettyPrinter`	`getPrettyPrinter()` Accessor for checking whether this generator has a configured `PrettyPrinter`; returns it if so, null if none configured.
`FormatSchema`	`getSchema()` Method for accessing Schema that this parser uses, if any.
`abstract boolean`	`isClosed()` Method that can be called to determine whether this generator is closed or not.
`abstract boolean`	`isEnabled(JsonGenerator.Feature f)` Method for checking whether given feature is enabled.
`JsonGenerator`	`overrideFormatFeatures(int values, int mask)` Bulk set method for (re)setting states of `FormatFeature`s, by specifying values (set / clear) along with a mask, to determine which features to change, if any.
`JsonGenerator`	`overrideStdFeatures(int values, int mask)` Bulk set method for (re)setting states of features specified by `mask`.
`JsonGenerator`	`setCharacterEscapes(CharacterEscapes esc)` Method for defining custom escapes factory uses for `JsonGenerator`s it creates.
`abstract JsonGenerator`	`setCodec(ObjectCodec oc)` Method that can be called to set or reset the object to use for writing Java objects as JsonContent (using method `writeObject(java.lang.Object)`).
`void`	`setCurrentValue(Object v)` Helper method, usually equivalent to: `getOutputContext().setCurrentValue(v);`
`abstract JsonGenerator`	`setFeatureMask(int values)` Deprecated. Since 2.7, use `overrideStdFeatures(int, int)` instead
`JsonGenerator`	`setHighestNonEscapedChar(int charCode)` Method that can be called to request that generator escapes all character codes above specified code point (if positive value); or, to not escape any characters except for ones that must be escaped for the data format (if -1).
`JsonGenerator`	`setPrettyPrinter(PrettyPrinter pp)` Method for setting a custom pretty printer, which is usually used to add indentation for improved human readability.
`JsonGenerator`	`setRootValueSeparator(SerializableString sep)` Method that allows overriding String used for separating root-level JSON values (default is single space character)
`void`	`setSchema(FormatSchema schema)` Method to call to make this generator use specified schema.
`abstract JsonGenerator`	`useDefaultPrettyPrinter()` Convenience method for enabling pretty-printing using the default pretty printer (`DefaultPrettyPrinter`).
`abstract Version`	`version()` Accessor for finding out version of the bundle that provided this generator instance.
`void`	`writeArrayFieldStart(String fieldName)` Convenience method for outputting a field entry ("member") (that will contain a JSON Array value), and the START_ARRAY marker.
`abstract void`	`writeBinary(Base64Variant bv, byte[] data, int offset, int len)` Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes).
`abstract int`	`writeBinary(Base64Variant bv, InputStream data, int dataLength)` Method similar to `writeBinary(Base64Variant,byte[],int,int)`, but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.
`void`	`writeBinary(byte[] data)` Similar to `writeBinary(Base64Variant,byte[],int,int)`, but assumes default to using the Jackson default Base64 variant (which is `Base64Variants.MIME_NO_LINEFEEDS`).
`void`	`writeBinary(byte[] data, int offset, int len)` Similar to `writeBinary(Base64Variant,byte[],int,int)`, but default to using the Jackson default Base64 variant (which is `Base64Variants.MIME_NO_LINEFEEDS`).
`int`	`writeBinary(InputStream data, int dataLength)` Similar to `writeBinary(Base64Variant,InputStream,int)`, but assumes default to using the Jackson default Base64 variant (which is `Base64Variants.MIME_NO_LINEFEEDS`).
`void`	`writeBinaryField(String fieldName, byte[] data)` Convenience method for outputting a field entry ("member") that contains specified data in base64-encoded form.
`abstract void`	`writeBoolean(boolean state)` Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').
`void`	`writeBooleanField(String fieldName, boolean value)` Convenience method for outputting a field entry ("member") that has a boolean value.
`abstract void`	`writeEndArray()` Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).
`abstract void`	`writeEndObject()` Method for writing closing marker of a JSON Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).
`abstract void`	`writeFieldName(SerializableString name)` Method similar to `writeFieldName(String)`, main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.
`abstract void`	`writeFieldName(String name)` Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.
`abstract void`	`writeNull()` Method for outputting literal JSON null value.
`void`	`writeNullField(String fieldName)` Convenience method for outputting a field entry ("member") that has JSON literal value null.
`abstract void`	`writeNumber(BigDecimal v)` Method for outputting indicate JSON numeric value.
`abstract void`	`writeNumber(BigInteger v)` Method for outputting given value as JSON number.
`abstract void`	`writeNumber(double v)` Method for outputting indicate JSON numeric value.
`abstract void`	`writeNumber(float v)` Method for outputting indicate JSON numeric value.
`abstract void`	`writeNumber(int v)` Method for outputting given value as JSON number.
`abstract void`	`writeNumber(long v)` Method for outputting given value as JSON number.
`void`	`writeNumber(short v)` Method for outputting given value as JSON number.
`abstract void`	`writeNumber(String encodedValue)` Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types.
`void`	`writeNumberField(String fieldName, BigDecimal value)` Convenience method for outputting a field entry ("member") that has the specified numeric value.
`void`	`writeNumberField(String fieldName, double value)` Convenience method for outputting a field entry ("member") that has the specified numeric value.
`void`	`writeNumberField(String fieldName, float value)` Convenience method for outputting a field entry ("member") that has the specified numeric value.
`void`	`writeNumberField(String fieldName, int value)` Convenience method for outputting a field entry ("member") that has the specified numeric value.
`void`	`writeNumberField(String fieldName, long value)` Convenience method for outputting a field entry ("member") that has the specified numeric value.
`abstract void`	`writeObject(Object pojo)` Method for writing given Java object (POJO) as Json.
`void`	`writeObjectField(String fieldName, Object pojo)` Convenience method for outputting a field entry ("member") that has contents of specific Java object as its value.
`void`	`writeObjectFieldStart(String fieldName)` Convenience method for outputting a field entry ("member") (that will contain a JSON Object value), and the START_OBJECT marker.
`void`	`writeObjectId(Object id)` Method that can be called to output so-called native Object Id.
`void`	`writeObjectRef(Object id)` Method that can be called to output references to native Object Ids.
`void`	`writeOmittedField(String fieldName)` Method called to indicate that a property in this position was skipped.
`abstract void`	`writeRaw(char c)` Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
`abstract void`	`writeRaw(char[] text, int offset, int len)` Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
`void`	`writeRaw(SerializableString raw)` Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
`abstract void`	`writeRaw(String text)` Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
`abstract void`	`writeRaw(String text, int offset, int len)` Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
`abstract void`	`writeRawUTF8String(byte[] text, int offset, int length)` Method similar to `writeString(String)` but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON).
`abstract void`	`writeRawValue(char[] text, int offset, int len)`
`void`	`writeRawValue(SerializableString raw)` Method similar to `writeRawValue(String)`, but potentially more efficient as it may be able to use pre-encoded content (similar to `writeRaw(SerializableString)`.
`abstract void`	`writeRawValue(String text)` Method that will force generator to copy input text verbatim without any modifications, but assuming it must constitute a single legal JSON value (number, string, boolean, null, Array or List).
`abstract void`	`writeRawValue(String text, int offset, int len)`
`abstract void`	`writeStartArray()` Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).
`void`	`writeStartArray(int size)` Method for writing start marker of an Array value, similar to `writeStartArray()`, but also specifying how many elements will be written for the array before calling `writeEndArray()`.
`abstract void`	`writeStartObject()` Method for writing starting marker of a JSON Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).
`abstract void`	`writeString(char[] text, int offset, int len)` Method for outputting a String value.
`abstract void`	`writeString(SerializableString text)` Method similar to `writeString(String)`, but that takes `SerializableString` which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.
`abstract void`	`writeString(String text)` Method for outputting a String value.
`void`	`writeStringField(String fieldName, String value)` Convenience method for outputting a field entry ("member") that has a String value.
`abstract void`	`writeTree(TreeNode rootNode)` Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator.
`void`	`writeTypeId(Object id)` Method that can be called to output so-called native Type Id.
`abstract void`	`writeUTF8String(byte[] text, int offset, int length)` Method similar to `writeString(String)` but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else).

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

_cfgPrettyPrinter

protected PrettyPrinter _cfgPrettyPrinter

Object that handles pretty-printing (usually additional white space to make results more human-readable) during output. If null, no pretty-printing is done.

Constructor Detail

JsonGenerator

protected JsonGenerator()

Method Detail

setCodec

public abstract JsonGenerator setCodec(ObjectCodec oc)

Method that can be called to set or reset the object to use for writing Java objects as JsonContent (using method writeObject(java.lang.Object)).

Returns:: Generator itself (this), to allow chaining

getCodec

public abstract ObjectCodec getCodec()

Method for accessing the object used for writing Java object as JSON content (using method writeObject(java.lang.Object)).

version

public abstract Version version()

Accessor for finding out version of the bundle that provided this generator instance.

Specified by:: version in interface Versioned

enable

public abstract JsonGenerator enable(JsonGenerator.Feature f)

Method for enabling specified parser features: check JsonGenerator.Feature for list of available features.

Returns:: Generator itself (this), to allow chaining

disable

public abstract JsonGenerator disable(JsonGenerator.Feature f)

Method for disabling specified features (check JsonGenerator.Feature for list of features)

Returns:: Generator itself (this), to allow chaining

configure

public final JsonGenerator configure(JsonGenerator.Feature f,
                                     boolean state)

Method for enabling or disabling specified feature: check JsonGenerator.Feature for list of available features.

Returns:: Generator itself (this), to allow chaining

isEnabled

public abstract boolean isEnabled(JsonGenerator.Feature f)

Method for checking whether given feature is enabled. Check JsonGenerator.Feature for list of available features.

getFeatureMask

public abstract int getFeatureMask()

Bulk access method for getting state of all standard (non-dataformat-specific) JsonGenerator.Features.

Returns:: Bit mask that defines current states of all standard JsonGenerator.Features.
Since:: 2.3

setFeatureMask

@Deprecated
public abstract JsonGenerator setFeatureMask(int values)

Deprecated. Since 2.7, use overrideStdFeatures(int, int) instead

Bulk set method for (re)setting states of all standard JsonGenerator.Features

Parameters:: values - Bitmask that defines which JsonGenerator.Features are enabled and which disabled
Returns:: This parser object, to allow chaining of calls
Since:: 2.3

overrideStdFeatures

public JsonGenerator overrideStdFeatures(int values,
                                         int mask)

Bulk set method for (re)setting states of features specified by mask. Functionally equivalent to


    int oldState = getFeatureMask();
    int newState = (oldState & ~mask) | (values & mask);
    setFeatureMask(newState);

but preferred as this lets caller more efficiently specify actual changes made.

Parameters:: values - Bit mask of set/clear state for features to change; mask - Bit mask of features to change
Since:: 2.6

getFormatFeatures

public int getFormatFeatures()

Bulk access method for getting state of all FormatFeatures, format-specific on/off configuration settings.

Returns:: Bit mask that defines current states of all standard FormatFeatures.
Since:: 2.6

overrideFormatFeatures

public JsonGenerator overrideFormatFeatures(int values,
                                            int mask)

Bulk set method for (re)setting states of FormatFeatures, 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 FormatFeatures.

Parameters:: values - Bit mask of set/clear state for features to change; mask - Bit mask of features to change
Since:: 2.6

setSchema

public void setSchema(FormatSchema schema)

Method to call to make this generator use specified schema. Method must be called before generating any content, right after instance has been created. Note that not all generators support schemas; and those that do usually only accept specific types of schemas: ones defined for data format this generator produces.

If generator does not support specified schema, UnsupportedOperationException is thrown.

Parameters:: schema - Schema to use
Throws:: UnsupportedOperationException - if generator does not support schema

getSchema

public FormatSchema getSchema()

Method for accessing Schema that this parser uses, if any. Default implementation returns null.

Since:: 2.1

setPrettyPrinter

public JsonGenerator setPrettyPrinter(PrettyPrinter pp)

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

Returns:: Generator itself (this), to allow chaining

getPrettyPrinter

public PrettyPrinter getPrettyPrinter()

Accessor for checking whether this generator has a configured PrettyPrinter; returns it if so, null if none configured.

Since:: 2.1

useDefaultPrettyPrinter

public abstract JsonGenerator useDefaultPrettyPrinter()

Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter).

Returns:: Generator itself (this), to allow chaining

setHighestNonEscapedChar

public JsonGenerator setHighestNonEscapedChar(int charCode)

Method that can be called to request that generator escapes all character codes above specified code point (if positive value); or, to not escape any characters except for ones that must be escaped for the data format (if -1). To force escaping of all non-ASCII characters, for example, this method would be called with value of 127.

Note that generators are NOT required to support setting of value higher than 127, because there are other ways to affect quoting (or lack thereof) of character codes between 0 and 127. Not all generators support concept of escaping, either; if so, calling this method will have no effect.

Default implementation does nothing; sub-classes need to redefine it according to rules of supported data format.

Parameters:: charCode - Either -1 to indicate that no additional escaping is to be done; or highest code point not to escape (meaning higher ones will be), if positive value.

getHighestEscapedChar

public int getHighestEscapedChar()

Accessor method for testing what is the highest unescaped character configured for this generator. This may be either positive value (when escaping configuration has been set and is in effect), or 0 to indicate that no additional escaping is in effect. Some generators may not support additional escaping: for example, generators for binary formats that do not use escaping should simply return 0.

Returns:: Currently active limitation for highest non-escaped character, if defined; or -1 to indicate no additional escaping is performed.

getCharacterEscapes

public CharacterEscapes getCharacterEscapes()

Method for accessing custom escapes factory uses for JsonGenerators it creates.

setCharacterEscapes

public JsonGenerator setCharacterEscapes(CharacterEscapes esc)

Method for defining custom escapes factory uses for JsonGenerators it creates.

Default implementation does nothing and simply returns this instance.

setRootValueSeparator

public JsonGenerator setRootValueSeparator(SerializableString sep)

Method that allows overriding String used for separating root-level JSON values (default is single space character)

Default implementation throws UnsupportedOperationException.

Parameters:: sep - Separator to use, if any; null means that no separator is automatically added
Since:: 2.1

getOutputTarget

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

getOutputBuffered

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

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

getCurrentValue

public Object getCurrentValue()

Helper method, usually equivalent to:


   getOutputContext().getCurrentValue();

Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.

Since:: 2.5

setCurrentValue

public void setCurrentValue(Object v)

Helper method, usually equivalent to:


   getOutputContext().setCurrentValue(v);

Since:: 2.5

canUseSchema

public boolean canUseSchema(FormatSchema schema)

Method that can be used to verify that given schema can be used with this generator (using setSchema(com.fasterxml.jackson.core.FormatSchema)).

Parameters:: schema - Schema to check
Returns:: True if this generator can use given schema; false if not

canWriteObjectId

public boolean canWriteObjectId()

Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't). This method must be called prior to calling writeObjectId(java.lang.Object) or writeObjectRef(java.lang.Object).

Default implementation returns false; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native object ids.

Since:: 2.3

canWriteTypeId

public boolean canWriteTypeId()

Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't). This method must be called prior to calling writeTypeId(java.lang.Object).

Default implementation returns false; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native type ids.

Since:: 2.3

canWriteBinaryNatively

public boolean canWriteBinaryNatively()

Introspection method that may be called to see if the underlying data format supports "native" binary data; that is, an efficient output of binary content without encoding.

Default implementation returns false; overridden by data formats that do support native binary content.

Since:: 2.3

canOmitFields

public boolean canOmitFields()

Introspection method to call to check whether it is ok to omit writing of Object fields or not. Most formats do allow omission, but certain positional formats (such as CSV) require output of placeholders, even if no real values are to be emitted.

Since:: 2.3

writeStartArray

public abstract void writeStartArray()
                              throws IOException

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.

Throws:: IOException

writeStartArray

public void writeStartArray(int size)
                     throws IOException

Method for writing start marker of an Array value, similar to writeStartArray(), but also specifying how many elements will be written for the array before calling writeEndArray().

Default implementation simply calls writeStartArray().

Parameters:: size - Number of elements this array will have: actual number of values written (before matching call to writeEndArray() MUST match; generator MAY verify this is the case.
Throws:: IOException
Since:: 2.4

writeEndArray

public abstract void writeEndArray()
                            throws IOException

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.

Throws:: IOException

writeStartObject

public abstract void writeStartObject()
                               throws IOException

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.

Throws:: IOException

writeEndObject

public abstract void writeEndObject()
                             throws IOException

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

Throws:: IOException

writeFieldName

public abstract void writeFieldName(String name)
                             throws IOException

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

Throws:: IOException

writeFieldName

public abstract void writeFieldName(SerializableString name)
                             throws IOException

Method similar to writeFieldName(String), main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.

Default implementation simple uses unprocessed name container in serialized String; implementations are strongly encouraged to make use of more efficient methods argument object has.

Throws:: IOException

writeString

public abstract void writeString(String text)
                          throws IOException

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.

Throws:: IOException

writeString

public abstract void writeString(char[] text,
                                 int offset,
                                 int len)
                          throws IOException

Throws:: IOException

writeString

public abstract void writeString(SerializableString text)
                          throws IOException

Method similar to writeString(String), but that takes SerializableString which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.

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

Throws:: IOException

writeRawUTF8String

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

Method similar to writeString(String) but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON). 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.

Throws:: IOException

writeUTF8String

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

Method similar to writeString(String) but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else). 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.

Throws:: IOException

writeRaw

public abstract void writeRaw(String text)
                       throws IOException

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 writeRawValue(String) instead.