TokenBuffer (Red Hat JBoss Enterprise Application Platform 7.0.0.GA public API)

java.lang.Object
- com.fasterxml.jackson.core.JsonGenerator
- - com.fasterxml.jackson.databind.util.TokenBuffer

All Implemented Interfaces:

Versioned, Closeable, Flushable, AutoCloseable
```
public class TokenBuffer
extends JsonGenerator
```
Utility class used for efficient storage of 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.
Note that before version 2.0, this class was located in the "core" bundle, not data-binding; but since it was only used by data binding, was moved here to reduce size of core package

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`TokenBuffer.Parser`
`protected static class`	`TokenBuffer.Segment` 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 com.fasterxml.jackson.core.JsonGenerator
JsonGenerator.Feature

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`_appendAt` Offset within last segment,
`protected boolean`	`_closed`
`protected TokenBuffer.Segment`	`_first` First segment, for contents this buffer has
`protected int`	`_generatorFeatures` Bit flag composed of bits that indicate which `JsonGenerator.Feature`s are enabled.
`protected boolean`	`_hasNativeId` Do we currnetly have a native type or object id buffered?
`protected boolean`	`_hasNativeObjectIds`
`protected boolean`	`_hasNativeTypeIds`
`protected TokenBuffer.Segment`	`_last` Last segment of this buffer, one that is used for appending more tokens
`protected boolean`	`_mayHaveNativeIds`
`protected ObjectCodec`	`_objectCodec` Object codec to use for stream-based object conversion through parser/generator interfaces.
`protected Object`	`_objectId` If native object ids supported, this is the id for following value (or first token of one) to be written.
`protected Object`	`_typeId` If native type ids supported, this is the id for following value (or first token of one) to be written.
`protected JsonWriteContext`	`_writeContext`
`protected static int`	`DEFAULT_GENERATOR_FEATURES`

Fields inherited from class com.fasterxml.jackson.core.JsonGenerator
_cfgPrettyPrinter

Constructor Summary

Constructors
Constructor and Description
`TokenBuffer(JsonParser jp)`
`TokenBuffer(ObjectCodec codec)` Deprecated. since 2.3 preferred variant is one that takes `JsonParser` or additional boolean parameter.
`TokenBuffer(ObjectCodec codec, boolean hasNativeIds)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_append(JsonToken type)`
`protected void`	`_append(JsonToken type, Object value)`
`protected void`	`_appendRaw(int rawType, Object value)`
`protected void`	`_reportUnsupportedOperation()`
`TokenBuffer`	`append(TokenBuffer other)` Helper method that will append contents of given buffer into this buffer.
`JsonParser`	`asParser()` Method used to create a `JsonParser` that can read contents stored in this buffer.
`JsonParser`	`asParser(JsonParser src)`
`JsonParser`	`asParser(ObjectCodec codec)` Method used to create a `JsonParser` that can read contents stored in this buffer.
`boolean`	`canWriteBinaryNatively()` Since we can efficiently store `byte[]`, yes.
`boolean`	`canWriteObjectId()` 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`	`canWriteTypeId()` 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`	`copyCurrentEvent(JsonParser jp)` Method for copying contents of the current event that the given parser instance points to.
`void`	`copyCurrentStructure(JsonParser jp)` Method for copying contents of the current event and following events that it encloses the given parser instance points to.
`TokenBuffer`	`deserialize(JsonParser jp, DeserializationContext ctxt)` Helper method used by standard deserializer.
`JsonGenerator`	`disable(JsonGenerator.Feature f)` Method for disabling specified features (check `JsonGenerator.Feature` for list of features)
`JsonGenerator`	`enable(JsonGenerator.Feature f)` Method for enabling specified parser features: check `JsonGenerator.Feature` for list of available features.
`JsonToken`	`firstToken()`
`void`	`flush()` Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
`ObjectCodec`	`getCodec()` Method for accessing the object used for writing Java object as Json content (using method `JsonGenerator.writeObject(java.lang.Object)`).
`int`	`getFeatureMask()` Bulk access method for getting state of all standard `JsonGenerator.Feature`s.
`JsonWriteContext`	`getOutputContext()`
`boolean`	`isClosed()` Method that can be called to determine whether this generator is closed or not.
`boolean`	`isEnabled(JsonGenerator.Feature f)` Method for checking whether given feature is enabled.
`void`	`serialize(JsonGenerator jgen)` Helper method that will write all contents of this buffer using given `JsonGenerator`.
`JsonGenerator`	`setCodec(ObjectCodec oc)` Method that can be called to set or reset the object to use for writing Java objects as JsonContent (using method `JsonGenerator.writeObject(java.lang.Object)`).
`JsonGenerator`	`setFeatureMask(int mask)` Bulk set method for (re)setting states of all standard `JsonGenerator.Feature`s
`String`	`toString()`
`JsonGenerator`	`useDefaultPrettyPrinter()` Convenience method for enabling pretty-printing using the default pretty printer (`DefaultPrettyPrinter`).
`Version`	`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 can not 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`	`writeEndArray()` Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).
`void`	`writeEndObject()` Method for writing closing marker of a JSON Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).
`void`	`writeFieldName(SerializableString name)` Method similar to `JsonGenerator.writeFieldName(String)`, main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.
`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`	`writeNull()` Method for outputting literal Json null value.
`void`	`writeNumber(BigDecimal dec)` Method for outputting indicate JSON numeric value.
`void`	`writeNumber(BigInteger v)` Method for outputting given value as JSON number.
`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`	`writeObject(Object value)` Method for writing given Java object (POJO) as Json.
`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`	`writeRaw(String 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`	`writeRaw(String 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`	`writeRawUTF8String(byte[] text, int offset, int length)` Method similar to `JsonGenerator.writeString(String)` but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON).
`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`	`writeStartArray()` 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`	`writeStartObject()` Method for writing starting marker of a JSON Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).
`void`	`writeString(char[] text, int offset, int len)` Method for outputting a String value.
`void`	`writeString(SerializableString text)` Method similar to `JsonGenerator.writeString(String)`, but that takes `SerializableString` which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.
`void`	`writeString(String text)` Method for outputting a String value.
`void`	`writeTree(TreeNode node)` 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 to `JsonGenerator.writeString(String)` but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_GENERATOR_FEATURES
```
protected static final int DEFAULT_GENERATOR_FEATURES
```
  - _objectCodec
```
protected ObjectCodec _objectCodec
```
    Object codec to use for stream-based object conversion through parser/generator interfaces. If null, such methods can not be used.
  - _generatorFeatures
```
protected int _generatorFeatures
```
    Bit flag composed of bits that indicate which JsonGenerator.Features 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
  - _first
```
protected TokenBuffer.Segment _first
```
    First segment, for contents this buffer has
  - _last
```
protected TokenBuffer.Segment _last
```
    Last segment of this buffer, one that is used for appending more tokens
  - _appendAt
```
protected int _appendAt
```
    Offset within last segment,
  - _typeId
```
protected Object _typeId
```
    If native type ids supported, this is the id for following value (or first token of one) to be written.
  - _objectId
```
protected Object _objectId
```
    If native object ids supported, this is the id for following value (or first token of one) to be written.
  - _hasNativeId
```
protected boolean _hasNativeId
```
    Do we currnetly have a native type or object id buffered?
  - _writeContext
```
protected JsonWriteContext _writeContext
```
- Constructor Detail
  - TokenBuffer
```
@Deprecated
public TokenBuffer(ObjectCodec codec)
```
    Deprecated. since 2.3 preferred variant is one that takes JsonParser or additional boolean parameter.
    
    Parameters:
    
    codec - Object codec to use for stream-based object conversion through parser/generator interfaces. If null, such methods can not be used.
  - TokenBuffer
```
public TokenBuffer(ObjectCodec codec,
                   boolean hasNativeIds)
```
    Parameters:
    
    codec - Object codec to use for stream-based object conversion through parser/generator interfaces. If null, such methods can not be used.
    
    hasNativeIds - Whether resulting JsonParser (if created) is considered to support native type and object ids
  - TokenBuffer
```
public TokenBuffer(JsonParser jp)
```
    Since:
    
    2.3
- Method Detail
  - version
```
public Version version()
```
    Description copied from class: JsonGenerator
    
    Accessor for finding out version of the bundle that provided this generator instance.
    
    Specified by:
    
    version in interface Versioned
    
    Specified by:
    
    version in class JsonGenerator
  - asParser
```
public JsonParser asParser()
```
    Method used to create a JsonParser 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
  - asParser
```
public JsonParser asParser(ObjectCodec codec)
```
    Method used to create a JsonParser 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 can not be used.
    
    Returns:
    
    Parser that can be used for reading contents stored in this buffer
  - asParser
```
public JsonParser asParser(JsonParser src)
```
    Parameters:
    
    src - Parser to use for accessing source information like location, configured codec
  - firstToken
```
public JsonToken firstToken()
```
  - append
```
public TokenBuffer append(TokenBuffer other)
                   throws IOException,
                          JsonGenerationException
```
    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
    
    JsonGenerationException
  - serialize
```
public void serialize(JsonGenerator jgen)
               throws IOException,
                      JsonGenerationException
```
    Helper method that will write all contents of this buffer using given JsonGenerator.
    Note: this method would be enough to implement JsonSerializer for TokenBuffer type; but we can not have upwards references (from core to mapper package); and as such we also can not take second argument.
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - deserialize
```
public TokenBuffer deserialize(JsonParser jp,
                               DeserializationContext ctxt)
                        throws IOException
```
    Helper method used by standard deserializer.
    
    Throws:
    
    IOException
    
    Since:
    
    2.3
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - enable
```
public JsonGenerator enable(JsonGenerator.Feature f)
```
    Description copied from class: JsonGenerator
    
    Method for enabling specified parser features: check JsonGenerator.Feature for list of available features.
    
    Specified by:
    
    enable in class JsonGenerator
    
    Returns:
    
    Generator itself (this), to allow chaining
  - disable
```
public JsonGenerator disable(JsonGenerator.Feature f)
```
    Description copied from class: JsonGenerator
    
    Method for disabling specified features (check JsonGenerator.Feature for list of features)
    
    Specified by:
    
    disable in class JsonGenerator
    
    Returns:
    
    Generator itself (this), to allow chaining
  - isEnabled
```
public boolean isEnabled(JsonGenerator.Feature f)
```
    Description copied from class: JsonGenerator
    
    Method for checking whether given feature is enabled. Check JsonGenerator.Feature for list of available features.
    
    Specified by:
    
    isEnabled in class JsonGenerator
  - getFeatureMask
```
public int getFeatureMask()
```
    Description copied from class: JsonGenerator
    
    Bulk access method for getting state of all standard JsonGenerator.Features.
    
    Specified by:
    
    getFeatureMask in class JsonGenerator
    
    Returns:
    
    Bit mask that defines current states of all standard JsonGenerator.Features.
  - setFeatureMask
```
public JsonGenerator setFeatureMask(int mask)
```
    Description copied from class: JsonGenerator
    
    Bulk set method for (re)setting states of all standard JsonGenerator.Features
    
    Specified by:
    
    setFeatureMask in class JsonGenerator
    
    Parameters:
    
    mask - Bitmask that defines which JsonGenerator.Features are enabled and which disabled
    
    Returns:
    
    This parser object, to allow chaining of calls
  - useDefaultPrettyPrinter
```
public JsonGenerator useDefaultPrettyPrinter()
```
    Description copied from class: JsonGenerator
    
    Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter).
    
    Specified by:
    
    useDefaultPrettyPrinter in class JsonGenerator
    
    Returns:
    
    Generator itself (this), to allow chaining
  - setCodec
```
public JsonGenerator setCodec(ObjectCodec oc)
```
    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 method JsonGenerator.writeObject(java.lang.Object)).
    
    Specified by:
    
    setCodec in class JsonGenerator
    
    Returns:
    
    Generator itself (this), to allow chaining
  - getCodec
```
public ObjectCodec getCodec()
```
    Description copied from class: JsonGenerator
    
    Method for accessing the object used for writing Java object as Json content (using method JsonGenerator.writeObject(java.lang.Object)).
    
    Specified by:
    
    getCodec in class JsonGenerator
  - getOutputContext
```
public final JsonWriteContext getOutputContext()
```
    Specified by:
    
    getOutputContext in class JsonGenerator
    
    Returns:
    
    Context object that can give information about logical position within generated json content.
  - canWriteBinaryNatively
```
public boolean canWriteBinaryNatively()
```
    Since we can efficiently store byte[], yes.
    
    Overrides:
    
    canWriteBinaryNatively in class JsonGenerator
  - flush
```
public void flush()
           throws IOException
