Class Utf8Generator
- java.lang.Object
-
- org.codehaus.jackson.JsonGenerator
-
- org.codehaus.jackson.impl.JsonGeneratorBase
-
- org.codehaus.jackson.impl.Utf8Generator
-
- All Implemented Interfaces:
Closeable,AutoCloseable,Versioned
public class Utf8Generator extends JsonGeneratorBase
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.codehaus.jackson.JsonGenerator
JsonGenerator.Feature
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean_bufferRecyclableFlag that indicates whether the output buffer is recycable (and needs to be returned to recycler once we are done) or not.protected CharacterEscapes_characterEscapesDefinition of custom character escapes to use for generators created by this factory, if any.protected char[]_charBufferIntermediate buffer in which characters of a String are copied before being encoded.protected int_charBufferLengthLength of_charBufferprotected byte[]_entityBuffer6 character temporary buffer allocated if needed, for constructing escape sequencesprotected IOContext_ioContextprotected int_maximumNonEscapedCharValue between 128 (0x80) and 65535 (0xFFFF) that indicates highest Unicode code point that will not need escaping; or 0 to indicate that all characters can be represented without escaping.protected byte[]_outputBufferIntermediate buffer in which contents are buffered before being written using_outputStream.protected int_outputEndEnd marker of the output buffer; one past the last valid position within the buffer.protected int[]_outputEscapesCurrently active set of output escape code definitions (whether and how to escape or not) for 7-bit ASCII range (first 128 character codes).protected int_outputMaxContiguousMaximum number ofchars that we know will always fit in the output buffer after escapingprotected OutputStream_outputStreamUnderlying output stream used for writing JSON content.protected int_outputTailPointer to the position right beyond the last character to output (end marker; may be past the buffer)protected static int[]sOutputEscapesThis is the default set of escape codes, over 7-bit ASCII range (first 128 character codes), used for single-byte UTF-8 characters.protected static intSURR1_FIRSTprotected static intSURR1_LASTprotected static intSURR2_FIRSTprotected static intSURR2_LAST-
Fields inherited from class org.codehaus.jackson.impl.JsonGeneratorBase
_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext
-
Fields inherited from class org.codehaus.jackson.JsonGenerator
_cfgPrettyPrinter
-
-
Constructor Summary
Constructors Constructor Description Utf8Generator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out)Utf8Generator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected int_decodeSurrogate(int surr1, int surr2)protected void_flushBuffer()protected void_outputSurrogates(int surr1, int surr2)protected void_releaseBuffers()protected void_verifyPrettyValueWrite(String typeMsg, int status)protected void_verifyValueWrite(String typeMsg)protected void_writeBinary(Base64Variant b64variant, byte[] input, int inputPtr, int inputEnd)protected void_writeFieldName(String name)protected void_writeFieldName(SerializableString name)protected void_writePPFieldName(String name, boolean commaBefore)Specialized version of_writeFieldName, off-lined to keep the "fast path" as simple (and hopefully fast) as possible.protected void_writePPFieldName(SerializableString name, boolean commaBefore)voidclose()Method called to close this generator, so that no more content can be written.voidflush()Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.CharacterEscapesgetCharacterEscapes()Method for accessing custom escapes factory uses forJsonGenerators it creates.intgetHighestEscapedChar()Accessor method for testing what is the highest unescaped character configured for this generator.ObjectgetOutputTarget()Method that can be used to get access to object that is used as target for generated output; this is usually eitherOutputStreamorWriter, depending on what generator was constructed with.JsonGeneratorsetCharacterEscapes(CharacterEscapes esc)Method for defining custom escapes factory uses forJsonGenerators it creates.JsonGeneratorsetHighestNonEscapedChar(int charCode)Method that can be called to request that generator escapes all character codes above specified code point (if positive value); or, to not escape any characters except for ones that must be escaped for the data format (if -1).voidwriteBinary(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).voidwriteBoolean(boolean state)Method for outputting literal Json boolean value (one of Strings 'true' and 'false').voidwriteEndArray()Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).voidwriteEndObject()Method for writing closing marker of a JSON Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).voidwriteFieldName(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.voidwriteFieldName(SerializedString name)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.voidwriteFieldName(SerializableString name)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.voidwriteNull()Method for outputting literal Json null value.voidwriteNumber(double d)Method for outputting indicate Json numeric value.voidwriteNumber(float f)Method for outputting indicate Json numeric value.voidwriteNumber(int i)Method for outputting given value as Json number.voidwriteNumber(long l)Method for outputting given value as Json number.voidwriteNumber(String encodedValue)Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types.voidwriteNumber(BigDecimal value)Method for outputting indicate Json numeric value.voidwriteNumber(BigInteger value)Method for outputting given value as Json number.voidwriteRaw(char ch)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).voidwriteRaw(char[] cbuf, 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).voidwriteRaw(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).voidwriteRaw(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).voidwriteRawUTF8String(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).voidwriteStartArray()Method for writing starting marker of a JSON Array value (character '['; plus possible white space decoration if pretty-printing is enabled).voidwriteStartObject()Method for writing starting marker of a JSON Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).voidwriteString(char[] text, int offset, int len)Method for outputting a String value.voidwriteString(String text)Method for outputting a String value.voidwriteString(SerializableString text)Method similar toJsonGenerator.writeString(String), but that takesSerializableStringwhich can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.voidwriteStringField(String fieldName, String value)Convenience method for outputting a field entry ("member") that has a String value.voidwriteUTF8String(byte[] text, int offset, int len)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 org.codehaus.jackson.impl.JsonGeneratorBase
_cantHappen, _reportError, _reportUnsupportedOperation, _throwInternal, _writeEndArray, _writeEndObject, _writeSimpleObject, _writeStartArray, _writeStartObject, copyCurrentEvent, copyCurrentStructure, disable, enable, getCodec, getOutputContext, isClosed, isEnabled, setCodec, useDefaultPrettyPrinter, version, writeObject, writeRawValue, writeRawValue, writeRawValue, writeTree
-
Methods inherited from class org.codehaus.jackson.JsonGenerator
canUseSchema, configure, disableFeature, enableFeature, isFeatureEnabled, setFeature, setPrettyPrinter, setSchema, writeArrayFieldStart, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart
-
-
-
-
Field Detail
-
SURR1_FIRST
protected static final int SURR1_FIRST
- See Also:
- Constant Field Values
-
SURR1_LAST
protected static final int SURR1_LAST
- See Also:
- Constant Field Values
-
SURR2_FIRST
protected static final int SURR2_FIRST
- See Also:
- Constant Field Values
-
SURR2_LAST
protected static final int SURR2_LAST
- See Also:
- Constant Field Values
-
sOutputEscapes
protected static final int[] sOutputEscapes
This is the default set of escape codes, over 7-bit ASCII range (first 128 character codes), used for single-byte UTF-8 characters.
-
_ioContext
protected final IOContext _ioContext
-
_outputStream
protected final OutputStream _outputStream
Underlying output stream used for writing JSON content.
-
_outputEscapes
protected int[] _outputEscapes
Currently active set of output escape code definitions (whether and how to escape or not) for 7-bit ASCII range (first 128 character codes). Defined separately to make potentially customizable
-
_maximumNonEscapedChar
protected int _maximumNonEscapedChar
Value between 128 (0x80) and 65535 (0xFFFF) that indicates highest Unicode code point that will not need escaping; or 0 to indicate that all characters can be represented without escaping. Typically used to force escaping of some portion of character set; for example to always escape non-ASCII characters (if value was 127).NOTE: not all sub-classes make use of this setting.
-
_characterEscapes
protected CharacterEscapes _characterEscapes
Definition of custom character escapes to use for generators created by this factory, if any. If null, standard data format specific escapes are used.- Since:
- 1.8
-
_outputBuffer
protected byte[] _outputBuffer
Intermediate buffer in which contents are buffered before being written using_outputStream.
-
_outputTail
protected int _outputTail
Pointer to the position right beyond the last character to output (end marker; may be past the buffer)
-
_outputEnd
protected final int _outputEnd
End marker of the output buffer; one past the last valid position within the buffer.
-
_outputMaxContiguous
protected final int _outputMaxContiguous
Maximum number ofchars that we know will always fit in the output buffer after escaping
-
_charBuffer
protected char[] _charBuffer
Intermediate buffer in which characters of a String are copied before being encoded.
-
_charBufferLength
protected final int _charBufferLength
Length of_charBuffer
-
_entityBuffer
protected byte[] _entityBuffer
6 character temporary buffer allocated if needed, for constructing escape sequences
-
_bufferRecyclable
protected boolean _bufferRecyclable
Flag that indicates whether the output buffer is recycable (and needs to be returned to recycler once we are done) or not.
-
-
Constructor Detail
-
Utf8Generator
public Utf8Generator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out)
-
Utf8Generator
public Utf8Generator(IOContext ctxt, int features, ObjectCodec codec, OutputStream out, byte[] outputBuffer, int outputOffset, boolean bufferRecyclable)
-
-
Method Detail
-
setHighestNonEscapedChar
public JsonGenerator setHighestNonEscapedChar(int charCode)
Description copied from class:JsonGeneratorMethod that can be called to request that generator escapes all character codes above specified code point (if positive value); or, to not escape any characters except for ones that must be escaped for the data format (if -1). To force escaping of all non-ASCII characters, for example, this method would be called with value of 127.Note that generators are NOT required to support setting of value higher than 127, because there are other ways to affect quoting (or lack thereof) of character codes between 0 and 127. Not all generators support concept of escaping, either; if so, calling this method will have no effect.
Default implementation does nothing; sub-classes need to redefine it according to rules of supported data format.
- Overrides:
setHighestNonEscapedCharin classJsonGenerator- Parameters:
charCode- Either -1 to indicate that no additional escaping is to be done; or highest code point not to escape (meaning higher ones will be), if positive value.
-
getHighestEscapedChar
public int getHighestEscapedChar()
Description copied from class:JsonGeneratorAccessor method for testing what is the highest unescaped character configured for this generator. This may be either positive value (when escaping configuration has been set and is in effect), or 0 to indicate that no additional escaping is in effect. Some generators may not support additional escaping: for example, generators for binary formats that do not use escaping should simply return 0.- Overrides:
getHighestEscapedCharin classJsonGenerator- Returns:
- Currently active limitation for highest non-escaped character, if defined; or -1 to indicate no additional escaping is performed.
-
setCharacterEscapes
public JsonGenerator setCharacterEscapes(CharacterEscapes esc)
Description copied from class:JsonGeneratorMethod for defining custom escapes factory uses forJsonGenerators it creates.- Overrides:
setCharacterEscapesin classJsonGenerator
-
getCharacterEscapes
public CharacterEscapes getCharacterEscapes()
Method for accessing custom escapes factory uses forJsonGenerators it creates.- Overrides:
getCharacterEscapesin classJsonGenerator- Since:
- 1.8
-
getOutputTarget
public Object getOutputTarget()
Description copied from class:JsonGeneratorMethod that can be used to get access to object that is used as target for generated output; this is usually eitherOutputStreamorWriter, depending on what generator was constructed with. Note that returned value may be null in some cases; including case where implementation does not want to exposed raw source to caller. In cases where output has been decorated, object returned here is the decorated version; this allows some level of interaction between users of generator and decorator object.In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.
- Overrides:
getOutputTargetin classJsonGenerator
-
writeStringField
public final void writeStringField(String fieldName, String value) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorConvenience method for outputting a field entry ("member") that has a String value. Equivalent to:writeFieldName(fieldName); writeString(value);
Note: many performance-sensitive implementations override this method
- Overrides:
writeStringFieldin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeFieldName
public final void writeFieldName(String name) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod 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:
writeFieldNamein classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeFieldName
public final void writeFieldName(SerializedString name) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod similar toJsonGenerator.writeFieldName(String), main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.Default implementation simple uses unprocessed name container in serialized String; implementations are strongly encouraged to make use of more efficient methods argument object has.
- Overrides:
writeFieldNamein classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeFieldName
public final void writeFieldName(SerializableString name) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod similar toJsonGenerator.writeFieldName(String), main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.Default implementation simple uses unprocessed name container in serialized String; implementations are strongly encouraged to make use of more efficient methods argument object has.
- Overrides:
writeFieldNamein classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeStartArray
public final void writeStartArray() throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod for writing starting marker of a JSON Array value (character '['; plus possible white space decoration if pretty-printing is enabled).Array values can be written in any context where values are allowed: meaning everywhere except for when a field name is expected.
- Overrides:
writeStartArrayin classJsonGeneratorBase- Throws:
IOExceptionJsonGenerationException
-
writeEndArray
public final void writeEndArray() throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).Marker can be written if the innermost structured type is Array.
- Overrides:
writeEndArrayin classJsonGeneratorBase- Throws:
IOExceptionJsonGenerationException
-
writeStartObject
public final void writeStartObject() throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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.
- Overrides:
writeStartObjectin classJsonGeneratorBase- Throws:
IOExceptionJsonGenerationException
-
writeEndObject
public final void writeEndObject() throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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).
- Overrides:
writeEndObjectin classJsonGeneratorBase- Throws:
IOExceptionJsonGenerationException
-
_writeFieldName
protected final void _writeFieldName(String name) throws IOException, JsonGenerationException
- Throws:
IOExceptionJsonGenerationException
-
_writeFieldName
protected final void _writeFieldName(SerializableString name) throws IOException, JsonGenerationException
- Throws:
IOExceptionJsonGenerationException
-
_writePPFieldName
protected final void _writePPFieldName(String name, boolean commaBefore) throws IOException, JsonGenerationException
Specialized version of_writeFieldName, off-lined to keep the "fast path" as simple (and hopefully fast) as possible.- Throws:
IOExceptionJsonGenerationException
-
_writePPFieldName
protected final void _writePPFieldName(SerializableString name, boolean commaBefore) throws IOException, JsonGenerationException
- Throws:
IOExceptionJsonGenerationException
-
writeString
public void writeString(String text) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod 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:
writeStringin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeString
public void writeString(char[] text, int offset, int len) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeStringin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeString
public final void writeString(SerializableString text) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod similar toJsonGenerator.writeString(String), but that takesSerializableStringwhich can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.Default implementation just calls
JsonGenerator.writeString(String); sub-classes should override it with more efficient implementation if possible.- Overrides:
writeStringin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeRawUTF8String
public void writeRawUTF8String(byte[] text, int offset, int length) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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
Writerusing this method would require UTF-8 decoding. If so, implementation may instead choose to throw aUnsupportedOperationExceptiondue to ineffectiveness of having to decode input.- Specified by:
writeRawUTF8Stringin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeUTF8String
public void writeUTF8String(byte[] text, int offset, int len) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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
Writerusing this method would require UTF-8 decoding. In this case generator implementation may instead choose to throw aUnsupportedOperationExceptiondue to ineffectiveness of having to decode input.- Specified by:
writeUTF8Stringin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeRaw
public void writeRaw(String text) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeRaw
public void writeRaw(String text, int offset, int len) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeRaw
public final void writeRaw(char[] cbuf, int offset, int len) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeRaw
public void writeRaw(char ch) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeRawin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeBinary
public void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod 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
JsonParserimplementations are required to accept such "long line base64"; as do typical production-level base64 decoders.- Specified by:
writeBinaryin 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.- Throws:
IOExceptionJsonGenerationException
-
writeNumber
public void writeNumber(int i) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeNumber
public void writeNumber(long l) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeNumber
public void writeNumber(BigInteger value) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeNumber
public void writeNumber(double d) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeNumber
public void writeNumber(float f) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeNumber
public void writeNumber(BigDecimal value) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorMethod 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:
writeNumberin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeNumber
public void writeNumber(String encodedValue) throws IOException, JsonGenerationException
Description copied from class:JsonGeneratorWrite 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:
writeNumberin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeBoolean
public void writeBoolean(boolean state) throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeBooleanin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
writeNull
public void writeNull() throws IOException, JsonGenerationExceptionDescription copied from class:JsonGeneratorMethod 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:
writeNullin classJsonGenerator- Throws:
IOExceptionJsonGenerationException
-
_verifyValueWrite
protected final void _verifyValueWrite(String typeMsg) throws IOException, JsonGenerationException
- Specified by:
_verifyValueWritein classJsonGeneratorBase- Throws:
IOExceptionJsonGenerationException
-
_verifyPrettyValueWrite
protected final void _verifyPrettyValueWrite(String typeMsg, int status) throws IOException, JsonGenerationException
- Throws:
IOExceptionJsonGenerationException
-
flush
public final void flush() throws IOExceptionDescription copied from class:JsonGeneratorMethod called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.- Specified by:
flushin classJsonGeneratorBase- Throws:
IOException
-
close
public void close() throws IOExceptionDescription copied from class:JsonGeneratorMethod 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_TARGETenabled. If either of above is true, the target is also closed. Otherwise (not managing, feature not enabled), target is not closed.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classJsonGeneratorBase- Throws:
IOException
-
_releaseBuffers
protected void _releaseBuffers()
- Specified by:
_releaseBuffersin classJsonGeneratorBase
-
_writeBinary
protected void _writeBinary(Base64Variant b64variant, byte[] input, int inputPtr, int inputEnd) throws IOException, JsonGenerationException
- Throws:
IOExceptionJsonGenerationException
-
_outputSurrogates
protected final void _outputSurrogates(int surr1, int surr2) throws IOException- Throws:
IOException
-
_decodeSurrogate
protected final int _decodeSurrogate(int surr1, int surr2) throws IOException- Throws:
IOException
-
_flushBuffer
protected final void _flushBuffer() throws IOException- Throws:
IOException
-
-