org.hotwheel.json.impl.jackson

类 ParserMinimalBase

java.lang.Object

org.hotwheel.json.impl.jackson.JacksonParser

org.hotwheel.json.impl.jackson.ParserMinimalBase

所有已实现的接口:

Closeable, AutoCloseable, Versioned

直接已知子类:

ParserBase

public abstract class ParserMinimalBase
extends JacksonParser

Intermediate base class used by all Jackson JacksonParser implementations, but does not add any additional fields that depend on particular method of obtaining input.

Note that 'minimal' here mostly refers to minimal number of fields (size) and functionality that is specific to certain types of parser implementations; but not necessarily to number of methods.

作者:

Tatu Saloranta

嵌套类概要

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

JacksonParser.Feature, JacksonParser.NumberType

方法概要

限定符和类型	方法和说明
void	clearCurrentToken() Method called to "consume" the current token by effectively removing it so that JacksonParser.hasCurrentToken() returns false, and JacksonParser.getCurrentToken() null).
abstract void	close() Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature JacksonParser.Feature.AUTO_CLOSE_SOURCE is enabled.
abstract byte[]	getBinaryValue(Base64Variant b64variant) Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value.
abstract String	getCurrentName() Method that can be called to get the name associated with the current token: for JsonToken.FIELD_NAMEs it will be the same as what JacksonParser.getText() returns; for field values it will be preceding field name; and for others (array values, root-level values) null.
JsonToken	getCurrentToken() Accessor to find which token parser currently points to, if any; null will be returned if none.
JsonToken	getLastClearedToken() Method that can be called to get the last token that was cleared using JacksonParser.clearCurrentToken().
abstract JsonStreamContext	getParsingContext() Method that can be used to access current parsing context reader is in.
abstract String	getText() Method for accessing textual representation of the current token; if no current token (before first call to JacksonParser.nextToken(), or after encountering end-of-input), returns null.
abstract char[]	getTextCharacters() Method similar to JacksonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.
abstract int	getTextLength() Accessor used with JacksonParser.getTextCharacters(), to know length of String stored in returned buffer.
abstract int	getTextOffset() Accessor used with JacksonParser.getTextCharacters(), to know offset of the first text content character within buffer.
boolean	getValueAsBoolean(boolean defaultValue) Method that will try to convert value of current token to a boolean.
double	getValueAsDouble(double defaultValue) Method that will try to convert value of current token to a Java double.
int	getValueAsInt(int defaultValue) Method that will try to convert value of current token to a int.
long	getValueAsLong(long defaultValue) Method that will try to convert value of current token to a long.
boolean	hasCurrentToken() Method for checking whether parser currently points to a token (and data for that token is available).
abstract boolean	hasTextCharacters() Method that can be used to determine whether calling of JacksonParser.getTextCharacters() would be the most efficient way to access textual content for the event parser currently points to.
abstract boolean	isClosed() Method that can be called to determine whether this parser is closed or not.
abstract JsonToken	nextToken() Main iteration method, which will advance stream enough to determine type of the next token, if any.
JsonToken	nextValue() Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers).
abstract void	overrideCurrentName(String name) Method that can be used to change what is considered to be the current (field) name.
JacksonParser	skipChildren() Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to JsonToken.START_OBJECT or JsonToken.START_ARRAY.
Version	version() Accessor for getting version of the core package, given a parser instance.

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

canUseSchema, configure, disable, enable, getBigIntegerValue, getBinaryValue, getBooleanValue, getByteValue, getCodec, getCurrentLocation, getDecimalValue, getDoubleValue, getEmbeddedObject, getFloatValue, getInputSource, getIntValue, getLongValue, getNumberType, getNumberValue, getSchema, getShortValue, getTokenLocation, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, isEnabled, isExpectedStartArrayToken, nextBooleanValue, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setCodec, setSchema

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

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

方法详细资料

version

public Version version()

从类复制的说明: JacksonParser

Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.

指定者:

version 在接口中 Versioned

指定者:

version 在类中 JacksonParser

nextToken

public abstract JsonToken nextToken()
                             throws IOException,
                                    JsonParseException

从类复制的说明: JacksonParser

Main iteration method, which will advance stream enough to determine type of the next token, if any. If none remaining (stream has no content other than possible white space before ending), null will be returned.

指定者:

nextToken 在类中 JacksonParser

返回:

Next token from the stream, if any found, or null to indicate end-of-input

抛出:

IOException

JsonParseException

getCurrentToken

public JsonToken getCurrentToken()

从类复制的说明: JacksonParser

Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.

指定者:

getCurrentToken 在类中 JacksonParser

返回:

Type of the token this parser currently points to, if any: null before any tokens have been read, and after end-of-input has been encountered, as well as if the current token has been explicitly cleared.

hasCurrentToken

public boolean hasCurrentToken()

从类复制的说明: JacksonParser

Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check for parser.getCurrentToken() != null.

指定者:

hasCurrentToken 在类中 JacksonParser

返回:

True if the parser just returned a valid token via JacksonParser.nextToken(); false otherwise (parser was just constructed, encountered end-of-input and returned null from JacksonParser.nextToken(), or the token has been consumed)

nextValue

public JsonToken nextValue()
                    throws IOException,
                           JsonParseException

从类复制的说明: JacksonParser

Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers). Or put another way, nextToken() will be called once, and if JsonToken.FIELD_NAME is returned, another time to get the value for the field. Method is most useful for iterating over value entries of JSON objects; field name will still be available by calling JacksonParser.getCurrentName() when parser points to the value.

指定者:

nextValue 在类中 JacksonParser

返回:

Next non-field-name token from the stream, if any found, or null to indicate end-of-input (or, for non-blocking parsers, JsonToken.NOT_AVAILABLE if no tokens were available yet)

抛出:

IOException

JsonParseException

skipChildren

public JacksonParser skipChildren()
                           throws IOException,
                                  JsonParseException

从类复制的说明: JacksonParser

Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to JsonToken.START_OBJECT or JsonToken.START_ARRAY. If not, it will do nothing. After skipping, stream will point to matching JsonToken.END_OBJECT or JsonToken.END_ARRAY (possibly skipping nested pairs of START/END OBJECT/ARRAY tokens as well as value tokens). The idea is that after calling this method, application will call JacksonParser.nextToken() to point to the next available token, if any.

指定者:

skipChildren 在类中 JacksonParser

抛出:

IOException

JsonParseException

getCurrentName

public abstract String getCurrentName()
                               throws IOException,
                                      JsonParseException

从类复制的说明: JacksonParser

Method that can be called to get the name associated with the current token: for JsonToken.FIELD_NAMEs it will be the same as what JacksonParser.getText() returns; for field values it will be preceding field name; and for others (array values, root-level values) null.

指定者:

getCurrentName 在类中 JacksonParser

抛出:

IOException

JsonParseException

close

public abstract void close()
                    throws IOException

从类复制的说明: JacksonParser

Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature JacksonParser.Feature.AUTO_CLOSE_SOURCE is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so check JsonFactory for details, but the general idea is that if caller passes in closable resource (such as InputStream or Reader) parser does NOT own the source; but if it passes a reference (such as File or URL and creates stream or reader it does own them.

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在类中 JacksonParser

抛出:

IOException

isClosed

public abstract boolean isClosed()

从类复制的说明: JacksonParser

Method that can be called to determine whether this parser is closed or not. If it is closed, no new tokens can be retrieved by calling JacksonParser.nextToken() (and the underlying stream may be closed). Closing may be due to an explicit call to JacksonParser.close() or because parser has encountered end of input.

指定者:

isClosed 在类中 JacksonParser

getParsingContext

public abstract JsonStreamContext getParsingContext()

从类复制的说明: JacksonParser

Method that can be used to access current parsing context reader is in. There are 3 different types: root, array and object contexts, with slightly different available information. Contexts are hierarchically nested, and can be used for example for figuring out part of the input document that correspond to specific array or object (for highlighting purposes, or error reporting). Contexts can also be used for simple xpath-like matching of input, if so desired.

指定者:

getParsingContext 在类中 JacksonParser

clearCurrentToken

public void clearCurrentToken()

从类复制的说明: JacksonParser

Method called to "consume" the current token by effectively removing it so that JacksonParser.hasCurrentToken() returns false, and JacksonParser.getCurrentToken() null). Cleared token value can still be accessed by calling JacksonParser.getLastClearedToken() (if absolutely needed), but usually isn't.

Method was added to be used by the optional data binder, since it has to be able to consume last token used for binding (so that it will not be used again).

指定者:

clearCurrentToken 在类中 JacksonParser

getLastClearedToken

public JsonToken getLastClearedToken()

从类复制的说明: JacksonParser

Method that can be called to get the last token that was cleared using JacksonParser.clearCurrentToken(). This is not necessarily the latest token read. Will return null if no tokens have been cleared, or if parser has been closed.

指定者:

getLastClearedToken 在类中 JacksonParser

overrideCurrentName

public abstract void overrideCurrentName(String name)

从类复制的说明: JacksonParser

