Package com.fasterxml.jackson.databind.util

Class TokenBuffer

  • All Implemented Interfaces:
    Versioned, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    public class TokenBuffer
extends JsonGenerator
    Utility class used for efficient storage of JsonToken sequences, needed for temporary buffering. Space efficient for different sequence lengths (especially so for smaller ones; but not significantly less efficient for larger), highly efficient for linear iteration and appending. Implemented as segmented/chunked linked list of tokens; only modifications are via appends.

    • Constructor Detail

      • TokenBuffer

        public TokenBuffer​(ObjectCodec codec,
                   boolean hasNativeIds)
        Parameters:
        codec - Object codec to use for stream-based object conversion through parser/generator interfaces. If null, such methods cannot be used.
        hasNativeIds - Whether resulting JsonParser (if created) is considered to support native type and object ids

      • TokenBuffer

        public TokenBuffer​(JsonParser p)
        Since:
        2.3

    • Method Detail

      • overrideParentContext

        public TokenBuffer overrideParentContext​(JsonStreamContext ctxt)
        Method that allows explicitly specifying parent parse context to associate with contents of this buffer. Usually context is assigned at construction, based on given parser; but it is not always available, and may not contain intended context.
        Since:
        2.9

      • forceUseOfBigDecimal

        public TokenBuffer forceUseOfBigDecimal​(boolean b)
        Since:
        2.7

      • 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 this generator (derived from version declared for jackson-core jar that contains the class

      • asParser

        public JsonParser asParser()
        Method used to create a JsonParser that can read contents stored in this buffer. Will use default _objectCodec for object conversions.

        Note: instances are not synchronized, that is, they are not thread-safe if there are concurrent appends to the underlying buffer.

        Returns:
        Parser that can be used for reading contents stored in this buffer

      • asParserOnFirstToken

        public JsonParser asParserOnFirstToken()
                                throws java.io.IOException
        Same as: 
          JsonParser p = asParser();
  p.nextToken();
  return p;
        Throws:
        java.io.IOException
        Since:
        2.9

      • asParser

        public JsonParser asParser​(ObjectCodec codec)
        Method used to create a JsonParser that can read contents stored in this buffer.

        Note: instances are not synchronized, that is, they are not thread-safe if there are concurrent appends to the underlying buffer.

        Parameters:
        codec - Object codec to use for stream-based object conversion through parser/generator interfaces. If null, such methods cannot be used.
        Returns:
        Parser that can be used for reading contents stored in this buffer

      • asParser

        public JsonParser asParser​(JsonParser src)
        Parameters:
        src - Parser to use for accessing source information like location, configured codec

      • isEmpty

        public boolean isEmpty()
        Accessor for checking whether this buffer has one or more tokens or not.
        Returns:
        True if this buffer instance has no tokens
        Since:
        2.13

      • append

        public TokenBuffer append​(TokenBuffer other)
                   throws java.io.IOException
        Helper method that will append contents of given buffer into this buffer. Not particularly optimized; can be made faster if there is need.
        Returns:
        This buffer
        Throws:
        java.io.IOException

      • serialize

        public void serialize​(JsonGenerator gen)
               throws java.io.IOException
        Helper method that will write all contents of this buffer using given JsonGenerator.

        Note: this method would be enough to implement JsonSerializer for TokenBuffer type; but we cannot have upwards references (from core to mapper package); and as such we also cannot take second argument.

        Throws:
        java.io.IOException

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • overrideStdFeatures

        public JsonGenerator overrideStdFeatures​(int values,
                                         int mask)
        Description copied from class: JsonGenerator
        Bulk set method for (re)setting states of features specified by mask. Functionally equivalent to int oldState = getFeatureMask(); int newState = (oldState & ~mask) | (values & mask); setFeatureMask(newState); but preferred as this lets caller more efficiently specify actual changes made.
        Overrides:
        overrideStdFeatures in class JsonGenerator
        Parameters:
        values - Bit mask of set/clear state for features to change
        mask - Bit mask of features to change
        Returns:
        This generator, to allow call chaining

      • canWriteBinaryNatively

        public boolean canWriteBinaryNatively()
        Since we can efficiently store byte[], yes.
        Overrides:
        canWriteBinaryNatively in class JsonGenerator
        Returns:
        True if this generator is capable of writing "raw" Binary Content (this is typically determined by capabilities of the underlying format); false if not

      • flush

        public void flush()
           throws java.io.IOException
        Description copied from class: JsonGenerator
        Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
        Specified by:
        flush in interface java.io.Flushable
        Specified by:
        flush in class JsonGenerator
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • close

        public void close()
           throws java.io.IOException
        Description copied from class: JsonGenerator
        Method called to close this generator, so that no more content can be written.

        Whether the underlying target (stream, writer) gets closed depends on whether this generator either manages the target (i.e. is the only one with access to the target -- case if caller passes a reference to the resource such as File, but not stream); or has feature JsonGenerator.Feature.AUTO_CLOSE_TARGET enabled. If either of above is true, the target is also closed. Otherwise (not managing, feature not enabled), target is not closed.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class JsonGenerator
        Throws:
        java.io.IOException - if there is either an underlying I/O problem

      • 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 instance has been closed

      • writeStartArray

        public final void writeStartArray()
                           throws java.io.IOException
        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 field name is expected.

        Specified by:
        writeStartArray in class JsonGenerator
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeStartArray

        public void writeStartArray​(java.lang.Object forValue)
                     throws java.io.IOException
        Description copied from class: JsonGenerator
        Method for writing start marker of an Array value, similar to JsonGenerator.writeStartArray(), but also specifying the "current value" to assign to the new Array context being created.
        Overrides:
        writeStartArray in class JsonGenerator
        Parameters:
        forValue - "Current value" to assign for the Array context being created
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeStartArray

        public void writeStartArray​(java.lang.Object forValue,
                            int size)
                     throws java.io.IOException
        Description copied from class: JsonGenerator
        Method for writing start marker of an Array value, similar to JsonGenerator.writeStartArray(), but also specifying the "current value" to assign to the new Array context being created as well as how many elements will be written for the array before calling JsonGenerator.writeEndArray().
        Overrides:
        writeStartArray in class JsonGenerator
        Parameters:
        forValue - "Current value" to assign for the Array context being created
        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)
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeEndArray

        public final void writeEndArray()
                         throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeStartObject

        public final void writeStartObject()
                            throws java.io.IOException
        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 field name is expected.

        Specified by:
        writeStartObject in class JsonGenerator
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeStartObject

        public void writeStartObject​(java.lang.Object forValue)
                      throws java.io.IOException
        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 field name is expected.

        Overrides:
        writeStartObject in class JsonGenerator
        Parameters:
        forValue - "Current value" to assign for the Object context being created
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeStartObject

        public void writeStartObject​(java.lang.Object forValue,
                             int size)
                      throws java.io.IOException
        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 field name is expected.

        Overrides:
        writeStartObject in class JsonGenerator
        Parameters:
        forValue - "Current value" to assign for the Object context being 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)
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeEndObject

        public final void writeEndObject()
                          throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeFieldName

        public final void writeFieldName​(java.lang.String name)
                          throws java.io.IOException
        Description copied from class: JsonGenerator
        Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.

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

        Specified by:
        writeFieldName in class JsonGenerator
        Parameters:
        name - Field name to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeFieldName

        public void writeFieldName​(SerializableString name)
                    throws java.io.IOException
        Description copied from class: JsonGenerator
        Method similar to JsonGenerator.writeFieldName(String), main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.

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

        Specified by:
        writeFieldName in class JsonGenerator
        Parameters:
        name - Field name to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeString

        public void writeString​(java.lang.String text)
                 throws java.io.IOException
        Description copied from class: JsonGenerator
        Method for outputting a String value. Depending on context this means either array element, (object) field 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 - Text value to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeString

        public void writeString​(char[] text,
                        int offset,
                        int len)
                 throws java.io.IOException
        Description copied from class: JsonGenerator
        Method for outputting a String value. Depending on context this means either array element, (object) field 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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeString

        public void writeString​(SerializableString text)
                 throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeRawUTF8String

        public void writeRawUTF8String​(byte[] text,
                               int offset,
                               int length)
                        throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeUTF8String

        public void writeUTF8String​(byte[] text,
                            int offset,
                            int length)
                     throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeRaw

        public void writeRaw​(java.lang.String text)
              throws java.io.IOException
        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.
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeRaw

        public void writeRaw​(java.lang.String text,
                     int offset,
                     int len)
              throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeRaw

        public void writeRaw​(SerializableString text)
              throws java.io.IOException
        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:
        text - Pre-encoded textual contents to included in output
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeRaw

        public void writeRaw​(char[] text,
                     int offset,
                     int len)
              throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeRaw

        public void writeRaw​(char c)
              throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeRawValue

        public void writeRawValue​(java.lang.String text)
                   throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeRawValue

        public void writeRawValue​(java.lang.String text,
                          int offset,
                          int len)
                   throws java.io.IOException
        Specified by:
        writeRawValue in class JsonGenerator
        Throws:
        java.io.IOException

      • writeRawValue

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

      • writeNumber

        public void writeNumber​(short i)
                 throws java.io.IOException
        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 field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
        Overrides:
        writeNumber in class JsonGenerator
        Parameters:
        i - Number value to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeNumber

        public void writeNumber​(int i)
                 throws java.io.IOException
        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 field 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:
        i - Number value to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeNumber

        public void writeNumber​(long l)
                 throws java.io.IOException
        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 field 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:
        l - Number value to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeNumber

        public void writeNumber​(double d)
                 throws java.io.IOException
        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 field 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:
        d - Number value to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeNumber

        public void writeNumber​(float f)
                 throws java.io.IOException
        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 field 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:
        f - Number value to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeNumber

        public void writeNumber​(java.math.BigDecimal dec)
                 throws java.io.IOException
        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 field 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:
        dec - Number value to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeNumber

        public void writeNumber​(java.math.BigInteger v)
                 throws java.io.IOException
        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 field 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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeNumber

        public void writeNumber​(java.lang.String encodedValue)
                 throws java.io.IOException
        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 can not 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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeBoolean

        public void writeBoolean​(boolean state)
                  throws java.io.IOException
        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 field 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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeNull

        public void writeNull()
               throws java.io.IOException
        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 field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
        Specified by:
        writeNull in class JsonGenerator
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeObject

        public void writeObject​(java.lang.Object value)
                 throws java.io.IOException
        Description copied from class: JsonGenerator
        Older alias for JsonGenerator.writePOJO(Object)
        Specified by:
        writeObject in class JsonGenerator
        Parameters:
        value - Java value (usually POJO) to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeTree

        public void writeTree​(TreeNode node)
               throws java.io.IOException
        Description copied from class: JsonGenerator
        Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator. This will generally just call JsonGenerator.writeObject(java.lang.Object) with given node, but is added for convenience and to make code more explicit in cases where it deals specifically with trees.
        Specified by:
        writeTree in class JsonGenerator
        Parameters:
        node - TreeNode to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeBinary

        public void writeBinary​(Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws java.io.IOException
        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 can not 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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeBinary

        public int writeBinary​(Base64Variant b64variant,
                       java.io.InputStream data,
                       int dataLength)
        Although we could support this method, it does not necessarily make sense: we cannot make good use of streaming because buffer must hold all the data. Because of this, currently this will simply throw UnsupportedOperationException
        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

      • 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 can not 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 can not 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

      • writeTypeId

        public void writeTypeId​(java.lang.Object id)
        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 JsonGenerationException will be thrown.
        Overrides:
        writeTypeId in class JsonGenerator
        Parameters:
        id - Native Type Id to write

      • writeObjectId

        public void writeObjectId​(java.lang.Object id)
        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. If output is not allowed by the data format in this position, a JsonGenerationException will be thrown.
        Overrides:
        writeObjectId in class JsonGenerator
        Parameters:
        id - Native Object Id to write

      • writeEmbeddedObject

        public void writeEmbeddedObject​(java.lang.Object object)
                         throws java.io.IOException
        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.writeObject(java.lang.Object) instead.

        Overrides:
        writeEmbeddedObject in class JsonGenerator
        Parameters:
        object - Native format-specific value to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • copyCurrentEvent

        public void copyCurrentEvent​(JsonParser p)
                      throws java.io.IOException
        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 event (token) to copy
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • copyCurrentStructure

        public void copyCurrentStructure​(JsonParser p)
                          throws java.io.IOException
        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:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer