GeneratorBase

Flag set to indicate that implicit conversion from number to JSON String is needed (as per WRITE_NUMBERS_AS_STRINGS).

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

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

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

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

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)

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:

• START_OBJECT: all events up to and including matching (closing) END_OBJECT will be copied
• START_ARRAY all events up to and including matching (closing) END_ARRAY will be copied
• 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.

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

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

Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.

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

Note: co-variant return type.

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

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

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

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

Implemented with detection that tries to find "VERSION.txt" in same package as the implementation class.

Method similar to writeBinary(Base64Variant, byte[], int, int), but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.

Method similar to 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.

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.

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.

Method similar to 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 writeString(String); sub-classes should override it with more efficient implementation if possible.

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

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.