|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.JsonGenerator
public abstract class JsonGenerator
Base class that defines public API for writing Json content.
Instances are created using factory methods of
a JsonFactory
instance.
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 | |
---|---|
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. |
abstract void |
copyCurrentEvent(JsonParser jp)
Method for copying contents of the current event that the given parser instance points to. |
abstract void |
copyCurrentStructure(JsonParser jp)
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) |
void |
disableFeature(JsonGenerator.Feature f)
Deprecated. Use disable(org.codehaus.jackson.JsonGenerator.Feature) instead |
abstract JsonGenerator |
enable(JsonGenerator.Feature f)
Method for enabling specified parser features: check JsonGenerator.Feature for list of available features. |
void |
enableFeature(JsonGenerator.Feature f)
Deprecated. Use enable(org.codehaus.jackson.JsonGenerator.Feature) instead |
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. |
abstract ObjectCodec |
getCodec()
Method for accessing the object used for writing Java object as Json content (using method writeObject(java.lang.Object) ). |
abstract JsonStreamContext |
getOutputContext()
|
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. |
boolean |
isFeatureEnabled(JsonGenerator.Feature f)
Deprecated. Use isEnabled(org.codehaus.jackson.JsonGenerator.Feature) instead |
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 |
setFeature(JsonGenerator.Feature f,
boolean state)
Deprecated. Use configure(org.codehaus.jackson.JsonGenerator.Feature, boolean) instead |
JsonGenerator |
setPrettyPrinter(PrettyPrinter pp)
Method for setting a custom pretty printer, which is usually used to add indentation for improved human readability. |
abstract JsonGenerator |
useDefaultPrettyPrinter()
Convenience method for enabling pretty-printing using the default pretty printer ( DefaultPrettyPrinter ). |
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 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). |
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 ). |
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(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 dec)
Method for outputting indicate Json numeric value. |
abstract void |
writeNumber(BigInteger v)
Method for outputting given value as Json number. |
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 v)
Method for outputting given value as Json number. |
abstract void |
writeNumber(long 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. |
abstract void |
writeRaw(char c)
|
abstract void |
writeRaw(char[] text,
int offset,
int len)
|
abstract void |
writeRaw(String text)
Fallback method which can be used to make generator copy input text verbatim with no modifications (including that no quoting 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)
|
abstract void |
writeRawValue(char[] text,
int offset,
int len)
|
abstract void |
writeRawValue(String text)
Fallback method which can be used to make generator 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 Json Array value (character '['; plus possible white space decoration if pretty-printing is enabled). |
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)
|
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(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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected PrettyPrinter _cfgPrettyPrinter
Constructor Detail |
---|
protected JsonGenerator()
Method Detail |
---|
public abstract JsonGenerator enable(JsonGenerator.Feature f)
JsonGenerator.Feature
for list of available features.
public abstract JsonGenerator disable(JsonGenerator.Feature f)
JsonGenerator.Feature
for list of features)
public JsonGenerator configure(JsonGenerator.Feature f, boolean state)
JsonGenerator.Feature
for list of available features.
public abstract boolean isEnabled(JsonGenerator.Feature f)
JsonGenerator.Feature
for list of available features.
public abstract JsonGenerator setCodec(ObjectCodec oc)
writeObject(java.lang.Object)
).
public abstract ObjectCodec getCodec()
writeObject(java.lang.Object)
).
public void enableFeature(JsonGenerator.Feature f)
enable(org.codehaus.jackson.JsonGenerator.Feature)
instead
public void disableFeature(JsonGenerator.Feature f)
disable(org.codehaus.jackson.JsonGenerator.Feature)
instead
public void setFeature(JsonGenerator.Feature f, boolean state)
configure(org.codehaus.jackson.JsonGenerator.Feature, boolean)
instead
public boolean isFeatureEnabled(JsonGenerator.Feature f)
isEnabled(org.codehaus.jackson.JsonGenerator.Feature)
instead
public JsonGenerator setPrettyPrinter(PrettyPrinter pp)
To use the default pretty printer that comes with core
Jackson distribution, call useDefaultPrettyPrinter()
instead.
public abstract JsonGenerator useDefaultPrettyPrinter()
DefaultPrettyPrinter
).
public abstract void writeStartArray() throws IOException, JsonGenerationException
Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
IOException
JsonGenerationException
public abstract void writeEndArray() throws IOException, JsonGenerationException
Marker can be written if the innermost structured type is Array.
IOException
JsonGenerationException
public abstract void writeStartObject() throws IOException, JsonGenerationException
Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
IOException
JsonGenerationException
public abstract void writeEndObject() throws IOException, JsonGenerationException
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).
IOException
JsonGenerationException
public abstract void writeFieldName(String name) throws IOException, JsonGenerationException
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).
IOException
JsonGenerationException
public abstract void writeString(String text) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeString(char[] text, int offset, int len) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeRaw(String text) throws IOException, JsonGenerationException
writeRawValue(String)
instead.
IOException
JsonGenerationException
public abstract void writeRaw(String text, int offset, int len) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeRaw(char[] text, int offset, int len) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeRaw(char c) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeRawValue(String text) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeRawValue(String text, int offset, int len) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeRawValue(char[] text, int offset, int len) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws IOException, JsonGenerationException
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.
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.
IOException
JsonGenerationException
public void writeBinary(byte[] data, int offset, int len) throws IOException, JsonGenerationException
writeBinary(Base64Variant,byte[],int,int)
,
but default to using the Jackson default Base64 variant
(which is Base64Variants.MIME_NO_LINEFEEDS
).
IOException
JsonGenerationException
public void writeBinary(byte[] data) throws IOException, JsonGenerationException
writeBinary(Base64Variant,byte[],int,int)
,
but assumes default to using the Jackson default Base64 variant
(which is Base64Variants.MIME_NO_LINEFEEDS
). Also
assumes that whole byte array is to be output.
IOException
JsonGenerationException
public abstract void writeNumber(int v) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeNumber(long v) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeNumber(BigInteger v) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeNumber(double d) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeNumber(float f) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeNumber(BigDecimal dec) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeNumber(String encodedValue) throws IOException, JsonGenerationException, UnsupportedOperationException
writeString(java.lang.String)
method can not be used; nor
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
.
IOException
JsonGenerationException
UnsupportedOperationException
public abstract void writeBoolean(boolean state) throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeNull() throws IOException, JsonGenerationException
IOException
JsonGenerationException
public abstract void writeObject(Object pojo) throws IOException, JsonProcessingException
IOException
JsonProcessingException
public abstract void writeTree(JsonNode rootNode) throws IOException, JsonProcessingException
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.
IOException
JsonProcessingException
public final void writeStringField(String fieldName, String value) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeString(value);
IOException
JsonGenerationException
public final void writeBooleanField(String fieldName, boolean value) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeBoolean(value);
IOException
JsonGenerationException
public final void writeNullField(String fieldName) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeNull();
IOException
JsonGenerationException
public final void writeNumberField(String fieldName, int value) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeNumber(value);
IOException
JsonGenerationException
public final void writeNumberField(String fieldName, long value) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeNumber(value);
IOException
JsonGenerationException
public final void writeNumberField(String fieldName, double value) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeNumber(value);
IOException
JsonGenerationException
public final void writeNumberField(String fieldName, float value) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeNumber(value);
IOException
JsonGenerationException
public final void writeNumberField(String fieldName, BigDecimal value) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeNumber(value);
IOException
JsonGenerationException
public final void writeBinaryField(String fieldName, byte[] data) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeBinary(value);
IOException
JsonGenerationException
public final void writeArrayFieldStart(String fieldName) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeStartArray();
Note: caller still has to take care to close the array (by calling {#link #writeEndArray}) after writing all values of the value Array.
IOException
JsonGenerationException
public final void writeObjectFieldStart(String fieldName) throws IOException, JsonGenerationException
writeFieldName(fieldName); writeStartObject();
Note: caller still has to take care to close the Object (by calling {#link #writeEndObject}) after writing all entries of the value Object.
IOException
JsonGenerationException
public final void writeObjectField(String fieldName, Object pojo) throws IOException, JsonProcessingException
writeFieldName(fieldName); writeObject(pojo);
IOException
JsonProcessingException
public abstract void copyCurrentEvent(JsonParser jp) throws IOException, JsonProcessingException
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)
IOException
JsonProcessingException
public abstract void copyCurrentStructure(JsonParser jp) throws IOException, JsonProcessingException
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.
IOException
JsonProcessingException
public abstract JsonStreamContext getOutputContext()
public abstract void flush() throws IOException
IOException
public abstract boolean isClosed()
public abstract void close() throws IOException
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
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |