Package com.fasterxml.jackson.core.filter

Class FilteringGeneratorDelegate

  • All Implemented Interfaces:
    Versioned, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    public class FilteringGeneratorDelegate
extends JsonGeneratorDelegate
    Specialized JsonGeneratorDelegate that allows use of TokenFilter for outputting a subset of content that caller tries to generate.
    Since:
    2.6

    • Constructor Detail

      • FilteringGeneratorDelegate

        public FilteringGeneratorDelegate​(JsonGenerator d,
                                  TokenFilter f,
                                  boolean includePath,
                                  boolean allowMultipleMatches)

    • Method Detail

      • getMatchCount

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

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

        Overrides:
        writeStartArray in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • writeStartArray

        public void writeStartArray​(java.lang.Object forValue)
                     throws java.io.IOException
        Overrides:
        writeStartArray in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • writeStartArray

        public void writeStartArray​(java.lang.Object forValue,
                            int size)
                     throws java.io.IOException
        Overrides:
        writeStartArray in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeEndArray in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeStartObject in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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 JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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 JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeEndObject in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeFieldName in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeFieldName in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • writeString

        public void writeString​(java.lang.String value)
                 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.
        Overrides:
        writeString in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeString in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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 the reader is null, then write a null. If len is < 0, then write all contents of the reader. Otherwise, write only len characters.
        Overrides:
        writeString in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeRawUTF8String in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeUTF8String in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeRaw in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeRaw in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • writeRaw

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

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

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

        Overrides:
        writeRaw in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeRaw in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

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

        Overrides:
        writeRaw in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeRawValue in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • writeRawValue

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

      • writeRawValue

        public void writeRawValue​(char[] text,
                          int offset,
                          int len)
                   throws java.io.IOException
        Overrides:
        writeRawValue in class JsonGeneratorDelegate
        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.

        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.
        Throws:
        java.io.IOException

      • 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.
        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:
        java.io.IOException

      • 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 JsonGeneratorDelegate
        Parameters:
        v - Number value to write
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeNumber in class JsonGeneratorDelegate
        Parameters:
        v - Number value to write
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeNumber in class JsonGeneratorDelegate
        Parameters:
        v - Number value to write
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeNumber in class JsonGeneratorDelegate
        Parameters:
        v - Number value to write
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeNumber in class JsonGeneratorDelegate
        Parameters:
        v - Number value to write
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeNumber in class JsonGeneratorDelegate
        Parameters:
        v - Number value to write
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeNumber in class JsonGeneratorDelegate
        Parameters:
        v - Number value to write
        Throws:
        java.io.IOException

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

        Overrides:
        writeNumber in class JsonGeneratorDelegate
        Throws:
        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)
        java.io.IOException

      • 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 JsonGeneratorDelegate
        Throws:
        java.io.IOException
        java.lang.UnsupportedOperationException

      • writeBoolean

        public void writeBoolean​(boolean v)
                  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.
        Overrides:
        writeBoolean in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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.
        Overrides:
        writeNull in class JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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 JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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 JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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 JsonGeneratorDelegate
        Throws:
        java.io.IOException

      • 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 JsonGeneratorDelegate
        Throws:
        java.io.IOException