org.hotwheel.json.impl.jackson

类 GeneratorBase

java.lang.Object

org.hotwheel.json.impl.jackson.JsonGenerator

org.hotwheel.json.impl.jackson.GeneratorBase

所有已实现的接口:

Closeable, AutoCloseable, Versioned

直接已知子类:

UTF8JsonGenerator, WriterBasedJsonGenerator

public abstract class GeneratorBase
extends JsonGenerator

This base class implements part of API that a JSON generator exposes to applications, adds shared internal methods that sub-classes can use and adds some abstract methods sub-classes must implement.

嵌套类概要

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

JsonGenerator.Feature

方法概要

限定符和类型	方法和说明
void	close() Method called to close this generator, so that no more content can be written.
void	copyCurrentEvent(JacksonParser jp) Method for copying contents of the current event that the given parser instance points to.
void	copyCurrentStructure(JacksonParser jp) Method for copying contents of the current event and following events that it encloses the given parser instance points to.
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.
abstract 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)).
JsonWriteContext	getOutputContext() Note: co-variant return type.
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.
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	useDefaultPrettyPrinter() Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter).
Version	version() Implemented with detection that tries to find "VERSION.txt" in same package as the implementation class.
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	writeObject(Object value) Method for writing given Java object (POJO) as 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	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	writeTree(TreeNode rootNode) Method for writing given JSON tree (expressed as a tree where given JsonNode is the root) using this generator.

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

canUseSchema, configure, getCharacterEscapes, getHighestEscapedChar, getOutputTarget, getSchema, setCharacterEscapes, setHighestNonEscapedChar, setPrettyPrinter, setSchema, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBoolean, writeBooleanField, writeEndArray, writeEndObject, writeFieldName, writeNull, writeNullField, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeRaw, writeRaw, writeRaw, writeRaw, writeRawUTF8String, writeStartArray, writeStartObject, writeString, writeString, writeStringField, writeUTF8String

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

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

方法详细资料

version

public Version version()

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

指定者:

version 在接口中 Versioned

指定者:

version 在类中 JsonGenerator

enable

public JsonGenerator enable(JsonGenerator.Feature f)

从类复制的说明: JsonGenerator

Method for enabling specified parser features: check JsonGenerator.Feature for list of available features.

指定者:

enable 在类中 JsonGenerator

返回:

Generator itself (this), to allow chaining

disable

public JsonGenerator disable(JsonGenerator.Feature f)

从类复制的说明: JsonGenerator

Method for disabling specified features (check JsonGenerator.Feature for list of features)

指定者:

disable 在类中 JsonGenerator

返回:

Generator itself (this), to allow chaining

isEnabled

public final boolean isEnabled(JsonGenerator.Feature f)

从类复制的说明: JsonGenerator

Method for checking whether given feature is enabled. Check JsonGenerator.Feature for list of available features.

指定者:

isEnabled 在类中 JsonGenerator

useDefaultPrettyPrinter

public JsonGenerator useDefaultPrettyPrinter()

从类复制的说明: JsonGenerator

Convenience method for enabling pretty-printing using the default pretty printer (DefaultPrettyPrinter).

指定者:

useDefaultPrettyPrinter 在类中 JsonGenerator

返回:

Generator itself (this), to allow chaining

setCodec

public JsonGenerator setCodec(ObjectCodec oc)

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

指定者:

setCodec 在类中 JsonGenerator

返回:

Generator itself (this), to allow chaining

getCodec

public final ObjectCodec getCodec()

从类复制的说明: JsonGenerator

Method for accessing the object used for writing Java object as Json content (using method JsonGenerator.writeObject(java.lang.Object)).

指定者:

getCodec 在类中 JsonGenerator

getOutputContext

public final JsonWriteContext getOutputContext()

Note: co-variant return type.

指定者:

getOutputContext 在类中 JsonGenerator

返回:

Context object that can give information about logical position within generated json content.

writeFieldName

public 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 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeString

public void writeString(SerializableString text)
                 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 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeRawValue

public void writeRawValue(String text)
                   throws IOException,
                          JsonGenerationException

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

指定者:

writeRawValue 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeRawValue

public void writeRawValue(String text,
                          int offset,
                          int len)
                   throws IOException,
                          JsonGenerationException

指定者:

writeRawValue 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeRawValue

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

指定者:

writeRawValue 在类中 JsonGenerator

抛出:

IOException

JsonGenerationException

writeObject

public void writeObject(Object value)
                 throws IOException,
                        JsonProcessingException

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

指定者:

writeObject 在类中 JsonGenerator

抛出:

IOException

JsonProcessingException

writeTree

public void writeTree(TreeNode rootNode)
               throws IOException,
                      JsonProcessingException

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

指定者:

writeTree 在类中 JsonGenerator

抛出:

IOException

JsonProcessingException

flush

public abstract 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 在类中 JsonGenerator

抛出:

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 在类中 JsonGenerator

抛出:

IOException

isClosed

public boolean isClosed()

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

指定者:

isClosed 在类中 JsonGenerator

copyCurrentEvent

public final void copyCurrentEvent(JacksonParser jp)
                            throws IOException,
                                   JsonProcessingException

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

指定者:

copyCurrentEvent 在类中 JsonGenerator

抛出:

IOException

JsonProcessingException

copyCurrentStructure

public final void copyCurrentStructure(JacksonParser jp)
                                throws IOException,
                                       JsonProcessingException

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

指定者:

copyCurrentStructure 在类中 JsonGenerator

抛出:

IOException

JsonProcessingException