TokenStreamFactory instance.
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| protected StreamWriteException | |
| protected StreamWriteException | |
| protected StreamWriteException | |
| protected StreamWriteException | |
| protected void | |
| protected void | |
| protected void | _copyCurrentFloatValue(JsonParser
Parser that points to the value to copy p)Method for copying current |
| protected void | _copyCurrentFloatValueExact(JsonParser
Parser that points to the value to copy p)Method for copying current |
| protected void | _copyCurrentIntValue(JsonParser
Parser that points to the value to copy p)Method for copying current |
| protected void | _copyCurrentStringValue(JsonParser
Parser that points to the value to copy p)Method for copying current |
| protected < Bogus type parameter to "return anything" so that compiler
won't complain when chaining calls T> T | Returns: Does not return at all as exception is always thrown, but nominally returns "anything"Message to construct exception with msg)Helper method used for constructing and throwing
|
| protected < Bogus type parameter to "return anything" so that compiler
won't complain when chaining calls T> T | Returns: Does not return at all as exception is always thrown, but nominally returns "anything"Message to construct exception with msg)Helper method used for constructing and throwing
|
| protected <T> T | |
| protected <T> T | |
| protected final void | |
| protected JacksonException | |
| protected boolean | Returns: True if start of an object has been written, False otherwise.Writes a native type id (when supported by format). |
| protected boolean | Returns: True if start of an object has been written, false otherwise.Writes a wrapper for the type id if necessary. |
| public abstract void | assignCurrentValue(Object
"Current value" to assign to the current output context of this generator v)Helper method, usually equivalent to:
|
| public boolean | Returns: True if this generator is allowed to only write values
of some Object properties and omit the rest; false if notIntrospection method to call to check whether it is ok to omit writing of Object properties or not. |
| public boolean | Returns: True if this generator is capable of writing "native" Object Ids
(which is typically determined by capabilities of the underlying format),
false if notIntrospection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't). |
| public boolean | Returns: True if this generator is capable of writing "native" Type Ids
(which is typically determined by capabilities of the underlying format),
false if notIntrospection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't). |
| public abstract void | close()
Redeclares java. Method called to close this generator, so that no more content can be written. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingFeature to enable or disable f, boolean Whether to enable the feature ( state)true) or disable (false)Method for enabling or disabling specified feature:
check |
| public void | copyCurrentEvent(JsonParser
Parser that points to the event to copy p)Method for copying contents of the current event that the given parser instance points to. |
| public void | copyCurrentEventExact(JsonParser
Parser that points to the event to copy p)Same as |
| public void | copyCurrentStructure(JsonParser
Parser that points to the value to copy p)Method for copying contents of the current event and following events that it encloses the given parser instance points to. |
| public void | copyCurrentStructureExact(JsonParser
Parser that points to the value to copy p)Same as |
| public abstract Object | Returns: "Current value" for the current context this generator hasHelper method, usually equivalent to:
Note that "current value" is NOT populated (or used) by Streaming generator; it is only used by higher-level data-binding functionality. |
| public abstract void | flush()
Redeclares java. Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well. |
| public CharacterEscapes | getCharacterEscapes()
Method for accessing custom escapes generator uses for |
| public int | Returns: Currently active limitation for highest non-escaped character, if defined; or 0 to indicate no additional escaping is performed.Accessor method for testing what is the highest unescaped character configured for this generator. |
| public PrettyPrinter | Returns: Pretty printer used by this generator, if any;null if noneAccessor for object that handles pretty-printing (usually additional white space to make results more human-readable) during output. |
| public FormatSchema | |
| public abstract boolean | Returns: True if this generator has specified capability; false if notCapability to check capability)Accessor for checking whether this generator has specified capability. |
| public abstract boolean | Returns: True if this generator has been closed; false if notMethod that can be called to determine whether this generator is closed or not. |
| public abstract boolean | Returns: True if feature is enabled; false if notFeature to check f)Method for checking whether given feature is enabled. |
| public abstract ObjectWriteContext | Returns: Object write context (ObjectWriteContext) associated with this generatorAccessor 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. |
| public JsonGenerator | Returns: This generator, to allow call chainingCharacterEscapes to configure this generator to use, if any; null if noneMethod for defining custom escapes factory uses for |
| public abstract JacksonFeatureSet | Returns: Set of read capabilities for content to generate via this generatorAccessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly). |
| public StreamWriteConstraints | Returns: Constraints used for this generatorGet the constraints to apply when performing streaming writes. |
| public abstract TokenStreamContext | Returns: Stream output context (TokenStreamContext) associated with this generatorAccessor for context object that provides information about low-level logical position withing output token stream. |
| public abstract int | Returns: Bit mask that defines current states of all standardStreamWriteFeatures.Bulk access method for getting state of all standard (format-agnostic)
|
| public abstract int | Returns: Amount of content buffered in internal units, if amount known and accessible; -1 if not accessible.Method for verifying amount of content that is buffered by generator but not yet flushed to the underlying target (stream, writer), in units (byte, char) that the generator implementation uses for buffering; or -1 if this information is not available. |
| public abstract Object | Returns: Output target this generator was configured withMethod that can be used to get access to object that is used
as target for generated output; this is usually either
|
| public abstract Version | version()
Redeclares tools. Accessor for finding out version of the bundle that provided this generator instance. |
| public JsonGenerator | Returns: This generator, to allow call chainingArray that contains values to write array, int Offset of the first element to write, within array offset, int Number of elements in array to write, from `offset` to `offset + len - 1` length)Value write method that can be called to write a single
array (sequence of |
| public JsonGenerator | Returns: This generator, to allow call chainingArray that contains values to write array, int Offset of the first element to write, within array offset, int Number of elements in array to write, from `offset` to `offset + len - 1` length)Value write method that can be called to write a single
array (sequence of |
| public JsonGenerator | Returns: This generator, to allow call chainingArray that contains values to write array, int Offset of the first element to write, within array offset, int Number of elements in array to write, from `offset` to `offset + len - 1` length)Value write method that can be called to write a single
array (sequence of |
| public JsonGenerator | Returns: This generator, to allow call chainingArray that contains values to write array, int Offset of the first element to write, within array offset, int Number of elements in array to write, from `offset` to `offset + len - 1` length)Value write method that can be called to write a single
array (sequence of |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the Array property to write propertyName)Convenience method for outputting an Object property (that will contain a JSON Array value), and the START_ARRAY marker. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingBase64 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. bv, byte[] Buffer that contains binary data to write data, int Offset in offset, int data of the first byte of data to writeLength of data to write len)Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes). |
| public JsonGenerator | Returns: This generator, to allow call chainingBuffer that contains binary data to write data, int Offset in offset, int data of the first byte of data to writeLength of data to write len)Similar to |
| public JsonGenerator | Returns: This generator, to allow call chainingBuffer that contains binary data to write data)Similar to |
| public int | Returns: Number of bytes actually writtenInputStream to use for reading binary data to write.
Will not be closed after successful write operation data, int (optional) number of bytes that will be available;
or -1 to be indicate it is not known. Note that implementations
need not support cases where length is not known in advance; this
depends on underlying data format: JSON output does NOT require length,
other formats may dataLength)Similar to |
| public abstract int | Returns: Number of bytes read fromdata and written as binary payloadBase64 variant to use bv, InputStream InputStream to use for reading binary data to write.
Will not be closed after successful write operation data, int (optional) number of bytes that will be available;
or -1 to be indicate it is not known.
If a positive length is given, dataLength)data MUST provide at least
that many bytes: if not, an exception will be thrown.
Note that implementations
need not support cases where length is not known in advance; this
depends on underlying data format: JSON output does NOT require length,
other formats may.Method similar to |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of Object Property to write propertyName, byte[] Binary value of the property to write data)Convenience method for outputting an Object property that contains specified data in base64-encoded form. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingBoolean value to write state)Method for outputting literal JSON boolean value (one of Strings 'true' and 'false'). |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of Object Property to write propertyName, boolean Boolean value of the property to write value)Convenience method for outputting an Object property that has a boolean value. |
| public JsonGenerator | Returns: This generator, to allow call chainingNative format-specific value to write object)Method that can be called on backends that support passing opaque native values that some data formats support; not used with JSON backend, more common with binary formats. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingMethod for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled). |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingMethod for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled). |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingName of the Object Property to write name)Method for writing an Object Property name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingPre-encoded name of the Object Property to write name)Method similar to |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingMethod for outputting literal JSON null value. |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the null-valued property to write propertyName)Convenience method for outputting an Object property that has JSON literal value null. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingNumber value to write v)Method for outputting given value as JSON number. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingNumber value to write v)Method for outputting given value as JSON number. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingNumber value to write v)Method for outputting given value as JSON number. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingNumber value to write v)Method for outputting given value as JSON number. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingNumber value to write v)Method for outputting indicate JSON numeric value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingNumber value to write v)Method for outputting indicate JSON numeric value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingNumber value to write v)Method for outputting indicate JSON numeric value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingTextual (possibly format) number representation to write encodedValue)Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types. |
| public JsonGenerator | Returns: This generator, to allow call chainingBuffer that contains the textual number representation to write encodedValueBuffer, int Offset of the first character of value to write offset, int Length of the value (in characters) to write len)Overloaded version of |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, short Numeric value of the property to write value)Convenience method for outputting an Object property that has the specified numeric value. |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, int Numeric value of the property to write value)Convenience method for outputting an Object property that has the specified numeric value. |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, long Numeric value of the property to write value)Convenience method for outputting an Object property that has the specified numeric value. |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, BigInteger Numeric value of the property to write value)Convenience method for outputting an Object property that has the specified numeric value. |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, float Numeric value of the property to write value)Convenience method for outputting an Object property that has the specified numeric value. |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, double Numeric value of the property to write value)Convenience method for outputting an Object property that has the specified numeric value. |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, BigDecimal Numeric value of the property to write value)Convenience method for outputting an Object property that has the specified numeric value. |
| public JsonGenerator | Returns: This generator, to allow call chainingNative Object Id to write id)Method that can be called to output so-called native Object Id.
Note that it may only be called after ensuring this is legal
(with |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the Object property to write propertyName)Convenience method for outputting an Object property (that will contain an Object value), and the START_OBJECT marker. |
| public JsonGenerator | Returns: This generator, to allow call chainingReferenced value, for which Object Id is expected to be written referenced)Method that can be called to output references to native Object Ids. |
| public JsonGenerator | Returns: This generator, to allow call chainingName of the property that is being omitted propertyName)Method called to indicate that a property in this position was skipped. |
| public abstract JsonGenerator | |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, Object POJO value of the property to write pojo)Convenience method for outputting am Object property that has contents of specific Java object (POJO) as its value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingProperty key id to write id)Alternative to |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingTextual contents to include as-is in output. text)Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingString that has contents to include as-is in output text, int Offset within offset, int text of the first character to outputLength of content (from len)text, starting at offset offset) to outputMethod that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingBuffer that has contents to include as-is in output buffer, int Offset within offset, int text of the first character to outputLength of content (from len)text, starting at offset offset) to outputMethod that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingCharacter to included in output c)Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
| public JsonGenerator | Returns: This generator, to allow call chainingPre-encoded textual contents to included in output raw)Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingBuffer that contains String value to write buffer, int Offset in offset, int buffer of the first byte of String value to writeLength of the String value (in characters) to write len)Method similar to |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingTextual contents to included in output 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). |
| public abstract JsonGenerator | |
| public abstract JsonGenerator | |
| public JsonGenerator | Returns: This generator, to allow call chainingPre-encoded textual contents to included in output raw)Method similar to |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingMethod for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled). |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingJava Object that Array being written represents, if any
(or currentValue)null if not known or not applicable)Method for writing start marker of an Array value, similar
to |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingJava Object that Array being written represents, if any
(or currentValue, int null if not known or not applicable)Number of elements this Array will have: actual
number of values written (before matching call to
size)writeEndArray() MUST match; generator MAY verify
this is the case (and SHOULD if format itself encodes length)Method for writing start marker of an Array value, similar
to |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingMethod for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled). |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingJava Object that Object being written represents, if any
(or currentValue)null if not known or not applicable)Method for writing starting marker of an Object value to represent the given Java Object value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingObject value to be written (assigned as "current value" for
the Object context that gets created) forValue, int Number of key/value pairs this Object will have: actual
number of entries written (before matching call to
size)writeEndObject() MUST match; generator MAY verify
this is the case (and SHOULD if format itself encodes length)Method for writing starting marker of an Object value to represent the given Java Object value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingString value to write value)Method for outputting a String value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingReader to use for reading Text value to write reader, int Maximum Length of Text value to read (in len)chars, non-negative)
if known; -1 to indicate "read and write it all"Method for outputting a String value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingBuffer that contains String value to write buffer, int Offset in offset, int buffer of the first character of String value to writeLength of the String value (in characters) to write len)Method for outputting a String value. |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingPre-encoded String value to write value)Method similar to |
| public final JsonGenerator | Returns: This generator, to allow call chainingName of the property to write propertyName, String String value of the property to write value)Convenience method for outputting an Object property that has a String value. |
| public abstract JsonGenerator | |
| public JsonGenerator | Returns: This generator, to allow call chainingNative Type Id to write id)Method that can be called to output so-called native Type Id.
Note that it may only be called after ensuring this is legal
(with |
| public WritableTypeId | writeTypePrefix(WritableTypeId
Full Type Id definition typeIdDef)Replacement method for |
| public WritableTypeId | |
| public abstract JsonGenerator | Returns: This generator, to allow call chainingBuffer that contains String value to write buffer, int Offset in offset, int buffer of the first byte of String value to writeLength of the String value (in characters) to write len)Method similar to |