public class JsonParserDelegate extends JsonParser
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.JsonParser.Feature, JsonParser.NumberType
Modifier and Type | Field and Description |
---|---|
protected JsonParser |
delegate
Delegate object that method calls are delegated to.
|
_currToken, _features, _lastClearedToken
Constructor and Description |
---|
JsonParserDelegate(JsonParser d) |
Modifier and Type | Method and Description |
---|---|
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_NAME s 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). |
_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
protected JsonParser delegate
public JsonParserDelegate(JsonParser d)
public void setCodec(ObjectCodec c)
JsonParser
ObjectCodec
associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).setCodec
in class JsonParser
public ObjectCodec getCodec()
JsonParser
ObjectCodec
associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).getCodec
in class JsonParser
public JsonParser enable(JsonParser.Feature f)
JsonParser
JsonParser.Feature
for list of features)enable
in class JsonParser
public JsonParser disable(JsonParser.Feature f)
JsonParser
JsonParser.Feature
for list of features)disable
in class JsonParser
public boolean isEnabled(JsonParser.Feature f)
JsonParser
JsonParser.Feature
is enabled.isEnabled
in class JsonParser
public void setSchema(FormatSchema schema)
JsonParser
If parser does not support specified schema, UnsupportedOperationException
is thrown.
setSchema
in class JsonParser
schema
- Schema to usepublic boolean canUseSchema(FormatSchema schema)
JsonParser
JsonParser.setSchema(org.codehaus.jackson.FormatSchema)
).canUseSchema
in class JsonParser
schema
- Schema to checkpublic Version version()
Versioned
Version
for details).version
in interface Versioned
version
in class JsonParser
public Object getInputSource()
JsonParser
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
in class JsonParser
public void close() throws IOException
JsonParser
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
in interface Closeable
close
in interface AutoCloseable
close
in class JsonParser
IOException
public boolean isClosed()
JsonParser
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
in class JsonParser
public JsonToken getCurrentToken()
JsonParser
getCurrentToken
in class JsonParser
public boolean hasCurrentToken()
JsonParser
parser.getCurrentToken() != null
.hasCurrentToken
in class JsonParser
JsonParser.nextToken()
; false otherwise (parser
was just constructed, encountered end-of-input
and returned null from JsonParser.nextToken()
, or the token
has been consumed)public void clearCurrentToken()
JsonParser
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
in class JsonParser
public String getCurrentName() throws IOException, JsonParseException
JsonParser
JsonToken.FIELD_NAME
s 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
in class JsonParser
IOException
JsonParseException
public JsonLocation getCurrentLocation()
JsonParser
getCurrentLocation
in class JsonParser
public JsonToken getLastClearedToken()
JsonParser
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
in class JsonParser
public JsonStreamContext getParsingContext()
JsonParser
getParsingContext
in class JsonParser
public String getText() throws IOException, JsonParseException
JsonParser
JsonParser.nextToken()
, or
after encountering end-of-input), returns null.
Method can be called for any token type.getText
in class JsonParser
IOException
JsonParseException
public char[] getTextCharacters() throws IOException, JsonParseException
JsonParser
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:
JsonParser.getTextOffset()
) to
know the actual offset
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
in class JsonParser
IOException
JsonParseException
public int getTextLength() throws IOException, JsonParseException
JsonParser
JsonParser.getTextCharacters()
, to know length
of String stored in returned buffer.getTextLength
in class JsonParser
JsonParser.getTextCharacters()
that are part of
textual content of the current token.IOException
JsonParseException
public int getTextOffset() throws IOException, JsonParseException
JsonParser
JsonParser.getTextCharacters()
, to know offset
of the first text content character within buffer.getTextOffset
in class JsonParser
JsonParser.getTextCharacters()
that is part of
textual content of the current token.IOException
JsonParseException
public boolean getBooleanValue() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public BigInteger getBigIntegerValue() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public byte getByteValue() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public short getShortValue() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public BigDecimal getDecimalValue() throws IOException, JsonParseException
JsonParser
JsonToken.VALUE_NUMBER_FLOAT
or
JsonToken.VALUE_NUMBER_INT
. No under/overflow exceptions
are ever thrown.getDecimalValue
in class JsonParser
IOException
JsonParseException
public double getDoubleValue() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public float getFloatValue() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public int getIntValue() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public long getLongValue() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public JsonParser.NumberType getNumberType() throws IOException, JsonParseException
JsonParser
JsonToken.VALUE_NUMBER_INT
or
JsonToken.VALUE_NUMBER_FLOAT
, returns
one of JsonParser.NumberType
constants; otherwise returns null.getNumberType
in class JsonParser
IOException
JsonParseException
public Number getNumberValue() throws IOException, JsonParseException
JsonParser
getNumberValue
in class JsonParser
IOException
JsonParseException
public byte[] getBinaryValue(Base64Variant b64variant) throws IOException, JsonParseException
JsonParser
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
in class JsonParser
b64variant
- Expected variant of base64 encoded
content (see Base64Variants
for definitions
of "standard" variants).IOException
JsonParseException
public Object getEmbeddedObject() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException
public JsonLocation getTokenLocation()
JsonParser
getTokenLocation
in class JsonParser
public JsonToken nextToken() throws IOException, JsonParseException
JsonParser
nextToken
in class JsonParser
IOException
JsonParseException
public JsonParser skipChildren() throws IOException, JsonParseException
JsonParser
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
in class JsonParser
IOException
JsonParseException