```
    Description copied from class: JsonGenerator
    
    Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
    
    Specified by:
    
    flush in interface Flushable
    
    Specified by:
    
    flush in class JsonGenerator
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Description copied from class: JsonGenerator
    
    Method called to close this generator, so that no more content can be written.
    Whether the underlying target (stream, writer) gets closed depends on whether this generator either manages the target (i.e. is the only one with access to the target -- case if caller passes a reference to the resource such as File, but not stream); or has feature JsonGenerator.Feature.AUTO_CLOSE_TARGET enabled. If either of above is true, the target is also closed. Otherwise (not managing, feature not enabled), target is not closed.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in class JsonGenerator
    
    Throws:
    
    IOException
  - isClosed
```
public boolean isClosed()
```
    Description copied from class: JsonGenerator
    
    Method that can be called to determine whether this generator is closed or not. If it is closed, no more output can be done.
    
    Specified by:
    
    isClosed in class JsonGenerator
  - writeStartArray
```
public final void writeStartArray()
                           throws IOException,
                                  JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).
    Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
    
    Specified by:
    
    writeStartArray in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeEndArray
```
public final void writeEndArray()
                         throws IOException,
                                JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).
    Marker can be written if the innermost structured type is Array.
    
    Specified by:
    
    writeEndArray in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeStartObject
```
public final void writeStartObject()
                            throws IOException,
                                   JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for writing starting marker of a JSON Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).
    Object values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
    
    Specified by:
    
    writeStartObject in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeEndObject
```
public final void writeEndObject()
                          throws IOException,
                                 JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for writing closing marker of a JSON Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).
    Marker can be written if the innermost structured type is Object, and the last written event was either a complete value, or START-OBJECT marker (see JSON specification for more details).
    
    Specified by:
    
    writeEndObject in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeFieldName
```
public final void writeFieldName(String name)
                          throws IOException,
                                 JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.
    Field names can only be written in Object context (check out JSON specification for details), when field name is expected (field names alternate with values).
    
    Specified by:
    
    writeFieldName in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeFieldName
```
public void writeFieldName(SerializableString name)
                    throws IOException,
                           JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method similar to JsonGenerator.writeFieldName(String), main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.
    Default implementation simple uses unprocessed name container in serialized String; implementations are strongly encouraged to make use of more efficient methods argument object has.
    
    Specified by:
    
    writeFieldName in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeString
```
public void writeString(String text)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.
    
    Specified by:
    
    writeString in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeString
```
public void writeString(char[] text,
                        int offset,
                        int len)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting a String value. Depending on context this means either array element, (object) field value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.
    
    Specified by:
    
    writeString in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeString
```
public void writeString(SerializableString text)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method similar to JsonGenerator.writeString(String), but that takes SerializableString which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.
    Default implementation just calls JsonGenerator.writeString(String); sub-classes should override it with more efficient implementation if possible.
    
    Specified by:
    
    writeString in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRawUTF8String
```
public void writeRawUTF8String(byte[] text,
                               int offset,
                               int length)
                        throws IOException,
                               JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method similar to JsonGenerator.writeString(String) but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON). However, quoting that data format requires (like double-quotes for JSON) will be added around the value if and as necessary.
    Note that some backends may choose not to support this method: for example, if underlying destination is a Writer using this method would require UTF-8 decoding. If so, implementation may instead choose to throw a UnsupportedOperationException due to ineffectiveness of having to decode input.
    
    Specified by:
    
    writeRawUTF8String in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeUTF8String
```
public void writeUTF8String(byte[] text,
                            int offset,
                            int length)
                     throws IOException,
                            JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method similar to JsonGenerator.writeString(String) but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else). This means that textual JSON backends need to check if value needs JSON escaping, but otherwise can just be copied as is to output. Also, quoting that data format requires (like double-quotes for JSON) will be added around the value if and as necessary.
    Note that some backends may choose not to support this method: for example, if underlying destination is a Writer using this method would require UTF-8 decoding. In this case generator implementation may instead choose to throw a UnsupportedOperationException due to ineffectiveness of having to decode input.
    
    Specified by:
    
    writeUTF8String in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRaw
```
public void writeRaw(String text)
              throws IOException,
                     JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.
    Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.
    
    Specified by:
    
    writeRaw in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRaw
```
public void writeRaw(String text,
                     int offset,
                     int len)
              throws IOException,
                     JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.
    Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.
    
    Specified by:
    
    writeRaw in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRaw
```
public void writeRaw(SerializableString text)
              throws IOException,
                     JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.
    Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.
    The default implementation delegates to JsonGenerator.writeRaw(String); other backends that support raw inclusion of text are encouraged to implement it in more efficient manner (especially if they use UTF-8 encoding).
    
    Overrides:
    
    writeRaw in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRaw
```
public void writeRaw(char[] text,
                     int offset,
                     int len)
              throws IOException,
                     JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.
    Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.
    
    Specified by:
    
    writeRaw in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRaw
```
public void writeRaw(char c)
              throws IOException,
                     JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such). If such separators are desired, use JsonGenerator.writeRawValue(String) instead.
    Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.
    
    Specified by:
    
    writeRaw in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRawValue
```
public void writeRawValue(String text)
                   throws IOException,
                          JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method that will force generator to copy input text verbatim without any modifications, but assuming it must constitute a single legal JSON value (number, string, boolean, null, Array or List). Assuming this, proper separators are added if and as needed (comma or colon), and generator state updated to reflect this.
    
    Specified by:
    
    writeRawValue in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRawValue
```
public void writeRawValue(String text,
                          int offset,
                          int len)
                   throws IOException,
                          JsonGenerationException
```
    Specified by:
    
    writeRawValue in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeRawValue
```
public void writeRawValue(char[] text,
                          int offset,
                          int len)
                   throws IOException,
                          JsonGenerationException
```
    Specified by:
    
    writeRawValue in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNumber
```
public void writeNumber(short i)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Overrides:
    
    writeNumber in class JsonGenerator
    
    Parameters:
    
    i - Number value to write
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNumber
```
public void writeNumber(int i)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Specified by:
    
    writeNumber in class JsonGenerator
    
    Parameters:
    
    i - Number value to write
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNumber
```
public void writeNumber(long l)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Specified by:
    
    writeNumber in class JsonGenerator
    
    Parameters:
    
    l - Number value to write
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNumber
```
public void writeNumber(double d)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Specified by:
    
    writeNumber in class JsonGenerator
    
    Parameters:
    
    d - Number value to write
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNumber
```
public void writeNumber(float f)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Specified by:
    
    writeNumber in class JsonGenerator
    
    Parameters:
    
    f - Number value to write
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNumber
```
public void writeNumber(BigDecimal dec)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Specified by:
    
    writeNumber in class JsonGenerator
    
    Parameters:
    
    dec - Number value to write
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNumber
```
public void writeNumber(BigInteger v)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Specified by:
    
    writeNumber in class JsonGenerator
    
    Parameters:
    
    v - Number value to write
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNumber
```
public void writeNumber(String encodedValue)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types. Because numbers are not surrounded by double quotes, regular JsonGenerator.writeString(java.lang.String) method can not be used; nor JsonGenerator.writeRaw(java.lang.String) because that does not properly handle value separators needed in Array or Object contexts.
    Note: because of lack of type safety, some generator implementations may not be able to implement this method. For example, if a binary JSON format is used, it may require type information for encoding; similarly for generator-wrappers around Java objects or JSON nodes. If implementation does not implement this method, it needs to throw UnsupportedOperationException.
    
    Specified by:
    
    writeNumber in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeBoolean
```
public void writeBoolean(boolean state)
                  throws IOException,
                         JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting literal Json boolean value (one of Strings 'true' and 'false'). Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Specified by:
    
    writeBoolean in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeNull
```
public void writeNull()
               throws IOException,
                      JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method for outputting literal Json null value. Can be called in any context where a value is expected (Array value, Object field value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.
    
    Specified by:
    
    writeNull in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeObject
```
public void writeObject(Object value)
                 throws IOException
```
    Description copied from class: JsonGenerator
    
    Method for writing given Java object (POJO) as Json. Exactly how the object gets written depends on object in question (ad on codec, its configuration); for most beans it will result in Json object, but for others Json array, or String or numeric value (and for nulls, Json null literal. NOTE: generator must have its object codec set to non-null value; for generators created by a mapping factory this is the case, for others not.
    
    Specified by:
    
    writeObject in class JsonGenerator
    
    Throws:
    
    IOException
  - writeTree
```
public void writeTree(TreeNode node)
               throws IOException
```
    Description copied from class: JsonGenerator
    
    Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator. This will generally just call JsonGenerator.writeObject(java.lang.Object) with given node, but is added for convenience and to make code more explicit in cases where it deals specifically with trees.
    
    Specified by:
    
    writeTree in class JsonGenerator
    
    Throws:
    
    IOException
  - writeBinary
```
public void writeBinary(Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws IOException,
                        JsonGenerationException
```
    Description copied from class: JsonGenerator
    
    Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes). This method defaults
    Note: because Json Strings can not contain unescaped linefeeds, if linefeeds are included (as per last argument), they must be escaped. This adds overhead for decoding without improving readability. Alternatively if linefeeds are not included, resulting String value may violate the requirement of base64 RFC which mandates line-length of 76 characters and use of linefeeds. However, all JsonParser implementations are required to accept such "long line base64"; as do typical production-level base64 decoders.
    
    Specified by:
    
    writeBinary in class JsonGenerator
    
    Parameters:
    
    b64variant - Base64 variant to use: defines details such as whether padding is used (and if so, using which character); what is the maximum line length before adding linefeed, and also the underlying alphabet to use.
    
    Throws:
    
    IOException
    
    JsonGenerationException
  - writeBinary
```
public int writeBinary(Base64Variant b64variant,
                       InputStream data,
                       int dataLength)
```
    Although we could support this method, it does not necessarily make sense: we can not make good use of streaming because buffer must hold all the data. Because of this, currently this will simply throw UnsupportedOperationException
    
    Specified by:
    
    writeBinary in class JsonGenerator
    
    Parameters:
    
    b64variant - Base64 variant to use
    
    data - InputStream to use for reading binary data to write. Will not be closed after successful write operation
    
    dataLength - (optional) number of bytes that will be available; or -1 to be indicate it is not known. If a positive length is given, data MUST provide at least that many bytes: if not, an exception will be thrown. Note that implementations need not support cases where length is not known in advance; this depends on underlying data format: JSON output does NOT require length, other formats may.
    
    Returns:
    
    Number of bytes read from data and written as binary payload
  - canWriteTypeId
```
public boolean canWriteTypeId()
```
    Description copied from class: JsonGenerator
    
    Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't). This method must be called prior to calling JsonGenerator.writeTypeId(java.lang.Object).
    Default implementation returns false; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native type ids.
    
    Overrides:
    
    canWriteTypeId in class JsonGenerator
  - canWriteObjectId
```
public boolean canWriteObjectId()
```
    Description copied from class: JsonGenerator
    
    Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't). This method must be called prior to calling JsonGenerator.writeObjectId(java.lang.Object) or JsonGenerator.writeObjectRef(java.lang.Object).
    Default implementation returns false; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native object ids.
    
    Overrides:
    
    canWriteObjectId in class JsonGenerator
  - writeTypeId
```
public void writeTypeId(Object id)
```
    Description copied from class: JsonGenerator
    
    Method that can be called to output so-called native Type Id. Note that it may only be called after ensuring this is legal (with JsonGenerator.canWriteTypeId()), as not all data formats have native type id support; and some may only allow them in certain positions or locations. If output is not allowed by the data format in this position, a JsonGenerationException will be thrown.
    
    Overrides:
    
    writeTypeId in class JsonGenerator
  - writeObjectId
```
public void writeObjectId(Object id)
```
    Description copied from class: JsonGenerator
    
    Method that can be called to output so-called native Object Id. Note that it may only be called after ensuring this is legal (with JsonGenerator.canWriteObjectId()), as not all data formats have native type id support; and some may only allow them in certain positions or locations. If output is not allowed by the data format in this position, a JsonGenerationException will be thrown.
    
    Overrides:
    
    writeObjectId in class JsonGenerator
  - copyCurrentEvent
```
public void copyCurrentEvent(JsonParser jp)
                      throws IOException,
                             JsonProcessingException
```
    Description copied from class: JsonGenerator
    
    Method for copying contents of the current event that the given parser instance points to. Note that the method will not copy any other events, such as events contained within Json Array or Object structures.
    Calling this method will not advance the given parser, although it may cause parser to internally process more data (if it lazy loads contents of value events, for example)
    
    Overrides:
    
    copyCurrentEvent in class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonProcessingException
  - copyCurrentStructure
```
public void copyCurrentStructure(JsonParser jp)
                          throws IOException,
                                 JsonProcessingException
```
    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 copied
    - JsonToken.START_ARRAY all events up to and including matching (closing) JsonToken.END_ARRAY will be copied
    - JsonToken.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 class JsonGenerator
    
    Throws:
    
    IOException
    
    JsonProcessingException
  - _append
```
protected final void _append(JsonToken type)
```
  - _append
```
protected final void _append(JsonToken type,
                             Object value)
```
  - _appendRaw
```
protected final void _appendRaw(int rawType,
                                Object value)
```
  - _reportUnsupportedOperation
```
protected void _reportUnsupportedOperation()
```
    Overrides:
    
    _reportUnsupportedOperation in class JsonGenerator

Class TokenBuffer

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonGenerator

Field Summary

Fields inherited from class com.fasterxml.jackson.core.JsonGenerator

Constructor Summary

Method Summary

Methods inherited from class com.fasterxml.jackson.core.JsonGenerator

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_GENERATOR_FEATURES

_objectCodec

_generatorFeatures

_closed

_hasNativeTypeIds

_hasNativeObjectIds

_mayHaveNativeIds

_first

_last

_appendAt

_typeId

_objectId

_hasNativeId

_writeContext

Constructor Detail

TokenBuffer

TokenBuffer

TokenBuffer

Method Detail

version

asParser

asParser

asParser

firstToken

append

serialize

deserialize

toString

enable

disable

isEnabled

getFeatureMask

setFeatureMask

useDefaultPrettyPrinter

setCodec

getCodec

getOutputContext

canWriteBinaryNatively

flush

close

isClosed

writeStartArray

writeEndArray

writeStartObject

writeEndObject

writeFieldName

writeFieldName

writeString

writeString

writeString

writeRawUTF8String

writeUTF8String

writeRaw

writeRaw

writeRaw

writeRaw

writeRaw

writeRawValue

writeRawValue

writeRawValue

writeNumber

writeNumber

writeNumber

writeNumber

writeNumber

writeNumber

writeNumber

writeNumber

writeBoolean

writeNull