Method that can be used to change what is considered to be the current (field) name. May be needed to support non-JSON data formats or unusual binding conventions; not needed for typical processing.

Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.

指定者:

overrideCurrentName 在类中 JacksonParser

参数:

name - Name to use as the current name; may be null.

getText

public abstract String getText()
                        throws IOException,
                               JsonParseException

从类复制的说明: JacksonParser

Method for accessing textual representation of the current token; if no current token (before first call to JacksonParser.nextToken(), or after encountering end-of-input), returns null. Method can be called for any token type.

指定者:

getText 在类中 JacksonParser

抛出:

IOException

JsonParseException

getTextCharacters

public abstract char[] getTextCharacters()
                                  throws IOException,
                                         JsonParseException

从类复制的说明: JacksonParser

Method similar to JacksonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:

• Textual contents are not guaranteed to start at index 0 (rather, call JacksonParser.getTextOffset()) to know the actual offset
• Length of textual contents may be less than the length of returned buffer: call JacksonParser.getTextLength() for actual length of returned content.

Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.

The only reason to call this method (over JacksonParser.getText()) is to avoid construction of a String object (which will make a copy of contents).

指定者:

getTextCharacters 在类中 JacksonParser

抛出:

IOException

JsonParseException

hasTextCharacters

public abstract boolean hasTextCharacters()

从类复制的说明: JacksonParser

Method that can be used to determine whether calling of JacksonParser.getTextCharacters() would be the most efficient way to access textual content for the event parser currently points to.

Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.

指定者:

hasTextCharacters 在类中 JacksonParser

返回:

True if parser currently has character array that can be efficiently returned via JacksonParser.getTextCharacters(); false means that it may or may not exist

getTextLength

public abstract int getTextLength()
                           throws IOException,
                                  JsonParseException

从类复制的说明: JacksonParser

Accessor used with JacksonParser.getTextCharacters(), to know length of String stored in returned buffer.

指定者:

getTextLength 在类中 JacksonParser

返回:

Number of characters within buffer returned by JacksonParser.getTextCharacters() that are part of textual content of the current token.

抛出:

IOException

JsonParseException

getTextOffset

public abstract int getTextOffset()
                           throws IOException,
                                  JsonParseException

从类复制的说明: JacksonParser

Accessor used with JacksonParser.getTextCharacters(), to know offset of the first text content character within buffer.

指定者:

getTextOffset 在类中 JacksonParser

返回:

Offset of the first character within buffer returned by JacksonParser.getTextCharacters() that is part of textual content of the current token.

抛出:

IOException

JsonParseException

getBinaryValue

public abstract byte[] getBinaryValue(Base64Variant b64variant)
                               throws IOException,
                                      JsonParseException

从类复制的说明: JacksonParser

Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value. It works similar to getting String value via JacksonParser.getText() and decoding result (except for decoding part), but should be significantly more performant.

Note that non-decoded textual contents of the current token are not guaranteed to be accessible after this method is called. Current implementation, for example, clears up textual content during decoding. Decoded binary content, however, will be retained until parser is advanced to the next event.

指定者:

getBinaryValue 在类中 JacksonParser

参数:

b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).

返回:

Decoded binary data

抛出:

IOException

JsonParseException

getValueAsBoolean

public boolean getValueAsBoolean(boolean defaultValue)
                          throws IOException,
                                 JsonParseException

从类复制的说明: JacksonParser

Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.

If representation can not be converted to a boolean value (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

覆盖:

getValueAsBoolean 在类中 JacksonParser

抛出:

IOException

JsonParseException

getValueAsInt

public int getValueAsInt(int defaultValue)
                  throws IOException,
                         JsonParseException

从类复制的说明: JacksonParser

Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

If representation can not be converted to an int (including structured type markers like start/end Object/Array) specified defaultValue will be returned; no exceptions are thrown.

覆盖:

getValueAsInt 在类中 JacksonParser

抛出:

IOException

JsonParseException

getValueAsLong

public long getValueAsLong(long defaultValue)
                    throws IOException,
                           JsonParseException

从类复制的说明: JacksonParser

Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

If representation can not be converted to an int (including structured type markers like start/end Object/Array) specified defaultValue will be returned; no exceptions are thrown.

覆盖:

getValueAsLong 在类中 JacksonParser

抛出:

IOException

JsonParseException

getValueAsDouble

public double getValueAsDouble(double defaultValue)
                        throws IOException,
                               JsonParseException

从类复制的说明: JacksonParser

Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language integer parsing rules.

If representation can not be converted to an int (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

覆盖:

getValueAsDouble 在类中 JacksonParser

抛出:

IOException

JsonParseException