public class JsonParserDelegate extends JacksonParser
JacksonParser,
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.JacksonParser.Feature, JacksonParser.NumberType| 构造器和说明 |
|---|
JsonParserDelegate(JacksonParser d) |
| 限定符和类型 | 方法和说明 |
|---|---|
boolean |
canUseSchema(FormatSchema schema)
Method that can be used to verify that given schema can be used with
this parser (using
JacksonParser.setSchema(org.hotwheel.json.impl.jackson.FormatSchema)). |
void |
clearCurrentToken()
Method called to "consume" the current token by effectively
removing it so that
JacksonParser.hasCurrentToken() returns false, and
JacksonParser.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
JacksonParser.Feature.AUTO_CLOSE_SOURCE is enabled. |
JacksonParser |
disable(JacksonParser.Feature f)
Method for disabling specified feature
(check
JacksonParser.Feature for list of features) |
JacksonParser |
enable(JacksonParser.Feature f)
Method for enabling specified parser feature
(check
JacksonParser.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 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.
|
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
JacksonParser.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. |
JacksonParser.NumberType |
getNumberType()
If current token is of type
JsonToken.VALUE_NUMBER_INT or
JsonToken.VALUE_NUMBER_FLOAT, returns
one of JacksonParser.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
JacksonParser.nextToken(), or
after encountering end-of-input), returns null. |
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. |
int |
getTextLength()
Accessor used with
JacksonParser.getTextCharacters(), to know length
of String stored in returned buffer. |
int |
getTextOffset()
Accessor used with
JacksonParser.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 |
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. |
boolean |
isClosed()
Method that can be called to determine whether this parser
is closed or not.
|
boolean |
isEnabled(JacksonParser.Feature f)
Method for checking whether specified
JacksonParser.Feature is enabled. |
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).
|
void |
overrideCurrentName(String name)
Method that can be used to change what is considered to be
the current (field) name.
|
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.
|
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.
|
configure, getBinaryValue, getSchema, getValueAsBoolean, getValueAsBoolean, getValueAsDouble, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, isExpectedStartArrayToken, nextBooleanValue, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBufferedpublic JsonParserDelegate(JacksonParser d)
public ObjectCodec getCodec()
JacksonParserObjectCodec associated with this
parser, if any. Codec is used by JacksonParser.readValueAs(Class)
method (and its variants).getCodec 在类中 JacksonParserpublic void setCodec(ObjectCodec c)
JacksonParserObjectCodec associated with this
parser, if any. Codec is used by JacksonParser.readValueAs(Class)
method (and its variants).setCodec 在类中 JacksonParserpublic JacksonParser enable(JacksonParser.Feature f)
JacksonParserJacksonParser.Feature for list of features)enable 在类中 JacksonParserpublic JacksonParser disable(JacksonParser.Feature f)
JacksonParserJacksonParser.Feature for list of features)disable 在类中 JacksonParserpublic boolean isEnabled(JacksonParser.Feature f)
JacksonParserJacksonParser.Feature is enabled.isEnabled 在类中 JacksonParserpublic void setSchema(FormatSchema schema)
JacksonParser
If parser does not support specified schema, UnsupportedOperationException
is thrown.
setSchema 在类中 JacksonParserschema - Schema to usepublic boolean canUseSchema(FormatSchema schema)
JacksonParserJacksonParser.setSchema(org.hotwheel.json.impl.jackson.FormatSchema)).canUseSchema 在类中 JacksonParserschema - Schema to checkpublic Version version()
JacksonParserversion 在接口中 Versionedversion 在类中 JacksonParserpublic Object getInputSource()
JacksonParserInputStream 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 在类中 JacksonParserpublic void close()
throws IOException
JacksonParserJacksonParser.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 在接口中 Closeableclose 在接口中 AutoCloseableclose 在类中 JacksonParserIOExceptionpublic boolean isClosed()
JacksonParserJacksonParser.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 在类中 JacksonParserpublic JsonToken getCurrentToken()
JacksonParsergetCurrentToken 在类中 JacksonParserpublic boolean hasCurrentToken()
JacksonParserparser.getCurrentToken() != null.hasCurrentToken 在类中 JacksonParserJacksonParser.nextToken(); false otherwise (parser
was just constructed, encountered end-of-input
and returned null from JacksonParser.nextToken(), or the token
has been consumed)public String getCurrentName() throws IOException, JsonParseException
JacksonParserJsonToken.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic JsonLocation getCurrentLocation()
JacksonParsergetCurrentLocation 在类中 JacksonParserpublic JsonStreamContext getParsingContext()
JacksonParsergetParsingContext 在类中 JacksonParserpublic void clearCurrentToken()
JacksonParserJacksonParser.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 在类中 JacksonParserpublic JsonToken getLastClearedToken()
JacksonParserJacksonParser.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 在类中 JacksonParserpublic void overrideCurrentName(String name)
JacksonParserNote that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
overrideCurrentName 在类中 JacksonParsername - Name to use as the current name; may be null.public String getText() throws IOException, JsonParseException
JacksonParserJacksonParser.nextToken(), or
after encountering end-of-input), returns null.
Method can be called for any token type.getText 在类中 JacksonParserIOExceptionJsonParseExceptionpublic boolean hasTextCharacters()
JacksonParserJacksonParser.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 在类中 JacksonParserJacksonParser.getTextCharacters(); false
means that it may or may not existpublic char[] getTextCharacters()
throws IOException,
JsonParseException
JacksonParserJacksonParser.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:
JacksonParser.getTextOffset()) to
know the actual offset
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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic int getTextLength()
throws IOException,
JsonParseException
JacksonParserJacksonParser.getTextCharacters(), to know length
of String stored in returned buffer.getTextLength 在类中 JacksonParserJacksonParser.getTextCharacters() that are part of
textual content of the current token.IOExceptionJsonParseExceptionpublic int getTextOffset()
throws IOException,
JsonParseException
JacksonParserJacksonParser.getTextCharacters(), to know offset
of the first text content character within buffer.getTextOffset 在类中 JacksonParserJacksonParser.getTextCharacters() that is part of
textual content of the current token.IOExceptionJsonParseExceptionpublic BigInteger getBigIntegerValue() throws IOException, JsonParseException
JacksonParserJsonToken.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 JacksonParser.getDecimalValue()
and then constructing a BigInteger from that value.getBigIntegerValue 在类中 JacksonParserIOExceptionJsonParseExceptionpublic boolean getBooleanValue()
throws IOException,
JsonParseException
JacksonParserJsonToken.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic byte getByteValue()
throws IOException,
JsonParseException
JacksonParserJsonToken.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 JacksonParser.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic short getShortValue()
throws IOException,
JsonParseException
JacksonParserJsonToken.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 JacksonParser.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic BigDecimal getDecimalValue() throws IOException, JsonParseException
JacksonParserJsonToken.VALUE_NUMBER_FLOAT or
JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions
are ever thrown.getDecimalValue 在类中 JacksonParserIOExceptionJsonParseExceptionpublic double getDoubleValue()
throws IOException,
JsonParseException
JacksonParserJsonToken.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 JacksonParser.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic float getFloatValue()
throws IOException,
JsonParseException
JacksonParserJsonToken.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 JacksonParser.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic int getIntValue()
throws IOException,
JsonParseException
JacksonParserJsonToken.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 JacksonParser.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic long getLongValue()
throws IOException,
JsonParseException
JacksonParserJsonToken.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 JacksonParser.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic JacksonParser.NumberType getNumberType() throws IOException, JsonParseException
JacksonParserJsonToken.VALUE_NUMBER_INT or
JsonToken.VALUE_NUMBER_FLOAT, returns
one of JacksonParser.NumberType constants; otherwise returns null.getNumberType 在类中 JacksonParserIOExceptionJsonParseExceptionpublic Number getNumberValue() throws IOException, JsonParseException
JacksonParsergetNumberValue 在类中 JacksonParserIOExceptionJsonParseExceptionpublic Object getEmbeddedObject() throws IOException, JsonParseException
JacksonParserJsonToken.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 在类中 JacksonParserIOExceptionJsonParseExceptionpublic byte[] getBinaryValue(Base64Variant b64variant) throws IOException, JsonParseException
JacksonParserJacksonParser.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 在类中 JacksonParserb64variant - Expected variant of base64 encoded
content (see Base64Variants for definitions
of "standard" variants).IOExceptionJsonParseExceptionpublic JsonLocation getTokenLocation()
JacksonParsergetTokenLocation 在类中 JacksonParserpublic JsonToken nextToken() throws IOException, JsonParseException
JacksonParsernextToken 在类中 JacksonParserIOExceptionJsonParseExceptionpublic JsonToken nextValue() throws IOException, JsonParseException
JacksonParserJsonToken.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 在类中 JacksonParserJsonToken.NOT_AVAILABLE if no tokens were
available yet)IOExceptionJsonParseExceptionpublic JacksonParser skipChildren() throws IOException, JsonParseException
JacksonParserJsonToken.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 在类中 JacksonParserIOExceptionJsonParseExceptionCopyright © 2002–2019 The MyMMSCs Software Foundation. All rights reserved.