org.codehaus.jackson.util

类 JsonParserDelegate

java.lang.Object

org.codehaus.jackson.JsonParser

org.codehaus.jackson.util.JsonParserDelegate

所有已实现的接口:

Closeable, AutoCloseable, Versioned

直接已知子类:

JsonParserSequence

public class JsonParserDelegate
extends JsonParser

Helper class that implements delegation pattern for JsonParser, to allow for simple overridability of basic parsing functionality. The idea is that any functionality to be modified can be simply overridden; and anything else will be delegated by default.

从以下版本开始:

1.4

嵌套类概要

从类继承的嵌套类/接口 org.codehaus.jackson.JsonParser

JsonParser.Feature, JsonParser.NumberType

字段概要

字段

限定符和类型	字段和说明
protected JsonParser	delegate Delegate object that method calls are delegated to.

从类继承的字段 org.codehaus.jackson.JsonParser

_currToken, _features, _lastClearedToken

构造器概要

构造器

构造器和说明
JsonParserDelegate(JsonParser d)

方法概要

方法

限定符和类型	方法和说明
boolean	canUseSchema(FormatSchema schema) Method that can be used to verify that given schema can be used with this parser (using JsonParser.setSchema(org.codehaus.jackson.FormatSchema)).
void	clearCurrentToken() Method called to "consume" the current token by effectively removing it so that JsonParser.hasCurrentToken() returns false, and JsonParser.getCurrentToken() null).
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 JsonParser.Feature.AUTO_CLOSE_SOURCE is enabled.
JsonParser	disable(JsonParser.Feature f) Method for disabling specified feature (check JsonParser.Feature for list of features)
JsonParser	enable(JsonParser.Feature f) Method for enabling specified parser feature (check JsonParser.Feature for list of features)
BigInteger	getBigIntegerValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can not be used as a Java long primitive type due to its magnitude.
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.
boolean	getBooleanValue() Convenience accessor that can be called when the current token is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE.
byte	getByteValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a value of Java byte primitive type.
ObjectCodec	getCodec() Accessor for ObjectCodec associated with this parser, if any.
JsonLocation	getCurrentLocation() Method that returns location of the last processed character; usually for error reporting purposes.
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 JsonParser.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.
BigDecimal	getDecimalValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT or JsonToken.VALUE_NUMBER_INT.
double	getDoubleValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT and it can be expressed as a Java double primitive type.
Object	getEmbeddedObject() Accessor that can be called if (and only if) the current token is JsonToken.VALUE_EMBEDDED_OBJECT.
float	getFloatValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT and it can be expressed as a Java float primitive type.
Object	getInputSource() Method that can be used to get access to object that is used to access input being parsed; this is usually either InputStream or Reader, depending on what parser was constructed with.
int	getIntValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a value of Java int primitive type.
JsonToken	getLastClearedToken() Method that can be called to get the last token that was cleared using JsonParser.clearCurrentToken().
long	getLongValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a Java long primitive type.
JsonParser.NumberType	getNumberType() If current token is of type JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberType constants; otherwise returns null.
Number	getNumberValue() Generic number value accessor method that will work for all kinds of numeric values.
JsonStreamContext	getParsingContext() Method that can be used to access current parsing context reader is in.
short	getShortValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a value of Java short primitive type.
String	getText() Method for accessing textual representation of the current token; if no current token (before first call to JsonParser.nextToken(), or after encountering end-of-input), returns null.
char[]	getTextCharacters() Method similar to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.
int	getTextLength() Accessor used with JsonParser.getTextCharacters(), to know length of String stored in returned buffer.
int	getTextOffset() Accessor used with JsonParser.getTextCharacters(), to know offset of the first text content character within buffer.
JsonLocation	getTokenLocation() Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.
boolean	hasCurrentToken() Method for checking whether parser currently points to a token (and data for that token is available).
boolean	isClosed() Method that can be called to determine whether this parser is closed or not.
boolean	isEnabled(JsonParser.Feature f) Method for checking whether specified JsonParser.Feature is enabled.
JsonToken	nextToken() Main iteration method, which will advance stream enough to determine type of the next token, if any.
void	setCodec(ObjectCodec c) Setter that allows defining ObjectCodec associated with this parser, if any.
void	setSchema(FormatSchema schema) Method to call to make this parser use specified schema.
JsonParser	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() Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).

从类继承的方法 org.codehaus.jackson.JsonParser

_constructError, configure, disableFeature, enableFeature, getBinaryValue, getValueAsBoolean, getValueAsBoolean, getValueAsDouble, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, hasTextCharacters, isExpectedStartArrayToken, isFeatureEnabled, nextBooleanValue, nextFieldName, nextIntValue, nextLongValue, nextTextValue, nextValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setFeature

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

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

字段详细资料

delegate

protected JsonParser delegate

Delegate object that method calls are delegated to.

构造器详细资料

JsonParserDelegate

public JsonParserDelegate(JsonParser d)

方法详细资料

setCodec

public void setCodec(ObjectCodec c)

从类复制的说明: JsonParser

Setter that allows defining ObjectCodec associated with this parser, if any. Codec is used by JsonParser.readValueAs(Class) method (and its variants).

指定者:

setCodec 在类中 JsonParser

getCodec

public ObjectCodec getCodec()

从类复制的说明: JsonParser

Accessor for ObjectCodec associated with this parser, if any. Codec is used by JsonParser.readValueAs(Class) method (and its variants).

指定者:

getCodec 在类中 JsonParser

enable

public JsonParser enable(JsonParser.Feature f)

从类复制的说明: JsonParser

Method for enabling specified parser feature (check JsonParser.Feature for list of features)

覆盖:

enable 在类中 JsonParser

disable

public JsonParser disable(JsonParser.Feature f)

从类复制的说明: JsonParser

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

覆盖:

disable 在类中 JsonParser

isEnabled

public boolean isEnabled(JsonParser.Feature f)

从类复制的说明: JsonParser

Method for checking whether specified JsonParser.Feature is enabled.

覆盖:

isEnabled 在类中 JsonParser

setSchema

public void setSchema(FormatSchema schema)

从类复制的说明: JsonParser

Method to call to make this parser use specified schema. Method must be called before trying to parse any content, right after parser instance has been created. Note that not all parsers support schemas; and those that do usually only accept specific types of schemas: ones defined for data format parser can read.

If parser does not support specified schema, UnsupportedOperationException is thrown.

覆盖:

setSchema 在类中 JsonParser

参数:

schema - Schema to use

canUseSchema

public boolean canUseSchema(FormatSchema schema)

从类复制的说明: JsonParser

Method that can be used to verify that given schema can be used with this parser (using JsonParser.setSchema(org.codehaus.jackson.FormatSchema)).

覆盖:

canUseSchema 在类中 JsonParser

参数:

schema - Schema to check

返回:

True if this parser can use given schema; false if not

version

public Version version()

从接口复制的说明: Versioned

Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).

指定者:

version 在接口中 Versioned

覆盖:

version 在类中 JsonParser

getInputSource

public Object getInputSource()

从类复制的说明: JsonParser

Method that can be used to get access to object that is used to access input being parsed; this is usually either InputStream or Reader, depending on what parser was constructed with. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser 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.

覆盖:

getInputSource 在类中 JsonParser

close

public void close()
           throws IOException

从类复制的说明: JsonParser

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 JsonParser.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 在类中 JsonParser

抛出:

IOException

isClosed

public boolean isClosed()

从类复制的说明: JsonParser

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 JsonParser.nextToken() (and the underlying stream may be closed). Closing may be due to an explicit call to JsonParser.close() or because parser has encountered end of input.

指定者:

isClosed 在类中 JsonParser

getCurrentToken

public JsonToken getCurrentToken()

从类复制的说明: JsonParser

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

返回:

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

从类复制的说明: JsonParser

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

返回:

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

clearCurrentToken

public void clearCurrentToken()

从类复制的说明: JsonParser

Method called to "consume" the current token by effectively removing it so that JsonParser.hasCurrentToken() returns false, and JsonParser.getCurrentToken() null). Cleared token value can still be accessed by calling JsonParser.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 在类中 JsonParser

getCurrentName

public String getCurrentName()
                      throws IOException,
                             JsonParseException

从类复制的说明: JsonParser

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 JsonParser.getText() returns; for field values it will be preceding field name; and for others (array values, root-level values) null.

指定者:

getCurrentName 在类中 JsonParser

抛出:

IOException

JsonParseException

getCurrentLocation

public JsonLocation getCurrentLocation()

从类复制的说明: JsonParser

Method that returns location of the last processed character; usually for error reporting purposes.

指定者:

getCurrentLocation 在类中 JsonParser

getLastClearedToken

public JsonToken getLastClearedToken()

从类复制的说明: JsonParser

Method that can be called to get the last token that was cleared using JsonParser.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 在类中 JsonParser

getParsingContext

public JsonStreamContext getParsingContext()

从类复制的说明: JsonParser

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

getText

public String getText()
               throws IOException,
                      JsonParseException

从类复制的说明: JsonParser

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

指定者:

getText 在类中 JsonParser

抛出:

IOException

JsonParseException

getTextCharacters

public char[] getTextCharacters()
                         throws IOException,
                                JsonParseException

从类复制的说明: JsonParser

Method similar to JsonParser.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 JsonParser.getTextOffset()) to know the actual offset
• Length of textual contents may be less than the length of returned buffer: call JsonParser.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 JsonParser.getText()) is to avoid construction of a String object (which will make a copy of contents).

指定者:

getTextCharacters 在类中 JsonParser

抛出:

IOException

JsonParseException

getTextLength

public int getTextLength()
                  throws IOException,
                         JsonParseException

从类复制的说明: JsonParser

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

指定者:

getTextLength 在类中 JsonParser

返回:

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

抛出:

IOException

JsonParseException

getTextOffset

public int getTextOffset()
                  throws IOException,
                         JsonParseException

从类复制的说明: JsonParser

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

指定者:

getTextOffset 在类中 JsonParser

返回:

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

抛出:

IOException

JsonParseException

getBooleanValue

public boolean getBooleanValue()
                        throws IOException,
                               JsonParseException

从类复制的说明: JsonParser

Convenience accessor that can be called when the current token is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE.

Note: if the token is not of above-mentioned boolean types, an integer, but its value falls outside of range of Java long, a JsonParseException may be thrown to indicate numeric overflow/underflow.

覆盖:

getBooleanValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getBigIntegerValue

public BigInteger getBigIntegerValue()
                              throws IOException,
                                     JsonParseException

从类复制的说明: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can not be used as a Java long primitive type due to its magnitude. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.getDecimalValue() and then constructing a BigInteger from that value.

指定者:

getBigIntegerValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getByteValue

public byte getByteValue()
                  throws IOException,
                         JsonParseException

从类复制的说明: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a value of Java byte primitive type. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.getDoubleValue() and then casting; except for possible overflow/underflow exception.

Note: if the resulting integer value falls outside range of Java byte, a JsonParseException will be thrown to indicate numeric overflow/underflow.

覆盖:

getByteValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getShortValue

public short getShortValue()
                    throws IOException,
                           JsonParseException

从类复制的说明: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a value of Java short primitive type. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.getDoubleValue() and then casting; except for possible overflow/underflow exception.

Note: if the resulting integer value falls outside range of Java short, a JsonParseException will be thrown to indicate numeric overflow/underflow.

覆盖:

getShortValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getDecimalValue

public BigDecimal getDecimalValue()
                           throws IOException,
                                  JsonParseException

从类复制的说明: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT or JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions are ever thrown.

指定者:

getDecimalValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getDoubleValue

public double getDoubleValue()
                      throws IOException,
                             JsonParseException

从类复制的说明: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT and it can be expressed as a Java double primitive type. It can also be called for JsonToken.VALUE_NUMBER_INT; if so, it is equivalent to calling JsonParser.getLongValue() and then casting; except for possible overflow/underflow exception.

Note: if the value falls outside of range of Java double, a JsonParseException will be thrown to indicate numeric overflow/underflow.

指定者:

getDoubleValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getFloatValue

public float getFloatValue()
                    throws IOException,
                           JsonParseException

从类复制的说明: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT and it can be expressed as a Java float primitive type. It can also be called for JsonToken.VALUE_NUMBER_INT; if so, it is equivalent to calling JsonParser.getLongValue() and then casting; except for possible overflow/underflow exception.

Note: if the value falls outside of range of Java float, a JsonParseException will be thrown to indicate numeric overflow/underflow.

指定者:

getFloatValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getIntValue

public int getIntValue()
                throws IOException,
                       JsonParseException

从类复制的说明: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a value of Java int primitive type. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.getDoubleValue() and then casting; except for possible overflow/underflow exception.

Note: if the resulting integer value falls outside range of Java int, a JsonParseException may be thrown to indicate numeric overflow/underflow.

指定者:

getIntValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getLongValue

public long getLongValue()
                  throws IOException,
                         JsonParseException

从类复制的说明: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a Java long primitive type. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.getDoubleValue() and then casting to int; except for possible overflow/underflow exception.

Note: if the token is an integer, but its value falls outside of range of Java long, a JsonParseException may be thrown to indicate numeric overflow/underflow.

指定者:

getLongValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getNumberType

public JsonParser.NumberType getNumberType()
                                    throws IOException,
                                           JsonParseException

从类复制的说明: JsonParser

If current token is of type JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberType constants; otherwise returns null.

指定者:

getNumberType 在类中 JsonParser

抛出:

IOException

JsonParseException

getNumberValue

public Number getNumberValue()
                      throws IOException,
                             JsonParseException

从类复制的说明: JsonParser

Generic number value accessor method that will work for all kinds of numeric values. It will return the optimal (simplest/smallest possible) wrapper object that can express the numeric value just parsed.

指定者:

getNumberValue 在类中 JsonParser

抛出:

IOException

JsonParseException

getBinaryValue

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

从类复制的说明: JsonParser

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 JsonParser.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 在类中 JsonParser

参数:

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

返回:

Decoded binary data

抛出:

IOException

JsonParseException

getEmbeddedObject

public Object getEmbeddedObject()
                         throws IOException,
                                JsonParseException

从类复制的说明: JsonParser

Accessor that can be called if (and only if) the current token is JsonToken.VALUE_EMBEDDED_OBJECT. For other token types, null is returned.

Note: only some specialized parser implementations support embedding of objects (usually ones that are facades on top of non-streaming sources, such as object trees).

覆盖:

getEmbeddedObject 在类中 JsonParser

抛出:

IOException

JsonParseException

getTokenLocation

public JsonLocation getTokenLocation()

从类复制的说明: JsonParser

Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.

指定者:

getTokenLocation 在类中 JsonParser

nextToken

public JsonToken nextToken()
                    throws IOException,
                           JsonParseException

从类复制的说明: JsonParser

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

返回:

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

抛出:

IOException

JsonParseException

skipChildren

public JsonParser skipChildren()
                        throws IOException,
                               JsonParseException

从类复制的说明: JsonParser

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 JsonParser.nextToken() to point to the next available token, if any.

指定者:

skipChildren 在类中 JsonParser

抛出:

IOException

JsonParseException