org.hotwheel.json.impl.jackson

类 WriterBasedJsonGenerator

java.lang.Object

org.hotwheel.json.impl.jackson.JsonGenerator

org.hotwheel.json.impl.jackson.GeneratorBase

org.hotwheel.json.impl.jackson.WriterBasedJsonGenerator

所有已实现的接口:

Closeable, AutoCloseable, Versioned

public final class WriterBasedJsonGenerator
extends GeneratorBase

JsonGenerator that outputs JSON content using a Writer which handles character encoding.

嵌套类概要

从类继承的嵌套类/接口 org.hotwheel.json.impl.jackson.JsonGenerator

JsonGenerator.Feature

构造器概要

构造器

构造器和说明
WriterBasedJsonGenerator(IOContext ctxt, int features, ObjectCodec codec, Writer w)

方法概要

限定符和类型	方法和说明
void	_writeFieldName(SerializableString name, boolean commaBefore)
void	close() Method called to close this generator, so that no more content can be written.
void	flush() Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
CharacterEscapes	getCharacterEscapes() Method for accessing custom escapes factory uses for JsonGenerators it creates.
int	getHighestEscapedChar() Accessor method for testing what is the highest unescaped character configured for this generator.
Object	getOutputTarget() Method that can be used to get access to object that is used as target for generated output; this is usually either OutputStream or Writer, depending on what generator was constructed with.
JsonGenerator	setCharacterEscapes(CharacterEscapes esc) Method for defining custom escapes factory uses for JsonGenerators it creates.
JsonGenerator	setHighestNonEscapedChar(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).
Version	version() Implemented with detection that tries to find "VERSION.txt" in same package as the implementation class.
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).
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 value) Method for outputting indicate Json numeric value.
void	writeNumber(BigInteger value) 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(String encodedValue) Write method that can be used for custom numeric types that can not be (easily?)
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(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 start, 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	writeStartArray() Method for writing starting marker of a JSON Array value (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 sstr) 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	writeStringField(String fieldName, String value) Convenience method for outputting a field entry ("member") that has a String value.
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).

从类继承的方法 org.hotwheel.json.impl.jackson.GeneratorBase

copyCurrentEvent, copyCurrentStructure, disable, enable, getCodec, getOutputContext, isClosed, isEnabled, setCodec, useDefaultPrettyPrinter, writeObject, writeRawValue, writeRawValue, writeRawValue, writeTree

从类继承的方法 org.hotwheel.json.impl.jackson.JsonGenerator

canUseSchema, configure, getSchema, setPrettyPrinter, setSchema, writeArrayFieldStart, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

WriterBasedJsonGenerator

public WriterBasedJsonGenerator(IOContext ctxt,
                                int features,
                                ObjectCodec codec,
                                Writer w)

方法详细资料

version

public Version version()

从类复制的说明: GeneratorBase

Implemented with detection that tries to find "VERSION.txt" in same package as the implementation class.

指定者:

version 在接口中 Versioned

覆盖:

version 在类中 GeneratorBase

setHighestNonEscapedChar

public JsonGenerator setHighestNonEscapedChar(int charCode)

从类复制的说明: JsonGenerator

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

覆盖:

setHighestNonEscapedChar 在类中 JsonGenerator

参数:

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()

从类复制的说明: JsonGenerator

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

覆盖:

getHighestEscapedChar 在类中 JsonGenerator

返回:

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)

从类复制的说明: JsonGenerator

Method for defining custom escapes factory uses for JsonGenerators it creates.

覆盖:

setCharacterEscapes 在类中 JsonGenerator

getCharacterEscapes

public CharacterEscapes getCharacterEscapes()

Method for accessing custom escapes factory uses for JsonGenerators it creates.

覆盖:

getCharacterEscapes 在类中 JsonGenerator

getOutputTarget

public Object getOutputTarget()

从类复制的说明: JsonGenerator

Method that can be used to get access to object that is used as target for generated output; this is usually either OutputStream or Writer, 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.

覆盖:

getOutputTarget 在类中 JsonGenerator

writeFieldName

public final void writeFieldName(String name)
                          throws IOException,
                                 JsonGenerationException

从类复制的说明: 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).

指定者:

writeFieldName 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeStringField

public final void writeStringField(String fieldName,
                                   String value)
                            throws IOException,
                                   JsonGenerationException

从类复制的说明: JsonGenerator

Convenience 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

覆盖:

writeStringField 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeFieldName

public final void writeFieldName(SerializableString name)
                          throws IOException,
                                 JsonGenerationException

从类复制的说明: 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.

覆盖:

writeFieldName 在类中 GeneratorBase

抛出:

IOException

JsonGenerationException

writeStartArray

public final void writeStartArray()
                           throws IOException,
                                  JsonGenerationException

从类复制的说明: JsonGenerator

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

指定者:

writeStartArray 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeEndArray

public final void writeEndArray()
                         throws IOException,
                                JsonGenerationException

从类复制的说明: 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.

指定者:

writeEndArray 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeStartObject

public final void writeStartObject()
                            throws IOException,
                                   JsonGenerationException

从类复制的说明: 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.

指定者:

writeStartObject 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeEndObject

public final void writeEndObject()
                          throws IOException,
                                 JsonGenerationException

从类复制的说明: 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).

指定者:

writeEndObject 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

_writeFieldName

public void _writeFieldName(SerializableString name,
                            boolean commaBefore)
                     throws IOException,
                            JsonGenerationException

抛出:

IOException

JsonGenerationException

writeString

public void writeString(String text)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeString 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeString

public void writeString(char[] text,
                        int offset,
                        int len)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeString 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeString

public final void writeString(SerializableString sstr)
                       throws IOException,
                              JsonGenerationException

从类复制的说明: 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.

覆盖:

writeString 在类中 GeneratorBase

抛出:

IOException

JsonGenerationException

writeRawUTF8String

public void writeRawUTF8String(byte[] text,
                               int offset,
                               int length)
                        throws IOException,
                               JsonGenerationException

从类复制的说明: 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.

指定者:

writeRawUTF8String 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeUTF8String

public void writeUTF8String(byte[] text,
                            int offset,
                            int length)
                     throws IOException,
                            JsonGenerationException

从类复制的说明: 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.

指定者:

writeUTF8String 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeRaw

public void writeRaw(String text)
              throws IOException,
                     JsonGenerationException

从类复制的说明: 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.

指定者:

writeRaw 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeRaw

public void writeRaw(String text,
                     int start,
                     int len)
              throws IOException,
                     JsonGenerationException

从类复制的说明: 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.

指定者:

writeRaw 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeRaw

public void writeRaw(char[] text,
                     int offset,
                     int len)
              throws IOException,
                     JsonGenerationException

从类复制的说明: 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.

指定者:

writeRaw 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeRaw

public void writeRaw(char c)
              throws IOException,
                     JsonGenerationException

从类复制的说明: 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.

指定者:

writeRaw 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeBinary

public void writeBinary(Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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 JacksonParser implementations are required to accept such "long line base64"; as do typical production-level base64 decoders.

指定者:

writeBinary 在类中 JsonGenerator

参数:

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.

抛出:

IOException

JsonGenerationException

writeNumber

public void writeNumber(int i)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeNumber 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeNumber

public void writeNumber(long l)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeNumber 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeNumber

public void writeNumber(BigInteger value)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeNumber 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeNumber

public void writeNumber(double d)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeNumber 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeNumber

public void writeNumber(float f)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeNumber 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeNumber

public void writeNumber(BigDecimal value)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeNumber 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeNumber

public void writeNumber(String encodedValue)
                 throws IOException,
                        JsonGenerationException

从类复制的说明: 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.

指定者:

writeNumber 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeBoolean

public void writeBoolean(boolean state)
                  throws IOException,
                         JsonGenerationException

从类复制的说明: 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.

指定者:

writeBoolean 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeNull

public void writeNull()
               throws IOException,
                      JsonGenerationException

从类复制的说明: 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.

指定者:

writeNull 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

flush

public final void flush()
                 throws IOException

从类复制的说明: JsonGenerator

Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.

指定者:

flush 在类中 GeneratorBase

抛出:

IOException

close

public void close()
           throws IOException

从类复制的说明: 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.

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

覆盖:

close 在类中 GeneratorBase

抛出:

IOException