Class FilteringGeneratorDelegate
- All Implemented Interfaces:
Versioned
,Closeable
,Flushable
,AutoCloseable
JsonGeneratorDelegate
that allows use of
TokenFilter
for outputting a subset of content that
caller tries to generate.- Since:
- 2.6
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator
JsonGenerator.Feature
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
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 (returningTokenFilter.INCLUDE_ALL
) and no more checks are made; if `true` then filtering will be applied as necessary until end of content.protected TokenFilterContext
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.protected TokenFilter.Inclusion
Flag that determines whether path leading up to included content should also be automatically included or not.protected TokenFilter
State that applies to the item within container, used where applicable.protected int
Number of tokens for whichTokenFilter.INCLUDE_ALL
has been returnedprotected TokenFilter
Object consulted to determine whether to write parts of content generator is asked to write or not.Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.util.JsonGeneratorDelegate
delegate, delegateCopyMethods
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator
_cfgPrettyPrinter, DEFAULT_BINARY_WRITE_CAPABILITIES, DEFAULT_TEXTUAL_WRITE_CAPABILITIES, DEFAULT_WRITE_CAPABILITIES
-
Constructor Summary
ConstructorDescriptionFilteringGeneratorDelegate
(JsonGenerator d, TokenFilter f, boolean includePath, boolean allowMultipleMatches) Deprecated.FilteringGeneratorDelegate
(JsonGenerator d, TokenFilter f, TokenFilter.Inclusion inclusion, boolean allowMultipleMatches) -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
protected void
protected void
_checkParentPath
(boolean isMatch) protected void
Specialized variant of_checkParentPath()
used when checking parent for a property name to be included with value: rules are slightly different.protected boolean
int
Accessor for finding number of matches, where specific token and sub-tree starting (if structured type) are passed.Accessor for context object that provides information about low-level logical position withing output token stream.void
writeBinary
(Base64Variant b64variant, byte[] data, int offset, int len) Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes).int
writeBinary
(Base64Variant b64variant, InputStream data, int dataLength) Method similar toJsonGenerator.writeBinary(Base64Variant,byte[],int,int)
, but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.void
writeBoolean
(boolean v) Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').void
Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).void
Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).void
writeFieldId
(long id) Alternative toJsonGenerator.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.void
Method similar toJsonGenerator.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.void
writeFieldName
(String name) 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.void
Method for outputting literal JSON null value.void
writeNumber
(char[] encodedValueBuffer, int offset, int length) Overloaded version ofJsonGenerator.writeNumber(String)
with same semantics but possibly more efficient operation.void
writeNumber
(double v) Method for outputting indicate JSON numeric value.void
writeNumber
(float v) Method for outputting indicate JSON numeric value.void
writeNumber
(int v) Method for outputting given value as JSON number.void
writeNumber
(long v) Method for outputting given value as JSON number.void
writeNumber
(short v) Method for outputting given value as JSON number.void
writeNumber
(String encodedValue) Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types.void
Method for outputting indicate JSON numeric value.void
Method for outputting given value as JSON number.void
writeObjectId
(Object id) Method that can be called to output so-called native Object Id.void
writeObjectRef
(Object id) Method that can be called to output references to native Object Ids.void
writeOmittedField
(String fieldName) Method called to indicate that a property in this position was skipped.void
writeRaw
(char c) 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).void
writeRaw
(char[] text, int offset, int len) 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).void
writeRaw
(SerializableString text) 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).void
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).void
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).void
writeRawUTF8String
(byte[] text, int offset, int length) Method similar toJsonGenerator.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).void
writeRawValue
(char[] text, int offset, int len) void
writeRawValue
(String text) 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).void
writeRawValue
(String text, int offset, int len) void
Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).void
writeStartArray
(int size) Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray()
, but also specifying how many elements will be written for the array before callingJsonGenerator.writeEndArray()
.void
writeStartArray
(Object forValue) Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray()
, but also specifying the "current value" to assign to the new Array context being created.void
writeStartArray
(Object forValue, int size) Method for writing start marker of an Array value, similar toJsonGenerator.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 callingJsonGenerator.writeEndArray()
.void
Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).void
writeStartObject
(Object forValue) Method for writing starting marker of an Object value to represent the given Java Object value.void
writeStartObject
(Object forValue, int size) Method for writing starting marker of an Object value to represent the given Java Object value.void
writeString
(char[] text, int offset, int len) Method for outputting a String value.void
writeString
(SerializableString value) Method similar toJsonGenerator.writeString(String)
, but that takesSerializableString
which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.void
writeString
(Reader reader, int len) Method for outputting a String value.void
writeString
(String value) Method for outputting a String value.void
writeTypeId
(Object id) Method that can be called to output so-called native Type Id.void
writeUTF8String
(byte[] text, int offset, int length) Method similar toJsonGenerator.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).Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.util.JsonGeneratorDelegate
assignCurrentValue, canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteFormattedNumbers, canWriteObjectId, canWriteTypeId, close, copyCurrentEvent, copyCurrentStructure, currentValue, delegate, disable, enable, flush, getCharacterEscapes, getCodec, getCurrentValue, getDelegate, getFeatureMask, getHighestEscapedChar, getOutputBuffered, getOutputTarget, getPrettyPrinter, getSchema, getWriteCapabilities, isClosed, isEnabled, overrideFormatFeatures, overrideStdFeatures, setCharacterEscapes, setCodec, setCurrentValue, setFeatureMask, setHighestNonEscapedChar, setPrettyPrinter, setRootValueSeparator, setSchema, useDefaultPrettyPrinter, version, writeArray, writeArray, writeArray, writeArray, writeEmbeddedObject, writeObject, writePOJO, writeTree
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator
_copyCurrentContents, _reportError, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, configure, getFormatFeatures, isEnabled, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writePOJOField, writeRawValue, writeStringField, writeTypePrefix, writeTypeSuffix
-
Field Details
-
rootFilter
Object consulted to determine whether to write parts of content generator is asked to write or not. -
_allowMultipleMatches
protected boolean _allowMultipleMatchesFlag 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 (returningTokenFilter.INCLUDE_ALL
) and no more checks are made; if `true` then filtering will be applied as necessary until end of content. -
_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
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
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 _matchCountNumber of tokens for whichTokenFilter.INCLUDE_ALL
has been returned
-
-
Constructor Details
-
FilteringGeneratorDelegate
@Deprecated public FilteringGeneratorDelegate(JsonGenerator d, TokenFilter f, boolean includePath, boolean allowMultipleMatches) Deprecated.since 2.12 Use the constructor that takesTokenFilter.Inclusion
argument instead.- Parameters:
d
- Generator to delegate calls tof
- Filter to useincludePath
- Whether to include path or notallowMultipleMatches
- Whether to allow multiple matches
-
FilteringGeneratorDelegate
public FilteringGeneratorDelegate(JsonGenerator d, TokenFilter f, TokenFilter.Inclusion inclusion, boolean allowMultipleMatches) - Parameters:
d
- Generator to delegate calls tof
- Filter to useinclusion
- Definition of inclusion criteriaallowMultipleMatches
- Whether to allow multiple matches- Since:
- 2.12
-
-
Method Details
-
getFilter
-
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
-
getOutputContext
Description copied from class:JsonGenerator
Accessor for context object that provides information about low-level logical position withing output token stream.- Overrides:
getOutputContext
in classJsonGeneratorDelegate
- Returns:
- Stream output context (
JsonStreamContext
) associated with this generator
-
writeStartArray
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 classJsonGeneratorDelegate
- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartArray
Description copied from class:JsonGenerator
Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray()
, but also specifying how many elements will be written for the array before callingJsonGenerator.writeEndArray()
.Default implementation simply calls
JsonGenerator.writeStartArray()
.- Overrides:
writeStartArray
in classJsonGeneratorDelegate
- Parameters:
size
- Number of elements this array will have: actual number of values written (before matching call toJsonGenerator.writeEndArray()
MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length)- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartArray
Description copied from class:JsonGenerator
Method for writing start marker of an Array value, similar toJsonGenerator.writeStartArray()
, but also specifying the "current value" to assign to the new Array context being created.- Overrides:
writeStartArray
in classJsonGeneratorDelegate
- Parameters:
forValue
- "Current value" to assign for the Array context being created- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartArray
Description copied from class:JsonGenerator
Method for writing start marker of an Array value, similar toJsonGenerator.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 callingJsonGenerator.writeEndArray()
.- Overrides:
writeStartArray
in classJsonGeneratorDelegate
- Parameters:
forValue
- "Current value" to assign for the Array context being createdsize
- Number of elements this Array will have: actual number of values written (before matching call toJsonGenerator.writeEndArray()
MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length)- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeEndArray
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 classJsonGeneratorDelegate
- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartObject
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 classJsonGeneratorDelegate
- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartObject
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 classJsonGeneratorDelegate
- Parameters:
forValue
- "Current value" to assign for the Object context being created- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartObject
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 classJsonGeneratorDelegate
- Parameters:
forValue
- "Current value" to assign for the Object context being createdsize
- Number of key/value pairs this Object will have: actual number of entries written (before matching call toJsonGenerator.writeEndObject()
MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length)- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeEndObject
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 classJsonGeneratorDelegate
- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeFieldName
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 classJsonGeneratorDelegate
- Parameters:
name
- Field name to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeFieldName
Description copied from class:JsonGenerator
Method similar toJsonGenerator.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 classJsonGeneratorDelegate
- Parameters:
name
- Field name to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeFieldId
Description copied from class:JsonGenerator
Alternative toJsonGenerator.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 intoString
and callJsonGenerator.writeFieldName(String)
.- Overrides:
writeFieldId
in classJsonGeneratorDelegate
- Parameters:
id
- Field id to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
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 classJsonGeneratorDelegate
- Parameters:
value
- Text value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
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 classJsonGeneratorDelegate
- Parameters:
text
- Buffer that contains String value to writeoffset
- Offset inbuffer
of the first character of String value to writelen
- Length of the String value (in characters) to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
Description copied from class:JsonGenerator
Method similar toJsonGenerator.writeString(String)
, but that takesSerializableString
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 classJsonGeneratorDelegate
- Parameters:
value
- Pre-encoded String value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeString
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. Iflen
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, aJsonGenerationException
will be thrown.- Overrides:
writeString
in classJsonGeneratorDelegate
- Parameters:
reader
- Reader to use for reading Text value to writelen
- Maximum Length of Text value to read (inchar
s, non-negative) if known;-1
to indicate "read and write it all"- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer; or if length (len
) is specified butreader
does not provide enough content
-
writeRawUTF8String
Description copied from class:JsonGenerator
Method similar toJsonGenerator.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 aUnsupportedOperationException
due to ineffectiveness of having to decode input.- Overrides:
writeRawUTF8String
in classJsonGeneratorDelegate
- Parameters:
text
- Buffer that contains String value to writeoffset
- Offset inbuffer
of the first byte of String value to writelength
- Length of the String value (in characters) to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeUTF8String
Description copied from class:JsonGenerator
Method similar toJsonGenerator.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 aUnsupportedOperationException
due to ineffectiveness of having to decode input.- Overrides:
writeUTF8String
in classJsonGeneratorDelegate
- Parameters:
text
- Buffer that contains String value to writeoffset
- Offset inbuffer
of the first byte of String value to writelength
- Length of the String value (in characters) to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
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, useJsonGenerator.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 classJsonGeneratorDelegate
- Parameters:
text
- Textual contents to include as-is in output.- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
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, useJsonGenerator.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 classJsonGeneratorDelegate
- Parameters:
text
- String that has contents to include as-is in outputoffset
- Offset withintext
of the first character to outputlen
- Length of content (fromtext
, starting at offsetoffset
) to output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
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, useJsonGenerator.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 classJsonGeneratorDelegate
- Parameters:
text
- Pre-encoded textual contents to included in output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
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, useJsonGenerator.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 classJsonGeneratorDelegate
- Parameters:
text
- Buffer that has contents to include as-is in outputoffset
- Offset withintext
of the first character to outputlen
- Length of content (fromtext
, starting at offsetoffset
) to output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRaw
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, useJsonGenerator.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 classJsonGeneratorDelegate
- Parameters:
c
- Character to included in output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawValue
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 classJsonGeneratorDelegate
- Parameters:
text
- Textual contents to included in output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeRawValue
- Overrides:
writeRawValue
in classJsonGeneratorDelegate
- Throws:
IOException
-
writeRawValue
- Overrides:
writeRawValue
in classJsonGeneratorDelegate
- Throws:
IOException
-
writeBinary
public void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws 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 defaultsNote: 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 classJsonGeneratorDelegate
- 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 writeoffset
- Offset indata
of the first byte of data to writelen
- Length of data to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeBinary
public int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws IOException Description copied from class:JsonGenerator
Method similar toJsonGenerator.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 classJsonGeneratorDelegate
- Parameters:
b64variant
- Base64 variant to usedata
- InputStream to use for reading binary data to write. Will not be closed after successful write operationdataLength
- (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:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
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 classJsonGeneratorDelegate
- Parameters:
v
- Number value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
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 classJsonGeneratorDelegate
- Parameters:
v
- Number value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
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 classJsonGeneratorDelegate
- Parameters:
v
- Number value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
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 classJsonGeneratorDelegate
- Parameters:
v
- Number value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
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 classJsonGeneratorDelegate
- Parameters:
v
- Number value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
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 classJsonGeneratorDelegate
- Parameters:
v
- Number value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
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 classJsonGeneratorDelegate
- Parameters:
v
- Number value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNumber
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, regularJsonGenerator.writeString(java.lang.String)
method can not be used; norJsonGenerator.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 classJsonGeneratorDelegate
- Parameters:
encodedValue
- Textual (possibly format) number representation to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layerUnsupportedOperationException
- 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 IOException, UnsupportedOperationException Description copied from class:JsonGenerator
Overloaded version ofJsonGenerator.writeNumber(String)
with same semantics but possibly more efficient operation.- Overrides:
writeNumber
in classJsonGeneratorDelegate
- Parameters:
encodedValueBuffer
- Buffer that contains the textual number representation to writeoffset
- Offset of the first character of value to writelength
- Length of the value (in characters) to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layerUnsupportedOperationException
-
writeBoolean
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 classJsonGeneratorDelegate
- Parameters:
v
- Boolean value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeNull
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 classJsonGeneratorDelegate
- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeOmittedField
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 returnfalse
fromJsonGenerator.canOmitFields()
.Default implementation does nothing.
- Overrides:
writeOmittedField
in classJsonGeneratorDelegate
- Parameters:
fieldName
- Name of the field omitted- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeObjectId
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 (withJsonGenerator.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, aJsonGenerationException
will be thrown.- Overrides:
writeObjectId
in classJsonGeneratorDelegate
- Parameters:
id
- Native Object Id to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layerJsonGenerationException
- if Object ID output is not allowed (either at all, or specifically in this position in output)
-
writeObjectRef
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 (withJsonGenerator.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, aJsonGenerationException
will be thrown.- Overrides:
writeObjectRef
in classJsonGeneratorDelegate
- Parameters:
id
- Referenced value, for which Object Id is expected to be written- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layerJsonGenerationException
- if Object ID output is not allowed (either at all, or specifically in this position in output)
-
writeTypeId
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 (withJsonGenerator.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, aJsonGenerationException
will be thrown.- Overrides:
writeTypeId
in classJsonGeneratorDelegate
- Parameters:
id
- Native Type Id to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layerJsonGenerationException
- if Type ID output is not allowed (either at all, or specifically in this position in output)
-
_checkParentPath
- Throws:
IOException
-
_checkParentPath
- Throws:
IOException
-
_checkPropertyParentPath
Specialized variant of_checkParentPath()
used when checking parent for a property name to be included with value: rules are slightly different.- Throws:
IOException
- If there is an issue with possible resulting read
-
_checkBinaryWrite
- Throws:
IOException
-
_checkRawValueWrite
- Throws:
IOException
-
TokenFilter.Inclusion
argument instead.