public abstract Class GeneratorBase

Implements abstract tools.jackson.core.JsonGenerator.close.

Implements java.io.Closeable.close.

Doc from tools.jackson.core.JsonGenerator.close.

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

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.configure.

Doc from tools.jackson.core.JsonGenerator.configure.

Method for enabling or disabling specified feature: check StreamWriteFeature for list of available features.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.has.

Doc from tools.jackson.core.JsonGenerator.has.

Accessor for checking whether this generator has specified capability. Short-hand for: return getWriteCapabilities().isEnabled(capability);

Annotations

@Override

Accessor for use by jackson-core itself (tests in particular).

Returns:IOContext

IOContext in use by this generator

Implements abstract tools.jackson.core.JsonGenerator.isClosed.

Doc from tools.jackson.core.JsonGenerator.isClosed.

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

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.isEnabled.

Doc from tools.jackson.core.JsonGenerator.isEnabled.

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

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.objectWriteContext.

Doc from tools.jackson.core.JsonGenerator.objectWriteContext.

Accessor for context object provided by higher-level databinding functionality (or, in some cases, simple placeholder of the same) that allows some level of interaction including ability to trigger serialization of Object values through generator instance.

Annotations

@Override

Overrides tools.jackson.core.JsonGenerator.streamWriteConstraints.

Doc from tools.jackson.core.JsonGenerator.streamWriteConstraints.

Get the constraints to apply when performing streaming writes.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.streamWriteFeatures.

Doc from tools.jackson.core.JsonGenerator.streamWriteFeatures.

Bulk access method for getting state of all standard (format-agnostic) StreamWriteFeatures.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeBinary.

Doc from tools.jackson.core.JsonGenerator.writeBinary.

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.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeName.

Doc from tools.jackson.core.JsonGenerator.writeName.

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

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writePOJO.

Doc from tools.jackson.core.JsonGenerator.writePOJO.

Method for writing given Java object (POJO) as tokens into stream this generator manages; serialization must be a valid JSON Value (Object, Array, null, Number, String or Boolean). This is done by delegating call to ObjectWriteContext#writeValue(JsonGenerator, Object).

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeRawValue.

Doc from tools.jackson.core.JsonGenerator.writeRawValue.

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.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeRawValue.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeRawValue.

Annotations

@Override

Overrides tools.jackson.core.JsonGenerator.writeRawValue.

Doc from tools.jackson.core.JsonGenerator.writeRawValue.

Method similar to writeRawValue(String), but potentially more efficient as it may be able to use pre-encoded content (similar to writeRaw(SerializableString).

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeStartArray.

Doc from tools.jackson.core.JsonGenerator.writeStartArray.

Method for writing start marker of an Array value, similar to writeStartArray(), but also specifying what is the Java object that the Array Object being written represents (if any) and how many elements will be written for the array before calling writeEndArray().

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeStartObject.

Doc from tools.jackson.core.JsonGenerator.writeStartObject.

Method for writing starting marker of an Object value to represent the given Java Object value. Argument is offered as metadata, but more importantly it should be assigned as the "current value" for the Object content that gets constructed and initialized. In addition, caller knows number of key/value pairs ("properties") that will get written for the Object value: this is relevant for some format backends (but not, as an example, for JSON).

Object values can be written in any context where values are allowed: meaning everywhere except for when a property name is expected.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeString.

Doc from tools.jackson.core.JsonGenerator.writeString.

Method for outputting a String value. Depending on context this means either array element, (object) property value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification. If len is < 0, then write all contents of the reader. Otherwise, write only len characters.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeString.

Doc from tools.jackson.core.JsonGenerator.writeString.

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.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeTree.

Doc from tools.jackson.core.JsonGenerator.writeTree.

Method for writing given JSON tree (expressed as a tree where given TreeNode is the root) using this generator. This is done by delegating call to ObjectWriteContext#writeTree.

Annotations

@Override