Module tools.jackson.core
Package tools.jackson.core.filter

Class FilteringGeneratorDelegate

java.lang.Object
tools.jackson.core.JsonGenerator
tools.jackson.core.util.JsonGeneratorDelegate
tools.jackson.core.filter.FilteringGeneratorDelegate
All Implemented Interfaces:
Closeable, Flushable, AutoCloseable, Versioned
public class FilteringGeneratorDelegate extends JsonGeneratorDelegate
Specialized JsonGeneratorDelegate that allows use of TokenFilter for outputting a subset of content that caller tries to generate.

  • Field Details

    • rootFilter

      protected TokenFilter rootFilter
      Object consulted to determine whether to write parts of content generator is asked to write or not.

    • _allowMultipleMatches

      protected boolean _allowMultipleMatches
      Flag that determines whether filtering will continue after the first match is indicated or not: if `false`, output is based on just the first full match (returning TokenFilter.INCLUDE_ALL) and no more checks are made; if `true` then filtering will be applied as necessary until end of content.

    • _inclusion

      protected TokenFilter.Inclusion _inclusion
      Flag that determines whether path leading up to included content should also be automatically included or not. If `false`, no path inclusion is done and only explicitly included entries are output; if `true` then path from main level down to match is also included as necessary.

    • _filterContext

      protected TokenFilterContext _filterContext
      Although delegate has its own output context it is not sufficient since we actually have to keep track of excluded (filtered out) structures as well as ones delegate actually outputs.

    • _itemFilter

      protected TokenFilter _itemFilter
      State that applies to the item within container, used where applicable. Specifically used to pass inclusion state between property name and property, and also used for array elements.

    • _matchCount

      protected int _matchCount
      Number of tokens for which TokenFilter.INCLUDE_ALL has been returned

  • Constructor Details

    • FilteringGeneratorDelegate

      public FilteringGeneratorDelegate(JsonGenerator d, TokenFilter f, TokenFilter.Inclusion inclusion, boolean allowMultipleMatches)
      Parameters:
      d - Generator to delegate calls to
      f - Filter to use
      inclusion - Definition of inclusion criteria
      allowMultipleMatches - Whether to allow multiple matches

  • Method Details

    • getFilter

      public TokenFilter getFilter()

    • getFilterContext

      public TokenStreamContext getFilterContext()

    • getMatchCount

      public int getMatchCount()
      Accessor for finding number of matches, where specific token and sub-tree starting (if structured type) are passed.
      Returns:
      Number of matches

    • streamWriteContext

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

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

      Overrides:
      streamWriteContext in class JsonGeneratorDelegate
      Returns:
      Stream output context (TokenStreamContext) associated with this generator

    • writeStartArray

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

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

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

    • writeStartArray

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

    • writeStartArray

      public JsonGenerator writeStartArray(Object currValue, int size) throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing start marker of an Array value, similar to JsonGenerator.writeStartArray(), but also specifying what is the Java object that the Array Object being written represents (if any) and how many elements will be written for the array before calling JsonGenerator.writeEndArray().
      Overrides:
      writeStartArray in class JsonGeneratorDelegate
      Parameters:
      currValue - Java Object that Array being written represents, if any (or null if not known or not applicable)
      size - Number of elements this Array will have: actual number of values written (before matching call to JsonGenerator.writeEndArray() MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length)
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeEndArray

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

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

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

    • writeStartObject

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

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

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

    • writeStartObject

      public JsonGenerator writeStartObject(Object currValue) throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing starting marker of an Object value to represent the given Java Object value. Argument is offered as metadata, but more importantly it should be assigned as the "current value" for the Object content that gets constructed and initialized.

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

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

    • writeStartObject

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

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

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

    • writeEndObject

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

      Marker can be written if the innermost structured type is Object, and the last written event was either a complete value, or START-OBJECT marker (see JSON specification for more details).

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

    • writeName

      public JsonGenerator writeName(String name) throws JacksonException
      Description copied from class: JsonGenerator
      Method for writing an Object Property name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.

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

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

    • writeName

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

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

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

    • writePropertyId

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

    • writeString

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

    • writeString

      public JsonGenerator writeString(char[] text, int offset, int len) throws JacksonException
      Description copied from class: JsonGenerator
      Method for outputting a String value. Depending on context this means either array element, (object) property value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.
      Overrides:
      writeString in class JsonGeneratorDelegate
      Parameters:
      text - Buffer that contains String value to write
      offset - Offset in buffer of the first character of String value to write
      len - Length of the String value (in characters) to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeString

      public JsonGenerator writeString(SerializableString value) throws JacksonException
      Description copied from class: JsonGenerator
      Method similar to JsonGenerator.writeString(String), but that takes SerializableString which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.

      Default implementation just calls JsonGenerator.writeString(String); sub-classes should override it with more efficient implementation if possible.

      Overrides:
      writeString in class JsonGeneratorDelegate
      Parameters:
      value - Pre-encoded String value to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeString

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

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

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

    • writeRawUTF8String

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

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

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

    • writeUTF8String

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

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

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

    • writeRaw

      public JsonGenerator writeRaw(String text) throws JacksonException
      Description copied from class: JsonGenerator
      Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

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

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

    • writeRaw

      public JsonGenerator writeRaw(String text, int offset, int len) throws JacksonException
      Description copied from class: JsonGenerator
      Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

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

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

    • writeRaw

      public JsonGenerator writeRaw(SerializableString text) throws JacksonException
      Description copied from class: JsonGenerator
      Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

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

      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 JsonGeneratorDelegate
      Parameters:
      text - Pre-encoded textual contents to included in output
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRaw

      public JsonGenerator writeRaw(char[] text, int offset, int len) throws JacksonException
      Description copied from class: JsonGenerator
      Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

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

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

    • writeRaw

      public JsonGenerator writeRaw(char c) throws JacksonException
      Description copied from class: JsonGenerator
      Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.

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

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

    • writeRawValue

      public JsonGenerator writeRawValue(String text) throws JacksonException
      Description copied from class: JsonGenerator
      Method that will force generator to copy input text verbatim without any modifications, but assuming it must constitute a single legal JSON value (number, string, boolean, null, Array or List). Assuming this, proper separators are added if and as needed (comma or colon), and generator state updated to reflect this.
      Overrides:
      writeRawValue in class JsonGeneratorDelegate
      Parameters:
      text - Textual contents to included in output
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeRawValue

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

    • writeRawValue

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

    • writeBinary

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

      Note: because JSON Strings cannot contain unescaped linefeeds, if linefeeds are included (as per last argument), they must be escaped. This adds overhead for decoding without improving readability. Alternatively if linefeeds are not included, resulting String value may violate the requirement of base64 RFC which mandates line-length of 76 characters and use of linefeeds. However, all JsonParser implementations are required to accept such "long line base64"; as do typical production-level base64 decoders.

      Overrides:
      writeBinary in class JsonGeneratorDelegate
      Parameters:
      b64variant - Base64 variant to use: defines details such as whether padding is used (and if so, using which character); what is the maximum line length before adding linefeed, and also the underlying alphabet to use.
      data - Buffer that contains binary data to write
      offset - Offset in data of the first byte of data to write
      len - Length of data to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeBinary

      public int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws JacksonException
      Description copied from class: JsonGenerator
      Method similar to JsonGenerator.writeBinary(Base64Variant,byte[],int,int), but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.
      Overrides:
      writeBinary in class JsonGeneratorDelegate
      Parameters:
      b64variant - Base64 variant to use
      data - InputStream to use for reading binary data to write. Will not be closed after successful write operation
      dataLength - (optional) number of bytes that will be available; or -1 to be indicate it is not known. If a positive length is given, data MUST provide at least that many bytes: if not, an exception will be thrown. Note that implementations need not support cases where length is not known in advance; this depends on underlying data format: JSON output does NOT require length, other formats may.
      Returns:
      Number of bytes read from data and written as binary payload
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeNumber

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

    • writeNumber

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

    • writeNumber

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

    • writeNumber

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

    • writeNumber

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

    • writeNumber

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

    • writeNumber

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

    • writeNumber

      public JsonGenerator writeNumber(String encodedValue) throws JacksonException, 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 cannot be used; nor JsonGenerator.writeRaw(java.lang.String) because that does not properly handle value separators needed in Array or Object contexts.

      Note: because of lack of type safety, some generator implementations may not be able to implement this method. For example, if a binary JSON format is used, it may require type information for encoding; similarly for generator-wrappers around Java objects or JSON nodes. If implementation does not implement this method, it needs to throw UnsupportedOperationException.

      Overrides:
      writeNumber in class JsonGeneratorDelegate
      Parameters:
      encodedValue - Textual (possibly format) number representation to write
      Returns:
      This generator, to allow call chaining
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      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)
      JacksonException

    • writeNumber

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

    • writeBoolean

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

    • writeNull

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

    • writeOmittedProperty

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

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

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

    • writeObjectId

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

    • writeObjectRef

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

    • writeTypeId

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

    • _checkParentPath

      protected void _checkParentPath() throws JacksonException
      Throws:
      JacksonException

    • _checkParentPath

      protected void _checkParentPath(boolean isMatch) throws JacksonException
      Throws:
      JacksonException

    • _checkPropertyParentPath

      protected void _checkPropertyParentPath() throws JacksonException
      Specialized variant of _checkParentPath() used when checking parent for a property name to be included with value: rules are slightly different.
      Throws:
      JacksonException - If there is an issue with possible resulting read

    • _checkBinaryWrite

      protected boolean _checkBinaryWrite() throws JacksonException
      Throws:
      JacksonException

    • _checkRawValueWrite

      protected boolean _checkRawValueWrite() throws JacksonException
      Throws:
      JacksonException