Module tools.jackson.core
Package tools.jackson.core.util

Class JsonGeneratorDelegate

java.lang.Object
tools.jackson.core.JsonGenerator
tools.jackson.core.util.JsonGeneratorDelegate
All Implemented Interfaces:
Closeable, Flushable, AutoCloseable, Versioned
Direct Known Subclasses:
FilteringGeneratorDelegate
public class JsonGeneratorDelegate extends JsonGenerator

  • Field Details

  • Constructor Details

    • JsonGeneratorDelegate

      public JsonGeneratorDelegate(JsonGenerator d)

    • JsonGeneratorDelegate

      public JsonGeneratorDelegate(JsonGenerator d, boolean delegateCopyMethods)
      Parameters:
      d - Underlying generator to delegate calls to
      delegateCopyMethods - Flag assigned to delagateCopyMethod and which defines whether copy methods are handled locally (false), or delegated to configured

  • Method Details

    • currentValue

      public Object currentValue()
      Description copied from class: JsonGenerator
      Helper method, usually equivalent to: getOutputContext().currentValue();

      Note that "current value" is NOT populated (or used) by Streaming generator; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.

      Specified by:
      currentValue in class JsonGenerator
      Returns:
      "Current value" for the current context this generator has

    • assignCurrentValue

      public void assignCurrentValue(Object v)
      Description copied from class: JsonGenerator
      Helper method, usually equivalent to: getOutputContext().assignCurrentValue(v); used to assign "current value" for the current context of this generator. It is usually assigned and used by higher level data-binding functionality (instead of streaming parsers/generators) but is stored at streaming level.
      Specified by:
      assignCurrentValue in class JsonGenerator
      Parameters:
      v - "Current value" to assign to the current output context of this generator

    • getSchema

      public FormatSchema getSchema()
      Description copied from class: JsonGenerator
      Method for accessing Schema that this generator uses, if any. Default implementation returns null.
      Overrides:
      getSchema in class JsonGenerator
      Returns:
      FormatSchema this generator is configured to use, if any; null if none

    • version

      public Version version()
      Description copied from class: JsonGenerator
      Accessor for finding out version of the bundle that provided this generator instance.
      Specified by:
      version in interface Versioned
      Specified by:
      version in class JsonGenerator
      Returns:
      Version of the component

    • streamWriteOutputTarget

      public Object streamWriteOutputTarget()
      Description copied from class: JsonGenerator
      Method that can be used to get access to object that is used as target for generated output; this is usually either OutputStream or Writer, depending on what generator was constructed with. Note that returned value may be null in some cases; including case where implementation does not want to exposed raw source to caller. In cases where output has been decorated, object returned here is the decorated version; this allows some level of interaction between users of generator and decorator object.

      In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.

      NOTE: was named getOutputTarget() in Jackson 2.x.

      Specified by:
      streamWriteOutputTarget in class JsonGenerator
      Returns:
      Output target this generator was configured with

    • streamWriteOutputBuffered

      public int streamWriteOutputBuffered()
      Description copied from class: JsonGenerator
      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. Unit used is often the same as the unit of underlying target (that is, byte for OutputStream, char for Writer), but may differ if buffering is done before encoding. Default JSON-backed implementations do use matching units.

      NOTE: was named getOutputBuffered() in Jackson 2.x.

      Specified by:
      streamWriteOutputBuffered in class JsonGenerator
      Returns:
      Amount of content buffered in internal units, if amount known and accessible; -1 if not accessible.

    • canWriteTypeId

      public boolean canWriteTypeId()
      Description copied from class: JsonGenerator
      Introspection 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). This method must be called prior to calling JsonGenerator.writeTypeId(java.lang.Object).

      Default implementation returns false; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it cannot use native type ids.

      Overrides:
      canWriteTypeId in class JsonGenerator
      Returns:
      True if this generator is capable of writing "native" Type Ids (which is typically determined by capabilities of the underlying format), false if not

    • canWriteObjectId

      public boolean canWriteObjectId()
      Description copied from class: JsonGenerator
      Introspection 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). This method must be called prior to calling JsonGenerator.writeObjectId(java.lang.Object) or JsonGenerator.writeObjectRef(java.lang.Object).

      Default implementation returns false; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it cannot use native object ids.

      Overrides:
      canWriteObjectId in class JsonGenerator
      Returns:
      True if this generator is capable of writing "native" Object Ids (which is typically determined by capabilities of the underlying format), false if not

    • canOmitProperties

      public boolean canOmitProperties()
      Description copied from class: JsonGenerator
      Introspection method to call to check whether it is ok to omit writing of Object properties or not. Most formats do allow omission, but certain positional formats (such as CSV) require output of place holders, even if no real values are to be emitted.

      NOTE: in Jackson 2.x method was canOmitFields().

      Overrides:
      canOmitProperties in class JsonGenerator
      Returns:
      True if this generator is allowed to only write values of some Object properties and omit the rest; false if not

    • streamWriteCapabilities

      public JacksonFeatureSet<StreamWriteCapability> streamWriteCapabilities()
      Description copied from class: JsonGenerator
      Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).
      Specified by:
      streamWriteCapabilities in class JsonGenerator
      Returns:
      Set of read capabilities for content to generate via this generator

    • isEnabled

      public boolean isEnabled(StreamWriteFeature f)
      Description copied from class: JsonGenerator
      Method for checking whether given feature is enabled. Check StreamWriteFeature for list of available features.
      Specified by:
      isEnabled in class JsonGenerator
      Parameters:
      f - Feature to check
      Returns:
      True if feature is enabled; false if not

    • streamWriteFeatures

      public int streamWriteFeatures()
      Description copied from class: JsonGenerator
      Bulk access method for getting state of all standard (format-agnostic) StreamWriteFeatures.
      Specified by:
      streamWriteFeatures in class JsonGenerator
      Returns:
      Bit mask that defines current states of all standard StreamWriteFeatures.

    • configure

      public JsonGenerator configure(StreamWriteFeature f, boolean state)
      Description copied from class: JsonGenerator
      Method for enabling or disabling specified feature: check StreamWriteFeature for list of available features.

      NOTE: mostly left in 3.0 just to support disabling of StreamWriteFeature.AUTO_CLOSE_CONTENT by jackson-databind

      Specified by:
      configure in class JsonGenerator
      Parameters:
      f - Feature to enable or disable
      state - Whether to enable the feature (true) or disable (false)
      Returns:
      This generator, to allow call chaining

    • getHighestNonEscapedChar

      public int getHighestNonEscapedChar()
      Description copied from class: JsonGenerator
      Accessor method for testing what is the highest unescaped character configured for this generator. This may be either positive value (when escaping configuration has been set and is in effect), or 0 to indicate that no additional escaping is in effect. Some generators may not support additional escaping: for example, generators for binary formats that do not use escaping should simply return 0.
      Overrides:
      getHighestNonEscapedChar in class JsonGenerator
      Returns:
      Currently active limitation for highest non-escaped character, if defined; or 0 to indicate no additional escaping is performed.

    • getCharacterEscapes

      public CharacterEscapes getCharacterEscapes()
      Description copied from class: JsonGenerator
      Method for accessing custom escapes generator uses for JsonGenerators it creates.
      Overrides:
      getCharacterEscapes in class JsonGenerator
      Returns:
      CharacterEscapes this generator is configured to use, if any; null if none

    • writeStartArray

      public JsonGenerator writeStartArray() throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).

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

      Specified by:
      writeStartArray in class JsonGenerator
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeStartArray

      public JsonGenerator writeStartArray(Object forValue) throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing start marker of an Array value, similar to JsonGenerator.writeStartArray(), but also specifying what is the Java object that the Array Object being written represents (if any); null may be passed if not known or not applicable. This value is accessible from context as "current value"
      Specified by:
      writeStartArray in class JsonGenerator
      Parameters:
      forValue - Java Object that Array being written represents, if any (or null if not known or not applicable)
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeStartArray

      public JsonGenerator writeStartArray(Object forValue, int size) throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing start marker of an Array value, similar to JsonGenerator.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 JsonGenerator.writeEndArray().
      Specified by:
      writeStartArray in class JsonGenerator
      Parameters:
      forValue - Java Object that Array being written represents, if any (or null if not known or not applicable)
      size - Number of elements this Array will have: actual number of values written (before matching call to JsonGenerator.writeEndArray() MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length)
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeEndArray

      public JsonGenerator writeEndArray() throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).

      Marker can be written if the innermost structured type is Array.

      Specified by:
      writeEndArray in class JsonGenerator
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeStartObject

      public JsonGenerator writeStartObject() throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).

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

      Specified by:
      writeStartObject in class JsonGenerator
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeStartObject

      public JsonGenerator writeStartObject(Object forValue) throws JacksonException
      Description copied from class: JsonGenerator
      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.

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

      Specified by:
      writeStartObject in class JsonGenerator
      Parameters:
      forValue - Java Object that Object being written represents, if any (or null if not known or not applicable)
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeStartObject

      public JsonGenerator writeStartObject(Object forValue, int size) throws JacksonException
      Description copied from class: JsonGenerator
      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.

      Specified by:
      writeStartObject in class JsonGenerator
      Parameters:
      forValue - Object value to be written (assigned as "current value" for the Object context that gets created)
      size - Number of key/value pairs this Object will have: actual number of entries written (before matching call to JsonGenerator.writeEndObject() MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length)
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeEndObject

      public JsonGenerator writeEndObject() throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).

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

      Specified by:
      writeEndObject in class JsonGenerator
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeName

      public JsonGenerator writeName(String name) throws JacksonException
      Description copied from class: JsonGenerator
      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.

      Property names can only be written in Object context (check out JSON specification for details), when Object Property name is expected (property names alternate with values).

      Specified by:
      writeName in class JsonGenerator
      Parameters:
      name - Name of the Object Property to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeName

      public JsonGenerator writeName(SerializableString name) throws JacksonException
      Description copied from class: JsonGenerator
      Method similar to JsonGenerator.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.

      Specified by:
      writeName in class JsonGenerator
      Parameters:
      name - Pre-encoded name of the Object Property to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writePropertyId

      public JsonGenerator writePropertyId(long id) throws JacksonException
      Description copied from class: JsonGenerator
      Alternative to JsonGenerator.writeName(String) that may be used in cases where Object Property key is of numeric type; usually where underlying format supports such notion (some binary formats do, unlike JSON). Default implementation will simply convert id into String and call JsonGenerator.writeName(String).
      Specified by:
      writePropertyId in class JsonGenerator
      Parameters:
      id - Property key id to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeArray

      public JsonGenerator writeArray(int[] array, int offset, int length) throws JacksonException
      Description copied from class: JsonGenerator
      Value write method that can be called to write a single array (sequence of JsonToken.START_ARRAY, zero or more JsonToken.VALUE_NUMBER_INT, JsonToken.END_ARRAY)
      Overrides:
      writeArray in class JsonGenerator
      Parameters:
      array - Array that contains values to write
      offset - Offset of the first element to write, within array
      length - Number of elements in array to write, from `offset` to `offset + len - 1`
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeArray

      public JsonGenerator writeArray(long[] array, int offset, int length) throws JacksonException
      Description copied from class: JsonGenerator
      Value write method that can be called to write a single array (sequence of JsonToken.START_ARRAY, zero or more JsonToken.VALUE_NUMBER_INT, JsonToken.END_ARRAY)
      Overrides:
      writeArray in class JsonGenerator
      Parameters:
      array - Array that contains values to write
      offset - Offset of the first element to write, within array
      length - Number of elements in array to write, from `offset` to `offset + len - 1`
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeArray

      public JsonGenerator writeArray(double[] array, int offset, int length) throws JacksonException
      Description copied from class: JsonGenerator
      Value write method that can be called to write a single array (sequence of JsonToken.START_ARRAY, zero or more JsonToken.VALUE_NUMBER_FLOAT, JsonToken.END_ARRAY)
      Overrides:
      writeArray in class JsonGenerator
      Parameters:
      array - Array that contains values to write
      offset - Offset of the first element to write, within array
      length - Number of elements in array to write, from `offset` to `offset + len - 1`
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeArray

      public JsonGenerator writeArray(String[] array, int offset, int length) throws JacksonException
      Description copied from class: JsonGenerator
      Value write method that can be called to write a single array (sequence of JsonToken.START_ARRAY, zero or more JsonToken.VALUE_STRING, JsonToken.END_ARRAY)
      Overrides:
      writeArray in class JsonGenerator
      Parameters:
      array - Array that contains values to write
      offset - Offset of the first element to write, within array
      length - Number of elements in array to write, from `offset` to `offset + len - 1`
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeString

      public JsonGenerator writeString(String text) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting a String value. Depending on context this means either array element, (object) property value or a stand-alone (root-level value) String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.
      Specified by:
      writeString in class JsonGenerator
      Parameters:
      text - String value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeString

      public JsonGenerator writeString(Reader reader, int len) throws JacksonException
      Description copied from class: JsonGenerator
      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.

      Note: actual length of content available may exceed len but cannot be less than it: if not enough content available, a StreamWriteException will be thrown.

      Specified by:
      writeString in class JsonGenerator
      Parameters:
      reader - Reader to use for reading Text value to write
      len - Maximum Length of Text value to read (in chars, non-negative) if known; -1 to indicate "read and write it all"
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream (including the case where reader does not provide enough content)
      JacksonException

    • writeString

      public JsonGenerator writeString(char[] text, int offset, int len) throws JacksonException
      Description copied from class: JsonGenerator
      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.
      Specified by:
      writeString in class JsonGenerator
      Parameters:
      text - Buffer that contains String value to write
      offset - Offset in buffer of the first character of String value to write
      len - Length of the String value (in characters) to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeString

      public JsonGenerator writeString(SerializableString text) throws JacksonException
      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
      Parameters:
      text - Pre-encoded String value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRawUTF8String

      public JsonGenerator writeRawUTF8String(byte[] text, int offset, int length) throws JacksonException
      Description copied from class: JsonGenerator
      Method similar to JsonGenerator.writeString(String) but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON). However, quoting that data format requires (like double-quotes for JSON) will be added around the value if and as necessary.

      Note that some backends may choose not to support this method: for example, if underlying destination is a Writer using this method would require UTF-8 decoding. If so, implementation may instead choose to throw a UnsupportedOperationException due to ineffectiveness of having to decode input.

      Specified by:
      writeRawUTF8String in class JsonGenerator
      Parameters:
      text - Buffer that contains String value to write
      offset - Offset in buffer of the first byte of String value to write
      length - Length of the String value (in characters) to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeUTF8String

      public JsonGenerator writeUTF8String(byte[] text, int offset, int length) throws JacksonException
      Description copied from class: JsonGenerator
      Method similar to JsonGenerator.writeString(String) but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else). This means that textual JSON backends need to check if value needs JSON escaping, but otherwise can just be copied as is to output. Also, quoting that data format requires (like double-quotes for JSON) will be added around the value if and as necessary.

      Note that some backends may choose not to support this method: for example, if underlying destination is a Writer using this method would require UTF-8 decoding. In this case generator implementation may instead choose to throw a UnsupportedOperationException due to ineffectiveness of having to decode input.

      Specified by:
      writeUTF8String in class JsonGenerator
      Parameters:
      text - Buffer that contains String value to write
      offset - Offset in buffer of the first byte of String value to write
      length - Length of the String value (in characters) to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRaw

      public JsonGenerator writeRaw(String text) throws JacksonException
      Description copied from class: JsonGenerator
      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). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

      Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

      Specified by:
      writeRaw in class JsonGenerator
      Parameters:
      text - Textual contents to include as-is in output.
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRaw

      public JsonGenerator writeRaw(String text, int offset, int len) throws JacksonException
      Description copied from class: JsonGenerator
      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). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

      Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

      Specified by:
      writeRaw in class JsonGenerator
      Parameters:
      text - String that has contents to include as-is in output
      offset - Offset within text of the first character to output
      len - Length of content (from text, starting at offset offset) to output
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRaw

      public JsonGenerator writeRaw(SerializableString raw) throws JacksonException
      Description copied from class: JsonGenerator
      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). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

      Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

      The default implementation delegates to JsonGenerator.writeRaw(String); other backends that support raw inclusion of text are encouraged to implement it in more efficient manner (especially if they use UTF-8 encoding).

      Overrides:
      writeRaw in class JsonGenerator
      Parameters:
      raw - Pre-encoded textual contents to included in output
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRaw

      public JsonGenerator writeRaw(char[] text, int offset, int len) throws JacksonException
      Description copied from class: JsonGenerator
      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). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

      Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

      Specified by:
      writeRaw in class JsonGenerator
      Parameters:
      text - Buffer that has contents to include as-is in output
      offset - Offset within text of the first character to output
      len - Length of content (from text, starting at offset offset) to output
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRaw

      public JsonGenerator writeRaw(char c) throws JacksonException
      Description copied from class: JsonGenerator
      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). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

      Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

      Specified by:
      writeRaw in class JsonGenerator
      Parameters:
      c - Character to included in output
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRawValue

      public JsonGenerator writeRawValue(String text) throws JacksonException
      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
      Parameters:
      text - Textual contents to included in output
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRawValue

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

    • writeRawValue

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

    • writeBinary

      public JsonGenerator writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws JacksonException
      Description copied from class: JsonGenerator
      Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes). This method defaults

      Note: because JSON Strings cannot 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.

      Specified by:
      writeBinary in class JsonGenerator
      Parameters:
      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.
      data - Buffer that contains binary data to write
      offset - Offset in data of the first byte of data to write
      len - Length of data to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeBinary

      public int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws JacksonException
      Description copied from class: JsonGenerator
      Method similar to JsonGenerator.writeBinary(Base64Variant,byte[],int,int), but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.
      Specified by:
      writeBinary in class JsonGenerator
      Parameters:
      b64variant - Base64 variant to use
      data - InputStream to use for reading binary data to write. Will not be closed after successful write operation
      dataLength - (optional) number of bytes that will be available; or -1 to be indicate it is not known. If a positive length is given, 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.
      Returns:
      Number of bytes read from data and written as binary payload
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(short v) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeNumber in class JsonGenerator
      Parameters:
      v - Number value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(int v) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeNumber in class JsonGenerator
      Parameters:
      v - Number value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(long v) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeNumber in class JsonGenerator
      Parameters:
      v - Number value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(BigInteger v) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeNumber in class JsonGenerator
      Parameters:
      v - Number value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(double v) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeNumber in class JsonGenerator
      Parameters:
      v - Number value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(float v) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeNumber in class JsonGenerator
      Parameters:
      v - Number value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(BigDecimal v) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeNumber in class JsonGenerator
      Parameters:
      v - Number value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(String encodedValue) throws JacksonException
      Description copied from class: JsonGenerator
      Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types. Because numbers are not surrounded by double quotes, regular JsonGenerator.writeString(java.lang.String) method cannot be used; nor JsonGenerator.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.

      Specified by:
      writeNumber in class JsonGenerator
      Parameters:
      encodedValue - Textual (possibly format) number representation to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

      public JsonGenerator writeNumber(char[] encodedValueBuffer, int offset, int length) throws JacksonException
      Description copied from class: JsonGenerator
      Overloaded version of JsonGenerator.writeNumber(String) with same semantics but possibly more efficient operation.
      Overrides:
      writeNumber in class JsonGenerator
      Parameters:
      encodedValueBuffer - Buffer that contains the textual number representation to write
      offset - Offset of the first character of value to write
      length - Length of the value (in characters) to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeBoolean

      public JsonGenerator writeBoolean(boolean state) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting literal JSON boolean value (one of Strings 'true' and 'false'). Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeBoolean in class JsonGenerator
      Parameters:
      state - Boolean value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNull

      public JsonGenerator writeNull() throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting literal JSON null value. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
      Specified by:
      writeNull in class JsonGenerator
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeOmittedProperty

      public JsonGenerator writeOmittedProperty(String propName) throws JacksonException
      Description copied from class: JsonGenerator
      Method called to indicate that a property in this position was skipped. It is usually only called for generators that return false from JsonGenerator.canOmitProperties().

      Default implementation does nothing; method is overriden by some format backends.

      Overrides:
      writeOmittedProperty in class JsonGenerator
      Parameters:
      propName - Name of the property that is being omitted
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeObjectId

      public JsonGenerator writeObjectId(Object id) throws JacksonException
      Description copied from class: JsonGenerator
      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 JsonGenerator.canWriteObjectId()), as not all data formats have native type id support; and some may only allow them in certain positions or locations.
      Overrides:
      writeObjectId in class JsonGenerator
      Parameters:
      id - Native Object Id to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream; typically if Object ID output is not allowed (either at all, or specifically in this position in output)
      JacksonException

    • writeObjectRef

      public JsonGenerator writeObjectRef(Object id) throws JacksonException
      Description copied from class: JsonGenerator
      Method that can be called to output references to native Object Ids. Note that it may only be called after ensuring this is legal (with JsonGenerator.canWriteObjectId()), as not all data formats have native type id support; and some may only allow them in certain positions or locations. If output is not allowed by the data format in this position, a StreamWriteException will be thrown.
      Overrides:
      writeObjectRef in class JsonGenerator
      Parameters:
      id - Referenced value, for which Object Id is expected to be written
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream; typically if Object ID output is not allowed (either at all, or specifically in this position in output)
      JacksonException

    • writeTypeId

      public JsonGenerator writeTypeId(Object id) throws JacksonException
      Description copied from class: JsonGenerator
      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 JsonGenerator.canWriteTypeId()), as not all data formats have native type id support; and some may only allow them in certain positions or locations. If output is not allowed by the data format in this position, a StreamWriteException will be thrown.
      Overrides:
      writeTypeId in class JsonGenerator
      Parameters:
      id - Native Type Id to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeEmbeddedObject

      public JsonGenerator writeEmbeddedObject(Object object) throws JacksonException
      Description copied from class: JsonGenerator
      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.

      NOTE: this is NOT the method to call for serializing regular POJOs, see JsonGenerator.writePOJO(java.lang.Object) instead.

      Overrides:
      writeEmbeddedObject in class JsonGenerator
      Parameters:
      object - Native format-specific value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writePOJO

      public JsonGenerator writePOJO(Object pojo) throws JacksonException
      Description copied from class: JsonGenerator
      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).
      Specified by:
      writePOJO in class JsonGenerator
      Parameters:
      pojo - Java Object (POJO) value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeTree

      public JsonGenerator writeTree(TreeNode tree) throws JacksonException
      Description copied from class: JsonGenerator
      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(tools.jackson.core.JsonGenerator, tools.jackson.core.TreeNode).
      Specified by:
      writeTree in class JsonGenerator
      Parameters:
      tree - TreeNode to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • copyCurrentEvent

      public void copyCurrentEvent(JsonParser p) throws JacksonException
      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)

      Overrides:
      copyCurrentEvent in class JsonGenerator
      Parameters:
      p - Parser that points to the event to copy
      Throws:
      JacksonIOException - if there is an underlying I/O problem (reading or writing)
      StreamReadException - for problems with decoding of token stream
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • copyCurrentStructure

      public void copyCurrentStructure(JsonParser p) throws JacksonException
      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.

      Overrides:
      copyCurrentStructure in class JsonGenerator
      Parameters:
      p - Parser that points to the value to copy
      Throws:
      JacksonIOException - if there is an underlying I/O problem (reading or writing)
      StreamReadException - for problems with decoding of token stream
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • streamWriteContext

      public TokenStreamContext streamWriteContext()
      Description copied from class: JsonGenerator
      Accessor for context object that provides information about low-level logical position withing output token stream.

      NOTE: method was called getOutputContext() in Jackson 2.x

      Specified by:
      streamWriteContext in class JsonGenerator
      Returns:
      Stream output context (TokenStreamContext) associated with this generator

    • objectWriteContext

      public ObjectWriteContext objectWriteContext()
      Description copied from class: JsonGenerator
      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.
      Specified by:
      objectWriteContext in class JsonGenerator
      Returns:
      Object write context (ObjectWriteContext) associated with this generator

    • flush

      public void flush()
      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 interface Flushable
      Specified by:
      flush in class JsonGenerator

    • close

      public void close()
      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 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.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class JsonGenerator

    • 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
      Returns:
      True if this generator has been closed; false if not

    • delegate

      public JsonGenerator delegate()
      Returns:
      Underlying generator that calls are delegated to