Class TokenBuffer
- All Implemented Interfaces:
Versioned
,Closeable
,Flushable
,AutoCloseable
JsonToken
sequences, needed for temporary buffering.
Space efficient for different sequence lengths (especially so for smaller
ones; but not significantly less efficient for larger), highly efficient
for linear iteration and appending. Implemented as segmented/chunked
linked list of tokens; only modifications are via appends.-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static final class
protected static final class
Individual segment of TokenBuffer that can store up to 16 tokens (limited by 4 bits per token type marker requirement).Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator
JsonGenerator.Feature
-
Field Summary
Modifier and TypeFieldDescriptionprotected int
Offset within last segment,protected boolean
protected TokenBuffer.Segment
First segment, for contents this buffer hasprotected boolean
Flag set during construction, if use ofBigDecimal
is to be forced on all floating-point values.protected int
Bit flag composed of bits that indicate whichJsonGenerator.Feature
s are enabled.protected boolean
Do we currently have a native type or object id buffered?protected boolean
protected boolean
protected TokenBuffer.Segment
Last segment of this buffer, one that is used for appending more tokensprotected boolean
protected ObjectCodec
Object codec to use for stream-based object conversion through parser/generator interfaces.protected Object
If native object ids supported, this is the id for following value (or first token of one) to be written.protected JsonStreamContext
Parse context from "parent" parser (one from which content to buffer is read, if specified).protected Object
If native type ids supported, this is the id for following value (or first token of one) to be written.protected JsonWriteContext
protected static final int
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
ConstructorDescriptionTokenBuffer
(JsonParser p, DeserializationContext ctxt) TokenBuffer
(ObjectCodec codec, boolean hasNativeIds) -
Method Summary
Modifier and TypeMethodDescriptionprotected final void
_appendEndMarker
(JsonToken type) Specialized method used for appending a structural end Object/Array markerprotected final void
_appendFieldName
(Object value) Specialized method used for appending a field name, appending eitherString
orSerializableString
.protected final void
_appendStartMarker
(JsonToken type) Specialized method used for appending a structural start Object/Array markerprotected final void
_appendValue
(JsonToken type) Method used for appending token known to represent a "simple" scalar value where token is the only informationprotected final void
_appendValue
(JsonToken type, Object value) Method used for appending token known to represent a scalar value where there is additional content (text, number) beyond type tokenprotected void
protected void
append
(TokenBuffer other) Helper method that will append contents of given buffer into this buffer.static TokenBuffer
Deprecated.asParser()
Method used to create aJsonParser
that can read contents stored in this buffer.asParser
(JsonParser src) asParser
(ObjectCodec codec) Method used to create aJsonParser
that can read contents stored in this buffer.Same as:boolean
Since we can efficiently storebyte[]
, yes.boolean
Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).boolean
Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't).void
close()
Method called to close this generator, so that no more content can be written.void
Method for copying contents of the current event that the given parser instance points to.void
Method for copying contents of the current event and following events that it encloses the given parser instance points to.deserialize
(JsonParser p, DeserializationContext ctxt) Helper method used by standard deserializer.Method for disabling specified feature (checkJsonGenerator.Feature
for list of features)Method for enabling specified generator feature: checkJsonGenerator.Feature
for list of available features.void
flush()
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.forceUseOfBigDecimal
(boolean b) getCodec()
Method for accessing the object used for writing Java object as JSON content (using methodJsonGenerator.writeObject(java.lang.Object)
).int
Bulk access method for getting state of all standard (non-dataformat-specific)JsonGenerator.Feature
s.final JsonWriteContext
Accessor for context object that provides information about low-level logical position withing output token stream.Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).boolean
isClosed()
Method that can be called to determine whether this generator is closed or not.boolean
isEmpty()
Accessor for checking whether this buffer has one or more tokens or not.boolean
Method for checking whether given feature is enabled.Method that allows explicitly specifying parent parse context to associate with contents of this buffer.overrideStdFeatures
(int values, int mask) Bulk set method for (re)setting states of features specified bymask
.void
serialize
(JsonGenerator gen) Helper method that will write all contents of this buffer using givenJsonGenerator
.setCodec
(ObjectCodec oc) Method that can be called to set or reset the object to use for writing Java objects as JsonContent (using methodJsonGenerator.writeObject(java.lang.Object)
).setFeatureMask
(int mask) Deprecated.toString()
Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter
).version()
Accessor for finding out version of the bundle that provided this generator instance.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) Although we could support this method, it does not necessarily make sense: we cannot make good use of streaming because buffer must hold all the data.void
writeBoolean
(boolean state) Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').void
writeEmbeddedObject
(Object object) Method that can be called on backends that support passing opaque native values that some data formats support; not used with JSON backend, more common with binary formats.final void
Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).final void
Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).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.final 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
(double d) Method for outputting indicate JSON numeric value.void
writeNumber
(float f) Method for outputting indicate JSON numeric value.void
writeNumber
(int i) Method for outputting given value as JSON number.void
writeNumber
(long l) Method for outputting given value as JSON number.void
writeNumber
(short i) 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
writeNumber
(BigDecimal dec) Method for outputting indicate JSON numeric value.void
Method for outputting given value as JSON number.void
writeObject
(Object value) Older alias forJsonGenerator.writePOJO(Object)
void
writeObjectId
(Object id) Method that can be called to output so-called native Object Id.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) final 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
(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()
.final 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
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
(String text) Method for outputting a String value.void
Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator.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.JsonGenerator
_copyCurrentContents, _reportError, _throwInternal, _verifyOffsets, _writeSimpleObject, assignCurrentValue, canOmitFields, canUseSchema, canWriteFormattedNumbers, configure, currentValue, getCharacterEscapes, getCurrentValue, getFormatFeatures, getHighestEscapedChar, getOutputBuffered, getOutputTarget, getPrettyPrinter, getSchema, isEnabled, overrideFormatFeatures, setCharacterEscapes, setCurrentValue, setHighestNonEscapedChar, setPrettyPrinter, setRootValueSeparator, setSchema, writeArray, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeFieldId, writeNullField, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectRef, writeOmittedField, writePOJO, writePOJOField, writeRawValue, writeStartArray, writeString, writeStringField, writeTypePrefix, writeTypeSuffix
-
Field Details
-
DEFAULT_GENERATOR_FEATURES
protected static final int DEFAULT_GENERATOR_FEATURES -
_objectCodec
Object codec to use for stream-based object conversion through parser/generator interfaces. If null, such methods cannot be used. -
_parentContext
Parse context from "parent" parser (one from which content to buffer is read, if specified). Used, if available, when reading content, to present full context as if content was read from the original parser: this is useful in error reporting and sometimes processing as well. -
_generatorFeatures
protected int _generatorFeaturesBit flag composed of bits that indicate whichJsonGenerator.Feature
s are enabled.NOTE: most features have no effect on this class
-
_closed
protected boolean _closed -
_hasNativeTypeIds
protected boolean _hasNativeTypeIds- Since:
- 2.3
-
_hasNativeObjectIds
protected boolean _hasNativeObjectIds- Since:
- 2.3
-
_mayHaveNativeIds
protected boolean _mayHaveNativeIds- Since:
- 2.3
-
_forceBigDecimal
protected boolean _forceBigDecimalFlag set during construction, if use ofBigDecimal
is to be forced on all floating-point values.- Since:
- 2.7
-
_first
First segment, for contents this buffer has -
_last
Last segment of this buffer, one that is used for appending more tokens -
_appendAt
protected int _appendAtOffset within last segment, -
_typeId
If native type ids supported, this is the id for following value (or first token of one) to be written. -
_objectId
If native object ids supported, this is the id for following value (or first token of one) to be written. -
_hasNativeId
protected boolean _hasNativeIdDo we currently have a native type or object id buffered? -
_writeContext
-
-
Constructor Details
-
TokenBuffer
- Parameters:
codec
- Object codec to use for stream-based object conversion through parser/generator interfaces. If null, such methods cannot be used.hasNativeIds
- Whether resultingJsonParser
(if created) is considered to support native type and object ids
-
TokenBuffer
- Since:
- 2.3
-
TokenBuffer
- Since:
- 2.7
-
-
Method Details
-
asCopyOfValue
Deprecated.Convenience method, equivalent to:TokenBuffer b = new TokenBuffer(p); b.copyCurrentStructure(p); return b;
- Throws:
IOException
- Since:
- 2.9
-
overrideParentContext
Method that allows explicitly specifying parent parse context to associate with contents of this buffer. Usually context is assigned at construction, based on given parser; but it is not always available, and may not contain intended context.- Since:
- 2.9
-
forceUseOfBigDecimal
- Since:
- 2.7
-
version
Description copied from class:JsonGenerator
Accessor for finding out version of the bundle that provided this generator instance.- Specified by:
version
in interfaceVersioned
- Specified by:
version
in classJsonGenerator
- Returns:
- Version of this generator (derived from version declared for
jackson-core
jar that contains the class
-
asParser
Method used to create aJsonParser
that can read contents stored in this buffer. Will use default_objectCodec
for object conversions.Note: instances are not synchronized, that is, they are not thread-safe if there are concurrent appends to the underlying buffer.
- Returns:
- Parser that can be used for reading contents stored in this buffer
-
asParserOnFirstToken
Same as:JsonParser p = asParser(); p.nextToken(); return p;
- Throws:
IOException
- Since:
- 2.9
-
asParser
Method used to create aJsonParser
that can read contents stored in this buffer.Note: instances are not synchronized, that is, they are not thread-safe if there are concurrent appends to the underlying buffer.
- Parameters:
codec
- Object codec to use for stream-based object conversion through parser/generator interfaces. If null, such methods cannot be used.- Returns:
- Parser that can be used for reading contents stored in this buffer
-
asParser
- Parameters:
src
- Parser to use for accessing source information like location, configured codec
-
firstToken
-
isEmpty
public boolean isEmpty()Accessor for checking whether this buffer has one or more tokens or not.- Returns:
- True if this buffer instance has no tokens
- Since:
- 2.13
-
append
Helper method that will append contents of given buffer into this buffer. Not particularly optimized; can be made faster if there is need.- Returns:
- This buffer
- Throws:
IOException
-
serialize
Helper method that will write all contents of this buffer using givenJsonGenerator
.Note: this method would be enough to implement
JsonSerializer
forTokenBuffer
type; but we cannot have upwards references (from core to mapper package); and as such we also cannot take second argument.- Throws:
IOException
-
deserialize
Helper method used by standard deserializer.- Throws:
IOException
- Since:
- 2.3
-
toString
-
enable
Description copied from class:JsonGenerator
Method for enabling specified generator feature: checkJsonGenerator.Feature
for list of available features.- Specified by:
enable
in classJsonGenerator
- Parameters:
f
- Feature to enable- Returns:
- This generator, to allow call chaining
-
disable
Description copied from class:JsonGenerator
Method for disabling specified feature (checkJsonGenerator.Feature
for list of features)- Specified by:
disable
in classJsonGenerator
- Parameters:
f
- Feature to disable- Returns:
- This generator, to allow call chaining
-
isEnabled
Description copied from class:JsonGenerator
Method for checking whether given feature is enabled. CheckJsonGenerator.Feature
for list of available features.- Specified by:
isEnabled
in classJsonGenerator
- Parameters:
f
- Feature to check- Returns:
- True if specified feature is enabled; false if not
-
getFeatureMask
public int getFeatureMask()Description copied from class:JsonGenerator
Bulk access method for getting state of all standard (non-dataformat-specific)JsonGenerator.Feature
s.- Specified by:
getFeatureMask
in classJsonGenerator
- Returns:
- Bit mask that defines current states of all standard
JsonGenerator.Feature
s.
-
setFeatureMask
Deprecated.Description copied from class:JsonGenerator
Bulk set method for (re)setting states of all standardJsonGenerator.Feature
s- Specified by:
setFeatureMask
in classJsonGenerator
- Parameters:
mask
- Bitmask that defines whichJsonGenerator.Feature
s are enabled and which disabled- Returns:
- This generator, to allow call chaining
-
overrideStdFeatures
Description copied from class:JsonGenerator
Bulk set method for (re)setting states of features specified bymask
. Functionally equivalent toint oldState = getFeatureMask(); int newState = (oldState & ~mask) | (values & mask); setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.- Overrides:
overrideStdFeatures
in classJsonGenerator
- Parameters:
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to change- Returns:
- This generator, to allow call chaining
-
useDefaultPrettyPrinter
Description copied from class:JsonGenerator
Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter
).- Specified by:
useDefaultPrettyPrinter
in classJsonGenerator
- Returns:
- This generator, to allow call chaining
-
setCodec
Description copied from class:JsonGenerator
Method that can be called to set or reset the object to use for writing Java objects as JsonContent (using methodJsonGenerator.writeObject(java.lang.Object)
).- Specified by:
setCodec
in classJsonGenerator
- Parameters:
oc
- Codec to assign, if any;null
if none- Returns:
- This generator, to allow call chaining
-
getCodec
Description copied from class:JsonGenerator
Method for accessing the object used for writing Java object as JSON content (using methodJsonGenerator.writeObject(java.lang.Object)
).- Specified by:
getCodec
in classJsonGenerator
- Returns:
- Codec assigned to this generator, if any;
null
if none
-
getOutputContext
Description copied from class:JsonGenerator
Accessor for context object that provides information about low-level logical position withing output token stream.- Specified by:
getOutputContext
in classJsonGenerator
- Returns:
- Stream output context (
JsonStreamContext
) associated with this generator
-
canWriteBinaryNatively
public boolean canWriteBinaryNatively()Since we can efficiently storebyte[]
, yes.- Overrides:
canWriteBinaryNatively
in classJsonGenerator
- Returns:
True
if this generator is capable of writing "raw" Binary Content (this is typically determined by capabilities of the underlying format);false
if not
-
getWriteCapabilities
Description copied from class:JsonGenerator
Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).- Overrides:
getWriteCapabilities
in classJsonGenerator
- Returns:
- Set of write capabilities for content written using this generator
-
flush
Description copied from class:JsonGenerator
Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classJsonGenerator
- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
close
Description copied from class:JsonGenerator
Method called to close this generator, so that no more content can be written.Whether the underlying target (stream, writer) gets closed depends on whether this generator either manages the target (i.e. is the only one with access to the target -- case if caller passes a reference to the resource such as File, but not stream); or has feature
JsonGenerator.Feature.AUTO_CLOSE_TARGET
enabled. If either of above is true, the target is also closed. Otherwise (not managing, feature not enabled), target is not closed.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classJsonGenerator
- Throws:
IOException
- if there is either an underlying I/O problem
-
isClosed
public boolean isClosed()Description copied from class:JsonGenerator
Method that can be called to determine whether this generator is closed or not. If it is closed, no more output can be done.- Specified by:
isClosed
in classJsonGenerator
- Returns:
True
if this generator instance has been closed
-
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.
- Specified by:
writeStartArray
in classJsonGenerator
- 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 classJsonGenerator
- 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 classJsonGenerator
- 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.
- Specified by:
writeEndArray
in classJsonGenerator
- 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.
- Specified by:
writeStartObject
in classJsonGenerator
- 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 classJsonGenerator
- 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 classJsonGenerator
- 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).
- Specified by:
writeEndObject
in classJsonGenerator
- 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).
- Specified by:
writeFieldName
in classJsonGenerator
- 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.
- Specified by:
writeFieldName
in classJsonGenerator
- Parameters:
name
- Field name 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.- Specified by:
writeString
in classJsonGenerator
- Parameters:
text
- 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.- Specified by:
writeString
in classJsonGenerator
- 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.- Specified by:
writeString
in classJsonGenerator
- Parameters:
text
- Pre-encoded String value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
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.- Specified by:
writeRawUTF8String
in classJsonGenerator
- 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.- Specified by:
writeUTF8String
in classJsonGenerator
- 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
.- Specified by:
writeRaw
in classJsonGenerator
- 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
.- Specified by:
writeRaw
in classJsonGenerator
- 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 classJsonGenerator
- 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
.- Specified by:
writeRaw
in classJsonGenerator
- 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
.- Specified by:
writeRaw
in classJsonGenerator
- 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.- Specified by:
writeRawValue
in classJsonGenerator
- 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
- Specified by:
writeRawValue
in classJsonGenerator
- Throws:
IOException
-
writeRawValue
- Specified by:
writeRawValue
in classJsonGenerator
- Throws:
IOException
-
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 classJsonGenerator
- Parameters:
i
- 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.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
i
- 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.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
l
- 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.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
d
- 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.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
f
- 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.- Specified by:
writeNumber
in classJsonGenerator
- Parameters:
dec
- 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.- Specified by:
writeNumber
in classJsonGenerator
- 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
.- Specified by:
writeNumber
in classJsonGenerator
- 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 layer
-
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.- Specified by:
writeBoolean
in classJsonGenerator
- Parameters:
state
- 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.- Specified by:
writeNull
in classJsonGenerator
- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeObject
Description copied from class:JsonGenerator
Older alias forJsonGenerator.writePOJO(Object)
- Specified by:
writeObject
in classJsonGenerator
- Parameters:
value
- Java value (usually POJO) to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeTree
Description copied from class:JsonGenerator
Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator. This will generally just callJsonGenerator.writeObject(java.lang.Object)
with given node, but is added for convenience and to make code more explicit in cases where it deals specifically with trees.- Specified by:
writeTree
in classJsonGenerator
- Parameters:
node
-TreeNode
to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeBinary
public void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws 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.- Specified by:
writeBinary
in classJsonGenerator
- 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
Although we could support this method, it does not necessarily make sense: we cannot make good use of streaming because buffer must hold all the data. Because of this, currently this will simply throwUnsupportedOperationException
- Specified by:
writeBinary
in classJsonGenerator
- 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
-
canWriteTypeId
public boolean canWriteTypeId()Description copied from class:JsonGenerator
Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't). This method must be called prior to callingJsonGenerator.writeTypeId(java.lang.Object)
.Default implementation returns false; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native type ids.
- Overrides:
canWriteTypeId
in classJsonGenerator
- Returns:
True
if this generator is capable of writing "native" Type Ids (which is typically determined by capabilities of the underlying format),false
if not
-
canWriteObjectId
public boolean canWriteObjectId()Description copied from class:JsonGenerator
Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't). This method must be called prior to callingJsonGenerator.writeObjectId(java.lang.Object)
orJsonGenerator.writeObjectRef(java.lang.Object)
.Default implementation returns false; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native object ids.
- Overrides:
canWriteObjectId
in classJsonGenerator
- Returns:
True
if this generator is capable of writing "native" Object Ids (which is typically determined by capabilities of the underlying format),false
if not
-
writeTypeId
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 classJsonGenerator
- Parameters:
id
- Native Type Id to write
-
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 classJsonGenerator
- Parameters:
id
- Native Object Id to write
-
writeEmbeddedObject
Description copied from class:JsonGenerator
Method that can be called on backends that support passing opaque native values that some data formats support; not used with JSON backend, more common with binary formats.NOTE: this is NOT the method to call for serializing regular POJOs, see
JsonGenerator.writeObject(java.lang.Object)
instead.- Overrides:
writeEmbeddedObject
in classJsonGenerator
- Parameters:
object
- Native format-specific value to write- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
copyCurrentEvent
Description copied from class:JsonGenerator
Method for copying contents of the current event that the given parser instance points to. Note that the method will not copy any other events, such as events contained within JSON Array or Object structures.Calling this method will not advance the given parser, although it may cause parser to internally process more data (if it lazy loads contents of value events, for example)
- Overrides:
copyCurrentEvent
in classJsonGenerator
- Parameters:
p
- Parser that points to event (token) to copy- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
copyCurrentStructure
Description copied from class:JsonGenerator
Method for copying contents of the current event and following events that it encloses the given parser instance points to.So what constitutes enclosing? Here is the list of events that have associated enclosed events that will get copied:
JsonToken.START_OBJECT
: all events up to and including matching (closing)JsonToken.END_OBJECT
will be copiedJsonToken.START_ARRAY
all events up to and including matching (closing)JsonToken.END_ARRAY
will be copiedJsonToken.FIELD_NAME
the logical value (which can consist of a single scalar value; or a sequence of related events for structured types (JSON Arrays, Objects)) will be copied along with the name itself. So essentially the whole field entry (name and value) will be copied.
After calling this method, parser will point to the last event that was copied. This will either be the event parser already pointed to (if there were no enclosed events), or the last enclosed event copied.
- Overrides:
copyCurrentStructure
in classJsonGenerator
- Parameters:
p
- Parser that points to the value to copy- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
_copyBufferContents
- Throws:
IOException
-
_appendValue
Method used for appending token known to represent a "simple" scalar value where token is the only information- Since:
- 2.6.4
-
_appendValue
Method used for appending token known to represent a scalar value where there is additional content (text, number) beyond type token- Since:
- 2.6.4
-
_appendFieldName
Specialized method used for appending a field name, appending eitherString
orSerializableString
.- Since:
- 2.10
-
_appendStartMarker
Specialized method used for appending a structural start Object/Array marker- Since:
- 2.10
-
_appendEndMarker
Specialized method used for appending a structural end Object/Array marker- Since:
- 2.10
-
_reportUnsupportedOperation
protected void _reportUnsupportedOperation()- Overrides:
_reportUnsupportedOperation
in classJsonGenerator
-
DeserializationContext.bufferAsCopyOfValue(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser)
instead.