Package com.fasterxml.jackson.core.util

Class JsonGeneratorDelegate

    • Constructor Detail

      • 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 Detail

      • setSchema

        public void setSchema​(FormatSchema schema)
        Description copied from class: JsonGenerator
        Method to call to make this generator use specified schema. Method must be called before generating any content, right after instance has been created. Note that not all generators support schemas; and those that do usually only accept specific types of schemas: ones defined for data format this generator produces.

        If generator does not support specified schema, UnsupportedOperationException is thrown.

        Overrides:
        setSchema in class JsonGenerator
        Parameters:
        schema - Schema to use

      • getSchema

        public FormatSchema getSchema()
        Description copied from class: JsonGenerator
        Method for accessing Schema that this generator uses, if any; null if none. Default implementation returns null.
        Overrides:
        getSchema in class JsonGenerator
        Returns:
        Schema in use by this generator, 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 this generator (derived from version declared for jackson-core jar that contains the class

      • getOutputTarget

        public java.lang.Object getOutputTarget()
        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.

        Overrides:
        getOutputTarget in class JsonGenerator
        Returns:
        Output target this generator was configured with

      • getOutputBuffered

        public int getOutputBuffered()
        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: non-JSON implementations will be retrofitted for 2.6 and beyond; please report if you see -1 (missing override)

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

      • assignCurrentValue

        public void assignCurrentValue​(java.lang.Object v)
        Description copied from class: JsonGenerator
        Helper method, usually equivalent to: getOutputContext().setCurrentValue(v);
        Overrides:
        assignCurrentValue in class JsonGenerator
        Parameters:
        v - Current value to assign for the current context of this generator

      • currentValue

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

        Note that "current value" is NOT populated (or used) by Streaming parser or generators; 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.

        Overrides:
        currentValue in class JsonGenerator
        Returns:
        "Current value" associated with the current context (state) of this generator

      • getCurrentValue

        public java.lang.Object getCurrentValue()
        Description copied from class: JsonGenerator
        Alias for JsonGenerator.currentValue(), to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).
        Overrides:
        getCurrentValue in class JsonGenerator
        Returns:
        Location of the last processed input unit (byte or character)

      • 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

      • canWriteBinaryNatively

        public boolean canWriteBinaryNatively()
        Description copied from class: JsonGenerator
        Introspection method that may be called to see if the underlying data format supports "native" binary data; that is, an efficient output of binary content without encoding.

        Default implementation returns false; overridden by data formats that do support native binary content.

        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

      • canOmitFields

        public boolean canOmitFields()
        Description copied from class: JsonGenerator
        Introspection method to call to check whether it is ok to omit writing of Object fields or not. Most formats do allow omission, but certain positional formats (such as CSV) require output of placeholders, even if no real values are to be emitted.
        Overrides:
        canOmitFields in class JsonGenerator
        Returns:
        True if this generator is allowed to only write values of some Object fields and omit the rest; false if not

      • canWriteFormattedNumbers

        public boolean canWriteFormattedNumbers()
        Description copied from class: JsonGenerator
        Introspection method to call to check whether it is possible to write numbers using JsonGenerator.writeNumber(java.lang.String) using possible custom format, or not. Typically textual formats allow this (and JSON specifically does), whereas binary formats do not allow this (except by writing them as Strings). Usual reason for calling this method is to check whether custom formatting of numbers may be applied by higher-level code (databinding) or not.
        Overrides:
        canWriteFormattedNumbers in class JsonGenerator
        Returns:
        True if this generator is capable of writing "formatted" numbers (and if so, need to be passed using JsonGenerator.writeNumber(String), that is, passed as String); false if not

      • 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

      • overrideFormatFeatures

        public JsonGenerator overrideFormatFeatures​(int values,
                                            int mask)
        Description copied from class: JsonGenerator
        Bulk set method for (re)setting states of FormatFeatures, by specifying values (set / clear) along with a mask, to determine which features to change, if any.

        Default implementation will simply throw an exception to indicate that the generator implementation does not support any FormatFeatures.

        Overrides:
        overrideFormatFeatures 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

      • setPrettyPrinter

        public JsonGenerator setPrettyPrinter​(PrettyPrinter pp)
        Description copied from class: JsonGenerator
        Method for setting a custom pretty printer, which is usually used to add indentation for improved human readability. By default, generator does not do pretty printing.

        To use the default pretty printer that comes with core Jackson distribution, call JsonGenerator.useDefaultPrettyPrinter() instead.

        Overrides:
        setPrettyPrinter in class JsonGenerator
        Parameters:
        pp - PrettyPrinter to assign, if any; null if none
        Returns:
        This generator, to allow call chaining

      • setHighestNonEscapedChar

        public JsonGenerator setHighestNonEscapedChar​(int charCode)
        Description copied from class: JsonGenerator
        Method that can be called to request that generator escapes all character codes above specified code point (if positive value); or, to not escape any characters except for ones that must be escaped for the data format (if -1). To force escaping of all non-ASCII characters, for example, this method would be called with value of 127.

        Note that generators are NOT required to support setting of value higher than 127, because there are other ways to affect quoting (or lack thereof) of character codes between 0 and 127. Not all generators support concept of escaping, either; if so, calling this method will have no effect.

        Default implementation does nothing; sub-classes need to redefine it according to rules of supported data format.

        Overrides:
        setHighestNonEscapedChar in class JsonGenerator
        Parameters:
        charCode - Either -1 to indicate that no additional escaping is to be done; or highest code point not to escape (meaning higher ones will be), if positive value.
        Returns:
        This generator, to allow call chaining

      • getHighestEscapedChar

        public int getHighestEscapedChar()
        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:
        getHighestEscapedChar in class JsonGenerator
        Returns:
        Currently active limitation for highest non-escaped character, if defined; or 0 to indicate no additional escaping is performed.

      • setRootValueSeparator

        public JsonGenerator setRootValueSeparator​(SerializableString sep)
        Description copied from class: JsonGenerator
        Method that allows overriding String used for separating root-level JSON values (default is single space character)

        Default implementation throws UnsupportedOperationException.

        Overrides:
        setRootValueSeparator in class JsonGenerator
        Parameters:
        sep - Separator to use, if any; null means that no separator is automatically added
        Returns:
        This generator, to allow call chaining

      • writeStartArray

        public 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​(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 how many elements will be written for the array before calling JsonGenerator.writeEndArray().

        Default implementation simply calls JsonGenerator.writeStartArray().

        Overrides:
        writeStartArray in class JsonGenerator
        Parameters:
        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

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

      • writeFieldId

        public void writeFieldId​(long id)
                  throws java.io.IOException
        Description copied from class: JsonGenerator
        Alternative to JsonGenerator.writeFieldName(String) that may be used in cases where property key is of numeric type; either where underlying format supports such notion (some binary formats do, unlike JSON), or for convenient conversion into String presentation. Default implementation will simply convert id into String and call JsonGenerator.writeFieldName(String).
        Overrides:
        writeFieldId in class JsonGenerator
        Parameters:
        id - Field id to write
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeArray

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

      • writeArray

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

      • writeArray

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

      • writeArray

        public void writeArray​(java.lang.String[] array,
                       int offset,
                       int length)
                throws java.io.IOException
        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`
        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​(java.io.Reader reader,
                        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. 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 can not be less than it: if not enough content available, a JsonGenerationException will be thrown.

        Overrides:
        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"
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer; or if length (len) is specified but reader does not provide enough content

      • 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 raw)
              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:
        raw - 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

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

      • writeNumber

        public void writeNumber​(short 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.
        Overrides:
        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​(int 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​(long 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.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​(double v)
                 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:
        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​(float v)
                 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:
        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.math.BigDecimal v)
                 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:
        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,
                        java.lang.UnsupportedOperationException
        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
        java.lang.UnsupportedOperationException - If underlying data format does not support numbers serialized textually AND if generator is not allowed to just output a String instead (Schema-based formats may require actual number, for example)

      • writeNumber

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

      • 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

      • writeOmittedField

        public void writeOmittedField​(java.lang.String fieldName)
                       throws java.io.IOException
        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.canOmitFields().

        Default implementation does nothing.

        Overrides:
        writeOmittedField in class JsonGenerator
        Parameters:
        fieldName - Name of the field omitted
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer

      • writeObjectId

        public void writeObjectId​(java.lang.Object id)
                   throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer
        JsonGenerationException - if Object ID output is not allowed (either at all, or specifically in this position in output)

      • writeObjectRef

        public void writeObjectRef​(java.lang.Object id)
                    throws java.io.IOException
        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 JsonGenerationException will be thrown.
        Overrides:
        writeObjectRef in class JsonGenerator
        Parameters:
        id - Referenced value, for which Object Id is expected to be written
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer
        JsonGenerationException - if Object ID output is not allowed (either at all, or specifically in this position in output)

      • writeTypeId

        public void writeTypeId​(java.lang.Object id)
                 throws java.io.IOException
        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
        Throws:
        java.io.IOException - if there is either an underlying I/O problem or encoding issue at format layer
        JsonGenerationException - if Type ID output is not allowed (either at all, or specifically in this position in output)

      • 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

      • writePOJO

        public void writePOJO​(java.lang.Object pojo)
               throws java.io.IOException
        Description copied from class: JsonGenerator
        Method for writing given Java object (POJO) as JSON. Exactly how the object gets written depends on object in question (and on codec, its configuration); for typical POJOs it will result in JSON Object, but for others JSON Array, or String or numeric value (and for nulls, JSON null literal). NOTE: generator must have its ObjectCodec set to non-null value; for generators created by a mapping factory this is the case, for others not.
        Overrides:
        writePOJO in class JsonGenerator
        Parameters:
        pojo - 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

      • writeObject

        public void writeObject​(java.lang.Object pojo)
                 throws java.io.IOException
        Description copied from class: JsonGenerator
        Older alias for JsonGenerator.writePOJO(Object)
        Specified by:
        writeObject in class JsonGenerator
        Parameters:
        pojo - 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 tree)
               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:
        tree - TreeNode 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

      • 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

      • getDelegate

        @Deprecated
public JsonGenerator getDelegate()
        Deprecated.

      • delegate

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