|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.JsonGenerator
org.codehaus.jackson.impl.JsonGeneratorBase
public abstract class JsonGeneratorBase
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 |
_cfgNumbersAsStrings
Flag set to indicate that implicit conversion from number to JSON String is needed (as per JsonGenerator.Feature.WRITE_NUMBERS_AS_STRINGS ). |
protected boolean |
_closed
Flag that indicates whether generator is closed or not. |
protected int |
_features
Bit flag composed of bits that indicate which JsonGenerator.Feature s
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(String msg)
|
protected abstract void |
_verifyValueWrite(String typeMsg)
|
protected abstract void |
_writeEndArray()
|
protected abstract void |
_writeEndObject()
|
protected abstract void |
_writeFieldName(String name,
boolean commaBefore)
|
protected void |
_writeSimpleObject(Object value)
Helper method to try to call appropriate write method for given untyped Object. |
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. |
JsonGenerator |
disable(JsonGenerator.Feature f)
Method for disabling specified features (check JsonGenerator.Feature for list of features) |
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. |
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 |
isEnabled(JsonGenerator.Feature f)
Method for checking whether given feature is enabled. |
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 JsonGenerator.writeObject(java.lang.Object) ). |
JsonGenerator |
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(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(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. |
void |
writeObject(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). |
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 |
---|
configure, disableFeature, enableFeature, isFeatureEnabled, setFeature, setPrettyPrinter, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, 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 |
---|
protected ObjectCodec _objectCodec
protected int _features
JsonGenerator.Feature
s
are enabled.
protected boolean _cfgNumbersAsStrings
JsonGenerator.Feature.WRITE_NUMBERS_AS_STRINGS
).
protected JsonWriteContext _writeContext
protected boolean _closed
close()
).
Constructor Detail |
---|
protected JsonGeneratorBase(int features, ObjectCodec codec)
Method Detail |
---|
public JsonGenerator enable(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of available features.
enable
in class JsonGenerator
public JsonGenerator disable(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of features)
disable
in class JsonGenerator
public final boolean isEnabled(JsonGenerator.Feature f)
JsonGenerator
JsonGenerator.Feature
for list of available features.
isEnabled
in class JsonGenerator
public final JsonGenerator useDefaultPrettyPrinter()
JsonGenerator
DefaultPrettyPrinter
).
useDefaultPrettyPrinter
in class JsonGenerator
public final JsonGenerator setCodec(ObjectCodec oc)
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
).
setCodec
in class JsonGenerator
public final ObjectCodec getCodec()
JsonGenerator
JsonGenerator.writeObject(java.lang.Object)
).
getCodec
in class JsonGenerator
public final JsonWriteContext getOutputContext()
getOutputContext
in class JsonGenerator
public final void writeStartArray() throws IOException, JsonGenerationException
JsonGenerator
Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartArray
in class JsonGenerator
IOException
JsonGenerationException
protected abstract void _writeStartArray() throws IOException, JsonGenerationException
IOException
JsonGenerationException
public final void writeEndArray() throws IOException, JsonGenerationException
JsonGenerator
Marker can be written if the innermost structured type is Array.
writeEndArray
in class JsonGenerator
IOException
JsonGenerationException
protected abstract void _writeEndArray() throws IOException, JsonGenerationException
IOException
JsonGenerationException
public final void writeStartObject() throws IOException, JsonGenerationException
JsonGenerator
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
writeStartObject
in class JsonGenerator
IOException
JsonGenerationException
protected abstract void _writeStartObject() throws IOException, JsonGenerationException
IOException
JsonGenerationException
public final void writeEndObject() throws IOException, JsonGenerationException
JsonGenerator
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).
writeEndObject
in class JsonGenerator
IOException
JsonGenerationException
protected abstract void _writeEndObject() throws IOException, JsonGenerationException
IOException
JsonGenerationException
public final void writeFieldName(String name) throws IOException, JsonGenerationException
JsonGenerator
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).
writeFieldName
in class JsonGenerator
IOException
JsonGenerationException
protected abstract void _writeFieldName(String name, boolean commaBefore) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeNumber(int i) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public abstract void writeNumber(long l) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public abstract void writeNumber(double d) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public abstract void writeNumber(float f) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public abstract void writeNumber(BigDecimal dec) throws IOException, JsonGenerationException
JsonGenerator
writeNumber
in class JsonGenerator
IOException
JsonGenerationException
public abstract void writeBoolean(boolean state) throws IOException, JsonGenerationException
JsonGenerator
writeBoolean
in class JsonGenerator
IOException
JsonGenerationException
public abstract void writeNull() throws IOException, JsonGenerationException
JsonGenerator
writeNull
in class JsonGenerator
IOException
JsonGenerationException
public void writeObject(Object value) throws IOException, JsonProcessingException
JsonGenerator
writeObject
in class JsonGenerator
IOException
JsonProcessingException
public void writeTree(JsonNode rootNode) throws IOException, JsonProcessingException
JsonGenerator
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.
writeTree
in class JsonGenerator
IOException
JsonProcessingException
public abstract void flush() throws IOException
JsonGenerator
flush
in class JsonGenerator
IOException
public void close() throws IOException
JsonGenerator
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.
close
in interface Closeable
close
in class JsonGenerator
IOException
public boolean isClosed()
JsonGenerator
isClosed
in class JsonGenerator
public final void copyCurrentEvent(JsonParser jp) throws IOException, JsonProcessingException
JsonGenerator
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)
copyCurrentEvent
in class JsonGenerator
IOException
JsonProcessingException
public final void copyCurrentStructure(JsonParser jp) throws IOException, JsonProcessingException
JsonGenerator
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.
copyCurrentStructure
in class JsonGenerator
IOException
JsonProcessingException
protected abstract void _releaseBuffers()
protected abstract void _verifyValueWrite(String typeMsg) throws IOException, JsonGenerationException
IOException
JsonGenerationException
protected void _reportError(String msg) throws JsonGenerationException
JsonGenerationException
protected void _cantHappen()
protected void _writeSimpleObject(Object value) throws IOException, JsonGenerationException
value
- Non-null value to write
IOException
JsonGenerationException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |