com.fasterxml.jackson.core.base
Class GeneratorBase

java.lang.Object  extended by com.fasterxml.jackson.core.JsonGenerator      extended by com.fasterxml.jackson.core.base.GeneratorBase
All Implemented Interfaces:
Versioned, Closeable
Direct Known Subclasses:
UTF8JsonGenerator, WriterBasedJsonGenerator

public abstract class GeneratorBase
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 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.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 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.
 voidclose()
          Method called to close this generator, so that no more content can be written.
 voidcopyCurrentEvent(JsonParser jp)
          Method for copying contents of the current event that the given parser instance points to.
 voidcopyCurrentStructure(JsonParser jp)
          Method for copying contents of the current event and following events that it encloses the given parser instance points to.
 JsonGeneratordisable(JsonGenerator.Feature f)
          Method for disabling specified features (check JsonGenerator.Feature for list of features)
 JsonGeneratorenable(JsonGenerator.Feature f)
          Method for enabling specified parser features: check JsonGenerator.Feature for list of available features.
abstract  voidflush()
          Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
 ObjectCodecgetCodec()
          Method for accessing the object used for writing Java object as Json content (using method JsonGenerator.writeObject(java.lang.Object)).
 JsonWriteContextgetOutputContext()
          Note: co-variant return type.
 booleanisClosed()
          Method that can be called to determine whether this generator is closed or not.
 booleanisEnabled(JsonGenerator.Feature f)
          Method for checking whether given feature is enabled.
 JsonGeneratorsetCodec(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)).
 JsonGeneratoruseDefaultPrettyPrinter()
          Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter).
 Versionversion()
          Implemented with detection that tries to find "VERSION.txt" in same package as the implementation class.
 voidwriteFieldName(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.
 voidwriteObject(Object value)
          Method for writing given Java object (POJO) as Json.
 voidwriteRawValue(char[] text, int offset, int len)
           
 voidwriteRawValue(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).
 voidwriteRawValue(String text, int offset, int len)
           
 voidwriteString(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.
 voidwriteTree(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 com.fasterxml.jackson.core.JsonGenerator
canUseSchema, configure, getCharacterEscapes, getHighestEscapedChar, getOutputTarget, setCharacterEscapes, setHighestNonEscapedChar, setPrettyPrinter, setSchema, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBoolean, writeBooleanField, writeEndArray, writeEndObject, writeFieldName, writeNull, writeNullField, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeRaw, writeRaw, writeRaw, writeRaw, writeRawUTF8String, writeStartArray, writeStartObject, writeString, writeString, writeStringField, writeUTF8String
 
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.


_cfgNumbersAsStrings

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


_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

GeneratorBase

protected GeneratorBase(int features,                        ObjectCodec codec)
Method Detail

version

public Version version()
Implemented with detection that tries to find "VERSION.txt" in same package as the implementation class.

Specified by:
version in interface Versioned
Specified by:
version in class JsonGenerator

enable

public JsonGenerator enable(JsonGenerator.Feature f)
Description copied from class: JsonGenerator
Method for enabling specified parser features: check JsonGenerator.Feature for list of available features.

Specified by:
enable in class JsonGenerator
Returns:
Generator itself (this), to allow chaining

disable

public JsonGenerator disable(JsonGenerator.Feature f)
Description copied from class: JsonGenerator
Method for disabling specified features (check JsonGenerator.Feature for list of features)

Specified by:
disable in class JsonGenerator
Returns:
Generator itself (this), to allow chaining

isEnabled

public final boolean isEnabled(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:
isEnabled in class JsonGenerator

useDefaultPrettyPrinter

public JsonGenerator useDefaultPrettyPrinter()
Description copied from class: JsonGenerator
Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter).

Specified by:
useDefaultPrettyPrinter in class JsonGenerator
Returns:
Generator itself (this), to allow chaining

setCodec

public JsonGenerator 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
Returns:
Generator itself (this), to allow chaining

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.

writeFieldName

public void writeFieldName(SerializableString name)                    throws IOException,                           JsonGenerationException
Description copied from class: JsonGenerator
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.

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

Specified by:
writeFieldName in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeString

public void writeString(SerializableString text)                 throws IOException,                        JsonGenerationException
Description copied from class: JsonGenerator
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.

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

Specified by:
writeString in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeRawValue

public void writeRawValue(String text)                   throws IOException,                          JsonGenerationException
Description copied from class: JsonGenerator
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). Assuming this, proper separators are added if and as needed (comma or colon), and generator state updated to reflect this.

Specified by:
writeRawValue in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeRawValue

public void writeRawValue(String text,                          int offset,                          int len)                   throws IOException,                          JsonGenerationException
Specified by:
writeRawValue in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeRawValue

public void writeRawValue(char[] text,                          int offset,                          int len)                   throws IOException,                          JsonGenerationException
Specified by:
writeRawValue in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeObject

public void writeObject(Object value)                 throws 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:
IOException
JsonProcessingException

writeTree

public void writeTree(TreeNode rootNode)               throws 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:
IOException
JsonProcessingException

flush

public abstract void flush()                    throws 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:
IOException

close

public void close()           throws 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 interface Closeable
Specified by:
close in class JsonGenerator
Throws:
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 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:
IOException
JsonProcessingException

copyCurrentStructure

public final void copyCurrentStructure(JsonParser jp)                                throws 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:

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:
IOException
JsonProcessingException

_releaseBuffers

protected abstract void _releaseBuffers()

_verifyValueWrite

protected abstract void _verifyValueWrite(String typeMsg)                                   throws IOException,                                          JsonGenerationException
Throws:
IOException
JsonGenerationException

_reportError

protected void _reportError(String msg)                     throws JsonGenerationException
Throws:
JsonGenerationException

_cantHappen

protected void _cantHappen()

_writeSimpleObject

protected void _writeSimpleObject(Object value)                           throws IOException,                                  JsonGenerationException
Helper method to try to call appropriate write method for given untyped Object. At this point, no structural conversions should be done, only simple basic types are to be coerced as necessary.

Parameters:
value - Non-null value to write
Throws:
IOException
JsonGenerationException

_throwInternal

protected final void _throwInternal()

_reportUnsupportedOperation

protected void _reportUnsupportedOperation()


Copyright © 2012
fasterxml.com. All Rights Reserved.


NOTHING
NOTHING
Add the Maven Dependecy to your project: maven dependecy for com.amazonaws : aws-java-sdk : 1.3.14