|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.fasterxml.jackson.core.JsonGenerator com.fasterxml.jackson.core.base.GeneratorBase
public abstract class GeneratorBase
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 com.fasterxml.jackson.core.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 com.fasterxml.jackson.core.JsonGenerator |
---|
_cfgPrettyPrinter |
Constructor Summary | |
---|---|
protected |
GeneratorBase(int features,
ObjectCodec codec)
|
Method Summary | |
---|---|
protected void |
_cantHappen()
|
protected abstract void |
_releaseBuffers()
|
protected void |
_reportError(String msg)
|
protected void |
_reportUnsupportedOperation()
|
protected void |
_throwInternal()
|
protected abstract void |
_verifyValueWrite(String typeMsg)
|
protected void |
_writeSimpleObject(Object value)
Helper method to try to call appropriate write method for given untyped Object. |
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 ). |
Version |
version()
Implemented with detection that tries to find "VERSION.txt" in same package as the implementation class. |
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 |
writeObject(Object value)
Method for writing given Java object (POJO) as Json. |
void |
writeRawValue(char[] text,
int offset,
int len)
|
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). |
void |
writeRawValue(String text,
int offset,
int len)
|
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 |
writeTree(TreeNode rootNode)
Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator. |
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 GeneratorBase(int features, ObjectCodec codec)
Method Detail |
---|
public Version version()
version
in interface Versioned
version
in class JsonGenerator
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 JsonGenerator useDefaultPrettyPrinter()
JsonGenerator
DefaultPrettyPrinter
).
useDefaultPrettyPrinter
in class JsonGenerator
public 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 void writeFieldName(SerializableString name) throws IOException, JsonGenerationException
JsonGenerator
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.
writeFieldName
in class JsonGenerator
IOException
JsonGenerationException
public void writeString(SerializableString text) throws IOException, JsonGenerationException
JsonGenerator
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.
writeString
in class JsonGenerator
IOException
JsonGenerationException
public void writeRawValue(String text) throws IOException, JsonGenerationException
JsonGenerator
writeRawValue
in class JsonGenerator
IOException
JsonGenerationException
public void writeRawValue(String text, int offset, int len) throws IOException, JsonGenerationException
writeRawValue
in class JsonGenerator
IOException
JsonGenerationException
public void writeRawValue(char[] text, int offset, int len) throws IOException, JsonGenerationException
writeRawValue
in class JsonGenerator
IOException
JsonGenerationException
public void writeObject(Object value) throws IOException, JsonProcessingException
JsonGenerator
writeObject
in class JsonGenerator
IOException
JsonProcessingException
public void writeTree(TreeNode 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
protected final void _throwInternal()
protected void _reportUnsupportedOperation()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |