org.codehaus.jackson.impl
Class JsonGeneratorBase

java.lang.Object
  org.codehaus.jackson.JsonGenerator
      org.codehaus.jackson.impl.JsonGeneratorBase

Direct Known Subclasses:

WriterBasedGenerator

public abstract class JsonGeneratorBase
extends JsonGenerator

This base class implements part of API that a JSON generator exposes to applications, adds shared internal methods that sub-classes can use and adds some abstract methods sub-classes must implement.

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.jackson.JsonGenerator

JsonGenerator.Feature

Field Summary

protected boolean	_closed Flag that indicates whether generator is closed or not.
protected int	_features Bit flag composed of bits that indicate which JsonGenerator.Features are enabled.
protected ObjectCodec	_objectCodec
protected JsonWriteContext	_writeContext Object that keeps track of the current contextual state of the generator.

Fields inherited from class org.codehaus.jackson.JsonGenerator

_cfgPrettyPrinter

Constructor Summary

protected

JsonGeneratorBase(int features, ObjectCodec codec)

Method Summary

protected void	_cantHappen()
protected abstract void	_releaseBuffers()
protected void	_reportError(java.lang.String msg)
protected abstract void	_verifyValueWrite(java.lang.String typeMsg)
protected abstract void	_writeEndArray()
protected abstract void	_writeEndObject()
protected abstract void	_writeFieldName(java.lang.String name, boolean commaBefore)
protected abstract void	_writeStartArray()
protected abstract void	_writeStartObject()
void	close() Method called to close this generator, so that no more content can be written.
void	copyCurrentEvent(JsonParser jp) Method for copying contents of the current event that the given parser instance points to.
void	copyCurrentStructure(JsonParser jp) Method for copying contents of the current event and following events that it encloses the given parser instance points to.
void	disableFeature(JsonGenerator.Feature f) Method for disabling specified features (check JsonGenerator.Feature for list of features)
void	enableFeature(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.
ObjectCodec	getCodec() Method for accessing the object used for writing Java object as Json content (using method JsonGenerator.writeObject(java.lang.Object)).
JsonWriteContext	getOutputContext() Note: co-variant return type.
boolean	isClosed() Method that can be called to determine whether this generator is closed or not.
boolean	isFeatureEnabled(JsonGenerator.Feature f) Method for checking whether given feature is enabled.
void	setCodec(ObjectCodec oc) Method that can be called to set or reset the object to use for writing Java objects as JsonContent (using method JsonGenerator.writeObject(java.lang.Object)).
void	useDefaultPrettyPrinter() Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter).
abstract 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(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.
abstract void	writeNull() Method for outputting literal Json null value.
abstract void	writeNumber(java.math.BigDecimal dec) Method for outputting indicate Json numeric value.
abstract void	writeNumber(double d) Method for outputting indicate Json numeric value.
abstract void	writeNumber(float f) Method for outputting indicate Json numeric value.
abstract void	writeNumber(int i) Method for outputting given value as Json number.
abstract void	writeNumber(long l) Method for outputting given value as Json number.
abstract void	writeObject(java.lang.Object value) Method for writing given Java object (POJO) as Json.
void	writeStartArray() Method for writing starting marker of a Json Array value (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).
abstract void	writeTree(JsonNode rootNode) Method for writing given Json tree (expressed as a tree where given JsonNode is the root) using this generator.

Methods inherited from class org.codehaus.jackson.JsonGenerator

setFeature, setPrettyPrinter, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBooleanField, writeNullField, writeNumber, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeRaw, writeRaw, writeRaw, writeRaw, writeRawValue, writeRawValue, writeRawValue, writeString, writeString, writeStringField

Methods inherited from class java.lang.Object

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

Field Detail

_objectCodec

protected ObjectCodec _objectCodec

_features

protected int _features

Bit flag composed of bits that indicate which JsonGenerator.Features are enabled.

_writeContext

protected JsonWriteContext _writeContext

Object that keeps track of the current contextual state of the generator.

_closed

protected boolean _closed

Flag that indicates whether generator is closed or not. Gets set when it is closed by an explicit call (close()).

Constructor Detail

JsonGeneratorBase

protected JsonGeneratorBase(int features,
                            ObjectCodec codec)

Method Detail

enableFeature

public void enableFeature(JsonGenerator.Feature f)

Description copied from class: JsonGenerator

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

Specified by:

enableFeature in class JsonGenerator

disableFeature

public void disableFeature(JsonGenerator.Feature f)

Description copied from class: JsonGenerator

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

Specified by:

disableFeature in class JsonGenerator

isFeatureEnabled

public final boolean isFeatureEnabled(JsonGenerator.Feature f)

Description copied from class: JsonGenerator

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

Specified by:

isFeatureEnabled in class JsonGenerator

useDefaultPrettyPrinter

public final void useDefaultPrettyPrinter()

Description copied from class: JsonGenerator

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

Specified by:

useDefaultPrettyPrinter in class JsonGenerator

setCodec

public final void setCodec(ObjectCodec oc)

Description copied from class: JsonGenerator

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

Specified by:

setCodec in class JsonGenerator

getCodec

public final ObjectCodec getCodec()

Description copied from class: JsonGenerator

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

Specified by:

getCodec in class JsonGenerator

getOutputContext

public final JsonWriteContext getOutputContext()

Note: co-variant return type.

Specified by:

getOutputContext in class JsonGenerator

Returns:

Context object that can give information about logical position within generated json content.

writeStartArray

public final void writeStartArray()
                           throws java.io.IOException,
                                  JsonGenerationException

Description copied from class: JsonGenerator

Method for writing starting marker of a Json Array value (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

JsonGenerationException

_writeStartArray

protected abstract void _writeStartArray()
                                  throws java.io.IOException,
                                         JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

writeEndArray

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

java.io.IOException

JsonGenerationException

_writeEndArray

protected abstract void _writeEndArray()
                                throws java.io.IOException,
                                       JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

writeStartObject

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

java.io.IOException

JsonGenerationException

_writeStartObject

protected abstract void _writeStartObject()
                                   throws java.io.IOException,
                                          JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

writeEndObject

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

java.io.IOException

JsonGenerationException

_writeEndObject

protected abstract void _writeEndObject()
                                 throws java.io.IOException,
                                        JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

writeFieldName

public final void writeFieldName(java.lang.String name)
                          throws java.io.IOException,
                                 JsonGenerationException

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

JsonGenerationException

_writeFieldName

protected abstract void _writeFieldName(java.lang.String name,
                                        boolean commaBefore)
                                 throws java.io.IOException,
                                        JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

writeNumber

public abstract void writeNumber(int i)
                          throws java.io.IOException,
                                 JsonGenerationException

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:

java.io.IOException

JsonGenerationException

writeNumber

public abstract void writeNumber(long l)
                          throws java.io.IOException,
                                 JsonGenerationException

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:

java.io.IOException

JsonGenerationException

writeNumber

public abstract void writeNumber(double d)
                          throws java.io.IOException,
                                 JsonGenerationException

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:

java.io.IOException

JsonGenerationException

writeNumber

public abstract void writeNumber(float f)
                          throws java.io.IOException,
                                 JsonGenerationException

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:

java.io.IOException

JsonGenerationException

writeNumber

public abstract void writeNumber(java.math.BigDecimal dec)
                          throws java.io.IOException,
                                 JsonGenerationException

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:

java.io.IOException

JsonGenerationException

writeBoolean

public abstract void writeBoolean(boolean state)
                           throws java.io.IOException,
                                  JsonGenerationException

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

JsonGenerationException

writeNull

public abstract void writeNull()
                        throws java.io.IOException,
                               JsonGenerationException

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

JsonGenerationException

writeObject

public abstract void writeObject(java.lang.Object value)
                          throws java.io.IOException,
                                 JsonProcessingException

Description copied from class: JsonGenerator

Method for writing given Java object (POJO) as Json. Exactly how the object gets written depends on object in question (ad on codec, its configuration); for most beans it will result in Json object, but for others Json array, or String or numeric value (and for nulls, Json null literal. NOTE: generator must have its object codec set to non-null value; for generators created by a mapping factory this is the case, for others not.

Specified by:

writeObject in class JsonGenerator

Throws:

java.io.IOException

JsonProcessingException

writeTree

public abstract void writeTree(JsonNode rootNode)
                        throws java.io.IOException,
                               JsonProcessingException

Description copied from class: JsonGenerator

Method for writing given Json tree (expressed as a tree where given JsonNode is the root) using this generator. This will generally just call JsonGenerator.writeObject(java.lang.Object) with given node, but is added for convenience and to make code more explicit in cases where it deals specifically with trees.

Specified by:

writeTree in class JsonGenerator

Throws:

java.io.IOException

JsonProcessingException

flush

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

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

Throws:

java.io.IOException

isClosed

public boolean isClosed()

Description copied from class: JsonGenerator

Method that can be called to determine whether this generator is closed or not. If it is closed, no more output can be done.

Specified by:

isClosed in class JsonGenerator

copyCurrentEvent

public final void copyCurrentEvent(JsonParser jp)
                            throws java.io.IOException,
                                   JsonProcessingException

Description copied from class: JsonGenerator

Method for copying contents of the current event that the given parser instance points to. Note that the method will not copy any other events, such as events contained within Json Array or Object structures.

Calling this method will not advance the given parser, although it may cause parser to internally process more data (if it lazy loads contents of value events, for example)

Specified by:

copyCurrentEvent in class JsonGenerator

Throws:

java.io.IOException

JsonProcessingException

copyCurrentStructure

public final void copyCurrentStructure(JsonParser jp)
                                throws java.io.IOException,
                                       JsonProcessingException

Description copied from class: JsonGenerator

Method for copying contents of the current event and following events that it encloses the given parser instance points to.

So what constitutes enclosing? Here is the list of events that have associated enclosed events that will get copied:

• JsonToken.START_OBJECT: all events up to and including matching (closing) JsonToken.END_OBJECT will be copied
• JsonToken.START_ARRAY all events up to and including matching (closing) JsonToken.END_ARRAY will be copied
• JsonToken.FIELD_NAME the logical value (which can consist of a single scalar value; or a sequence of related events for structured types (Json Arrays, Objects)) will be copied along with the name itself. So essentially the whole field entry (name and value) will be copied.

After calling this method, parser will point to the last event that was copied. This will either be the event parser already pointed to (if there were no enclosed events), or the last enclosed event copied.

Specified by:

copyCurrentStructure in class JsonGenerator

Throws:

java.io.IOException

JsonProcessingException

_releaseBuffers

protected abstract void _releaseBuffers()

_verifyValueWrite

protected abstract void _verifyValueWrite(java.lang.String typeMsg)
                                   throws java.io.IOException,
                                          JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

_reportError

protected void _reportError(java.lang.String msg)
                     throws JsonGenerationException

Throws:

JsonGenerationException

_cantHappen

protected void _cantHappen()