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.
|
_features| Constructor and Description |
|---|
JsonParserDelegate(JsonParser d) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
canReadObjectId()
Introspection method that may be called to see if the underlying
data format supports some kind of Object Ids natively (many do not;
for example, JSON doesn't).
|
boolean |
canReadTypeId()
Introspection method that may be called to see if the underlying
data format supports some kind of Type Ids natively (many do not;
for example, JSON doesn't).
|
boolean |
canUseSchema(FormatSchema schema)
Method that can be used to verify that given schema can be used with
this parser (using
JsonParser.setSchema(com.fasterxml.jackson.core.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.
|
int |
getCurrentTokenId()
Method similar to
JsonParser.getCurrentToken() but that returns an
int instead of JsonToken (enum value). |
Object |
getCurrentValue()
Helper method, usually equivalent to:
getParsingContext().getCurrentValue();
|
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. |
int |
getFeatureMask()
Bulk access method for getting state of all standard
JsonParser.Features. |
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.
|
Object |
getObjectId()
Method that can be called to check whether current token
(one that was just read) has an associated Object id, and if
so, return it.
|
JsonStreamContext |
getParsingContext()
Method that can be used to access current parsing context reader
is in.
|
FormatSchema |
getSchema()
Method for accessing Schema that this parser uses, if any.
|
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.
|
Object |
getTypeId()
Method that can be called to check whether current token
(one that was just read) has an associated type id, and if
so, return it.
|
boolean |
getValueAsBoolean()
Method that will try to convert value of current token to a
boolean.
|
boolean |
getValueAsBoolean(boolean defaultValue)
Method that will try to convert value of current token to a
boolean.
|
double |
getValueAsDouble()
Method that will try to convert value of current token to a Java
double.
|
double |
getValueAsDouble(double defaultValue)
Method that will try to convert value of current token to a
Java double.
|
int |
getValueAsInt()
Method that will try to convert value of current token to a
int.
|
int |
getValueAsInt(int defaultValue)
Method that will try to convert value of current token to a
int.
|
long |
getValueAsLong()
Method that will try to convert value of current token to a
long.
|
long |
getValueAsLong(long defaultValue)
Method that will try to convert value of current token to a
long.
|
String |
getValueAsString()
Method that will try to convert value of current token to a
String. |
String |
getValueAsString(String defaultValue)
Method that will try to convert value of current token to a
String. |
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
JsonParser.getTextCharacters() would be the most efficient
way to access textual content for the event parser currently
points to. |
boolean |
hasTokenId(int id)
Method that is functionally equivalent to:
return getCurrentTokenId() == id
|
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. |
boolean |
isExpectedStartArrayToken()
Specialized accessor that can be used to verify that the current
token indicates start array (usually meaning that current token
is
JsonToken.START_ARRAY) when start array is expected. |
boolean |
isExpectedStartObjectToken()
Similar to
JsonParser.isExpectedStartArrayToken(), but checks whether stream
currently points to JsonToken.START_OBJECT. |
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.
|
int |
readBinaryValue(Base64Variant b64variant,
OutputStream out)
Similar to
JsonParser.readBinaryValue(OutputStream) but allows explicitly
specifying base64 variant to use. |
boolean |
requiresCustomCodec()
Method that can be called to determine if a custom
ObjectCodec is needed for binding data parsed
using JsonParser constructed by this factory
(which typically also implies the same for serialization
with JsonGenerator). |
void |
setCodec(ObjectCodec c)
Setter that allows defining
ObjectCodec associated with this
parser, if any. |
void |
setCurrentValue(Object v)
Helper method, usually equivalent to:
getParsingContext().setCurrentValue(v);
|
JsonParser |
setFeatureMask(int mask)
Bulk set method for (re)setting states of all standard
JsonParser.Features |
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()
Accessor for getting version of the core package, given a parser instance.
|
_codec, _constructError, _reportUnsupportedOperation, configure, getBinaryValue, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBufferedprotected JsonParser delegate
public JsonParserDelegate(JsonParser d)
public Object getCurrentValue()
JsonParser
getParsingContext().getCurrentValue();
getCurrentValue in class JsonParserpublic void setCurrentValue(Object v)
JsonParser
getParsingContext().setCurrentValue(v);
setCurrentValue in class JsonParserpublic void setCodec(ObjectCodec c)
JsonParserObjectCodec associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).setCodec in class JsonParserpublic ObjectCodec getCodec()
JsonParserObjectCodec associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).getCodec in class JsonParserpublic JsonParser enable(JsonParser.Feature f)
JsonParserJsonParser.Feature for list of features)enable in class JsonParserpublic JsonParser disable(JsonParser.Feature f)
JsonParserJsonParser.Feature for list of features)disable in class JsonParserpublic boolean isEnabled(JsonParser.Feature f)
JsonParserJsonParser.Feature is enabled.isEnabled in class JsonParserpublic int getFeatureMask()
JsonParserJsonParser.Features.getFeatureMask in class JsonParserJsonParser.Features.public JsonParser setFeatureMask(int mask)
JsonParserJsonParser.FeaturessetFeatureMask in class JsonParserpublic FormatSchema getSchema()
JsonParsergetSchema in class JsonParserpublic void setSchema(FormatSchema schema)
JsonParser
If parser does not support specified schema, UnsupportedOperationException
is thrown.
setSchema in class JsonParserschema - Schema to usepublic boolean canUseSchema(FormatSchema schema)
JsonParserJsonParser.setSchema(com.fasterxml.jackson.core.FormatSchema)).canUseSchema in class JsonParserschema - Schema to checkpublic Version version()
JsonParserversion in interface Versionedversion in class JsonParserpublic Object getInputSource()
JsonParserInputStream 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 JsonParserpublic boolean requiresCustomCodec()
JsonParserObjectCodec is needed for binding data parsed
using JsonParser constructed by this factory
(which typically also implies the same for serialization
with JsonGenerator).requiresCustomCodec in class JsonParserObjectCodec is enoughpublic void close()
throws IOException
JsonParserJsonParser.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 Closeableclose in interface AutoCloseableclose in class JsonParserIOExceptionpublic boolean isClosed()
JsonParserJsonParser.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 JsonParserpublic JsonToken getCurrentToken()
JsonParsergetCurrentToken in class JsonParserpublic int getCurrentTokenId()
JsonParserJsonParser.getCurrentToken() but that returns an
int instead of JsonToken (enum value).
Use of int directly is typically more efficient on switch statements, so this method may be useful when building low-overhead codecs. Note, however, that effect may not be big enough to matter: make sure to profile performance before deciding to use this method.
getCurrentTokenId in class JsonParserint matching one of constants from JsonTokenId.public boolean hasCurrentToken()
JsonParserparser.getCurrentToken() != null.hasCurrentToken in class JsonParserJsonParser.nextToken(); false otherwise (parser
was just constructed, encountered end-of-input
and returned null from JsonParser.nextToken(), or the token
has been consumed)public boolean hasTokenId(int id)
JsonParser
return getCurrentTokenId() == id
but may be more efficiently implemented.
Note that no traversal or conversion is performed; so in some
cases calling method like JsonParser.isExpectedStartArrayToken()
is necessary instead.
hasTokenId in class JsonParserpublic String getCurrentName() throws IOException, JsonParseException
JsonParserJsonToken.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 in class JsonParserIOExceptionJsonParseExceptionpublic JsonLocation getCurrentLocation()
JsonParsergetCurrentLocation in class JsonParserpublic JsonStreamContext getParsingContext()
JsonParsergetParsingContext in class JsonParserpublic boolean isExpectedStartArrayToken()
JsonParserJsonToken.START_ARRAY) when start array is expected.
For some specialized parsers this can return true for other cases
as well; this is usually done to emulate arrays in cases underlying
format is ambiguous (XML, for example, has no format-level difference
between Objects and Arrays; it just has elements).
Default implementation is equivalent to:
getCurrentToken() == JsonToken.START_ARRAYbut may be overridden by custom parser implementations.
isExpectedStartArrayToken in class JsonParserJsonToken.START_ARRAY);
false if not.public boolean isExpectedStartObjectToken()
JsonParserJsonParser.isExpectedStartArrayToken(), but checks whether stream
currently points to JsonToken.START_OBJECT.isExpectedStartObjectToken in class JsonParserpublic void clearCurrentToken()
JsonParserJsonParser.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 JsonParserpublic JsonToken getLastClearedToken()
JsonParserJsonParser.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 JsonParserpublic void overrideCurrentName(String name)
JsonParserNote that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
overrideCurrentName in class JsonParsername - Name to use as the current name; may be null.public String getText() throws IOException, JsonParseException
JsonParserJsonParser.nextToken(), or
after encountering end-of-input), returns null.
Method can be called for any token type.getText in class JsonParserIOExceptionJsonParseExceptionpublic boolean hasTextCharacters()
JsonParserJsonParser.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 in class JsonParserJsonParser.getTextCharacters(); false
means that it may or may not existpublic char[] getTextCharacters()
throws IOException,
JsonParseException
JsonParserJsonParser.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 JsonParserIOExceptionJsonParseExceptionpublic int getTextLength()
throws IOException,
JsonParseException
JsonParserJsonParser.getTextCharacters(), to know length
of String stored in returned buffer.getTextLength in class JsonParserJsonParser.getTextCharacters() that are part of
textual content of the current token.IOExceptionJsonParseExceptionpublic int getTextOffset()
throws IOException,
JsonParseException
JsonParserJsonParser.getTextCharacters(), to know offset
of the first text content character within buffer.getTextOffset in class JsonParserJsonParser.getTextCharacters() that is part of
textual content of the current token.IOExceptionJsonParseExceptionpublic BigInteger getBigIntegerValue() throws IOException, JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic boolean getBooleanValue()
throws IOException,
JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic byte getByteValue()
throws IOException,
JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic short getShortValue()
throws IOException,
JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic BigDecimal getDecimalValue() throws IOException, JsonParseException
JsonParserJsonToken.VALUE_NUMBER_FLOAT or
JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions
are ever thrown.getDecimalValue in class JsonParserIOExceptionJsonParseExceptionpublic double getDoubleValue()
throws IOException,
JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic float getFloatValue()
throws IOException,
JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic int getIntValue()
throws IOException,
JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic long getLongValue()
throws IOException,
JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic JsonParser.NumberType getNumberType() throws IOException, JsonParseException
JsonParserJsonToken.VALUE_NUMBER_INT or
JsonToken.VALUE_NUMBER_FLOAT, returns
one of JsonParser.NumberType constants; otherwise returns null.getNumberType in class JsonParserIOExceptionJsonParseExceptionpublic Number getNumberValue() throws IOException, JsonParseException
JsonParsergetNumberValue in class JsonParserIOExceptionJsonParseExceptionpublic int getValueAsInt()
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.
getValueAsInt in class JsonParserIOExceptionJsonParseExceptionpublic int getValueAsInt(int defaultValue)
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
getValueAsInt in class JsonParserIOExceptionJsonParseExceptionpublic long getValueAsLong()
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.
getValueAsLong in class JsonParserIOExceptionJsonParseExceptionpublic long getValueAsLong(long defaultValue)
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
getValueAsLong in class JsonParserIOExceptionJsonParseExceptionpublic double getValueAsDouble()
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured types like Objects and Arrays), default value of 0.0 will be returned; no exceptions are thrown.
getValueAsDouble in class JsonParserIOExceptionJsonParseExceptionpublic double getValueAsDouble(double defaultValue)
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
getValueAsDouble in class JsonParserIOExceptionJsonParseExceptionpublic boolean getValueAsBoolean()
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to a boolean value (including structured types like Objects and Arrays), default value of false will be returned; no exceptions are thrown.
getValueAsBoolean in class JsonParserIOExceptionJsonParseExceptionpublic boolean getValueAsBoolean(boolean defaultValue)
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to a boolean value (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
getValueAsBoolean in class JsonParserIOExceptionJsonParseExceptionpublic String getValueAsString() throws IOException, JsonParseException
JsonParserString.
JSON Strings map naturally; scalar values get converted to
their textual representation.
If representation can not be converted to a String value (including structured types
like Objects and Arrays and null token), default value of
null will be returned; no exceptions are thrown.getValueAsString in class JsonParserIOExceptionJsonParseExceptionpublic String getValueAsString(String defaultValue) throws IOException, JsonParseException
JsonParserString.
JSON Strings map naturally; scalar values get converted to
their textual representation.
If representation can not be converted to a String value (including structured types
like Objects and Arrays and null token), specified default value
will be returned; no exceptions are thrown.getValueAsString in class JsonParserIOExceptionJsonParseExceptionpublic Object getEmbeddedObject() throws IOException, JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic byte[] getBinaryValue(Base64Variant b64variant) throws IOException, JsonParseException
JsonParserJsonParser.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 JsonParserb64variant - Expected variant of base64 encoded
content (see Base64Variants for definitions
of "standard" variants).IOExceptionJsonParseExceptionpublic int readBinaryValue(Base64Variant b64variant, OutputStream out) throws IOException, JsonParseException
JsonParserJsonParser.readBinaryValue(OutputStream) but allows explicitly
specifying base64 variant to use.readBinaryValue in class JsonParserb64variant - base64 variant to useout - Output stream to use for passing decoded binary dataOutputStreamIOExceptionJsonParseExceptionpublic JsonLocation getTokenLocation()
JsonParsergetTokenLocation in class JsonParserpublic JsonToken nextToken() throws IOException, JsonParseException
JsonParsernextToken in class JsonParserIOExceptionJsonParseExceptionpublic JsonToken nextValue() throws IOException, JsonParseException
JsonParserJsonToken.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 JsonParser.getCurrentName() when parser points to
the value.nextValue in class JsonParserJsonToken.NOT_AVAILABLE if no tokens were
available yet)IOExceptionJsonParseExceptionpublic JsonParser skipChildren() throws IOException, JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionpublic boolean canReadObjectId()
JsonParserDefault implementation returns true; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native object ids.
canReadObjectId in class JsonParserpublic boolean canReadTypeId()
JsonParserDefault implementation returns true; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native type ids.
canReadTypeId in class JsonParserpublic Object getObjectId() throws IOException, JsonGenerationException
JsonParserJsonParser.canReadObjectId()
first, it is not illegal to call this method even if that method returns
true; but if so, it will return null. This may be used to simplify calling
code.
Default implementation will simply return null.
getObjectId in class JsonParserIOExceptionJsonGenerationExceptionpublic Object getTypeId() throws IOException, JsonGenerationException
JsonParserJsonParser.canReadTypeId()
first, it is not illegal to call this method even if that method returns
true; but if so, it will return null. This may be used to simplify calling
code.
Default implementation will simply return null.
getTypeId in class JsonParserIOExceptionJsonGenerationExceptionCopyright © 2014 FasterXML. All Rights Reserved.