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, _requestPayload, DEFAULT_READ_CAPABILITIES
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. |
JsonToken |
currentToken()
Accessor to find which token parser currently points to, if any;
null will be returned if none.
|
int |
currentTokenId()
Method similar to
JsonParser.getCurrentToken() but that returns an
int instead of JsonToken (enum value). |
JsonParser |
delegate()
Accessor for getting the immediate
JsonParser this parser delegates calls to. |
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) |
void |
finishToken()
Method that may be used to force full handling of the current token
so that even if lazy processing is enabled, the whole contents are
read for possible retrieval.
|
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 , to return matching boolean
value. |
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()
|
JsonToken |
getCurrentToken()
Alias for
JsonParser.currentToken() , may be deprecated sometime after
Jackson 2.12 (will be removed from 3.0). |
int |
getCurrentTokenId()
Deprecated.
|
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.Feature s. |
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.
|
Number |
getNumberValueExact()
Method similar to
JsonParser.getNumberValue() with the difference that
for floating-point numbers value returned may be BigDecimal
if the underlying format does not store floating-point numbers using
native representation: for example, textual formats represent numbers
as Strings (which are 10-based), and conversion to Double
is potentially lossy operation. |
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.
|
JacksonFeatureSet<StreamReadCapability> |
getReadCapabilities()
Accessor for getting metadata on capabilities of this parser, based on
underlying data format being read (directly or indirectly).
|
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. |
int |
getText(Writer writer)
Method to read the textual representation of the current token in chunks and
pass it to the given Writer.
|
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
Java
int value. |
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 |
hasToken(JsonToken t)
Method that is functionally equivalent to:
return currentToken() == t
but may be more efficiently implemented. |
boolean |
hasTokenId(int id)
Method that is functionally equivalent to:
return currentTokenId() == id
but may be more efficiently implemented. |
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 |
isExpectedNumberIntToken()
Similar to
JsonParser.isExpectedStartArrayToken() , but checks whether stream
currently points to JsonToken.VALUE_NUMBER_INT . |
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 . |
boolean |
isNaN()
Access for checking whether current token is a numeric value token, but
one that is of "not-a-number" (NaN) variety (including both "NaN" AND
positive/negative infinity!): not supported by all formats,
but often supported for
JsonToken.VALUE_NUMBER_FLOAT . |
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.
|
JsonParser |
overrideFormatFeatures(int values,
int mask)
Bulk set method for (re)setting states of
FormatFeature s,
by specifying values (set / clear) along with a mask, to determine
which features to change, if any. |
JsonParser |
overrideStdFeatures(int values,
int mask)
Bulk set method for (re)setting states of features specified by
mask . |
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)
Deprecated.
|
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, canParseAsync, configure, currentName, getBinaryValue, getFormatFeatures, getNonBlockingInputFeeder, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError
protected JsonParser delegate
public JsonParserDelegate(JsonParser d)
public Object getCurrentValue()
JsonParser
getParsingContext().getCurrentValue();
Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.
getCurrentValue
in class JsonParser
public void setCurrentValue(Object v)
JsonParser
getParsingContext().setCurrentValue(v);
setCurrentValue
in class JsonParser
v
- Current value to assign for the current input context of this parserpublic 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
c
- Codec to assign, if any; null
if nonepublic 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
null
if nonepublic JsonParser enable(JsonParser.Feature f)
JsonParser
JsonParser.Feature
for list of features)enable
in class JsonParser
f
- Feature to enablepublic JsonParser disable(JsonParser.Feature f)
JsonParser
JsonParser.Feature
for list of features)disable
in class JsonParser
f
- Feature to disablepublic boolean isEnabled(JsonParser.Feature f)
JsonParser
JsonParser.Feature
is enabled.isEnabled
in class JsonParser
f
- Feature to checkTrue
if feature is enabled; false
otherwisepublic int getFeatureMask()
JsonParser
JsonParser.Feature
s.getFeatureMask
in class JsonParser
JsonParser.Feature
s.@Deprecated public JsonParser setFeatureMask(int mask)
JsonParser
JsonParser.Feature
ssetFeatureMask
in class JsonParser
mask
- Bit mask that defines set of features to enablepublic JsonParser overrideStdFeatures(int values, int mask)
JsonParser
mask
.
Functionally equivalent to
int oldState = getFeatureMask();
int newState = (oldState & ~mask) | (values & mask);
setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.overrideStdFeatures
in class JsonParser
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changepublic JsonParser overrideFormatFeatures(int values, int mask)
JsonParser
FormatFeature
s,
by specifying values (set / clear) along with a mask, to determine
which features to change, if any.
Default implementation will simply throw an exception to indicate that
the parser implementation does not support any FormatFeature
s.
overrideFormatFeatures
in class JsonParser
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changepublic FormatSchema getSchema()
JsonParser
getSchema
in class JsonParser
null
if nonepublic 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(com.fasterxml.jackson.core.FormatSchema)
).canUseSchema
in class JsonParser
schema
- Schema to checkpublic Version version()
JsonParser
version
in interface Versioned
version
in class JsonParser
jackson-core
jar that contains the classpublic 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 boolean requiresCustomCodec()
JsonParser
ObjectCodec
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 JsonParser
ObjectCodec
is enoughpublic JacksonFeatureSet<StreamReadCapability> getReadCapabilities()
JsonParser
getReadCapabilities
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
- if there is either an underlying I/O problempublic 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
True
if this parser instance has been closedpublic JsonToken currentToken()
JsonParser
currentToken
in class JsonParser
public int currentTokenId()
JsonParser
JsonParser.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.
currentTokenId
in class JsonParser
int
matching one of constants from JsonTokenId
.public JsonToken getCurrentToken()
JsonParser
JsonParser.currentToken()
, may be deprecated sometime after
Jackson 2.12 (will be removed from 3.0).getCurrentToken
in class JsonParser
@Deprecated public int getCurrentTokenId()
JsonParser
JsonParser.currentTokenId()
.getCurrentTokenId
in class JsonParser
int
matching one of constants from JsonTokenId
.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 boolean hasTokenId(int id)
JsonParser
return currentTokenId() == 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 JsonParser
id
- Token id to match (from (@link JsonTokenId})True
if the parser current points to specified tokenpublic boolean hasToken(JsonToken t)
JsonParser
return currentToken() == t
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.
hasToken
in class JsonParser
t
- Token to matchTrue
if the parser current points to specified tokenpublic String getCurrentName() throws IOException
JsonParser
getCurrentName
in class JsonParser
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic JsonLocation getCurrentLocation()
JsonParser
Note that the location is not guaranteed to be accurate (although most
implementation will try their best): some implementations may only
report specific boundary locations (start or end locations of tokens)
and others only return JsonLocation.NA
due to not having access
to input location information (when delegating actual decoding work
to other library)
getCurrentLocation
in class JsonParser
public JsonStreamContext getParsingContext()
JsonParser
getParsingContext
in class JsonParser
JsonStreamContext
) associated with this parserpublic boolean isExpectedStartArrayToken()
JsonParser
JsonToken.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:
currentToken() == JsonToken.START_ARRAYbut may be overridden by custom parser implementations.
isExpectedStartArrayToken
in class JsonParser
JsonToken.START_ARRAY
);
false
if notpublic boolean isExpectedStartObjectToken()
JsonParser
JsonParser.isExpectedStartArrayToken()
, but checks whether stream
currently points to JsonToken.START_OBJECT
.isExpectedStartObjectToken
in class JsonParser
JsonToken.START_OBJECT
);
false
if notpublic boolean isExpectedNumberIntToken()
JsonParser
JsonParser.isExpectedStartArrayToken()
, but checks whether stream
currently points to JsonToken.VALUE_NUMBER_INT
.
The initial use case is for XML backend to efficiently (attempt to) coerce textual content into numbers.
isExpectedNumberIntToken
in class JsonParser
JsonToken.VALUE_NUMBER_INT
);
false
if notpublic boolean isNaN() throws IOException
JsonParser
JsonToken.VALUE_NUMBER_FLOAT
.
NOTE: roughly equivalent to calling !Double.isFinite()
on value you would get from calling JsonParser.getDoubleValue()
.isNaN
in class JsonParser
True
if the current token is of type JsonToken.VALUE_NUMBER_FLOAT
but represents a "Not a Number"; false
for other tokens and regular
floating-point numbersIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic 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 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
null
otherwisepublic void overrideCurrentName(String name)
JsonParser
Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
overrideCurrentName
in class JsonParser
name
- Name to use as the current name; may be null.public String getText() throws IOException
JsonParser
JsonParser.nextToken()
, or
after encountering end-of-input), returns null.
Method can be called for any token type.getText
in class JsonParser
JsonParser.nextToken()
or other iteration methods)IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean hasTextCharacters()
JsonParser
JsonParser.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 JsonParser
JsonParser.getTextCharacters()
; false
means that it may or may not existpublic char[] getTextCharacters() throws IOException
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
- for low-level read issues, or
JsonParseException
for decoding problemspublic int getTextLength() throws IOException
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
- for low-level read issues, or
JsonParseException
for decoding problemspublic int getTextOffset() throws IOException
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
- for low-level read issues, or
JsonParseException
for decoding problemspublic int getText(Writer writer) throws IOException, UnsupportedOperationException
JsonParser
writer.write(parser.getText());but should typically be more efficient as longer content does need to be combined into a single
String
to return, and write
can occur directly from intermediate buffers Jackson uses.getText
in class JsonParser
writer
- Writer to write textual content toIOException
- for low-level read issues or writes using passed
writer
, or
JsonParseException
for decoding problemsUnsupportedOperationException
public BigInteger getBigIntegerValue() throws IOException
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
BigInteger
(if numeric token);
otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean getBooleanValue() throws IOException
JsonParser
JsonToken.VALUE_TRUE
or
JsonToken.VALUE_FALSE
, to return matching boolean
value.
If the current token is of some other type, JsonParseException
will be throwngetBooleanValue
in class JsonParser
True
if current token is JsonToken.VALUE_TRUE
,
false
if current token is JsonToken.VALUE_FALSE
;
otherwise throws JsonParseException
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic byte getByteValue() throws IOException
JsonParser
JsonToken.VALUE_NUMBER_INT
and
it can be expressed as a value of Java byte primitive type.
Note that in addition to "natural" input range of [-128, 127]
,
this also allows "unsigned 8-bit byte" values [128, 255]
:
but for this range value will be translated by truncation, leading
to sign change.
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
[-128, 255]
,
a InputCoercionException
will be thrown to indicate numeric overflow/underflow.
getByteValue
in class JsonParser
byte
(if numeric token within
range of [-128, 255]
); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic short getShortValue() throws IOException
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 InputCoercionException
will be thrown to indicate numeric overflow/underflow.
getShortValue
in class JsonParser
short
(if numeric token within
Java 16-bit signed short
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic BigDecimal getDecimalValue() throws IOException
JsonParser
JsonToken.VALUE_NUMBER_FLOAT
or
JsonToken.VALUE_NUMBER_INT
. No under/overflow exceptions
are ever thrown.getDecimalValue
in class JsonParser
BigDecimal
(if numeric token);
otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic double getDoubleValue() throws IOException
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 InputCoercionException
will be thrown to indicate numeric overflow/underflow.
getDoubleValue
in class JsonParser
double
(if numeric token within
Java double
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic float getFloatValue() throws IOException
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 InputCoercionException
will be thrown to indicate numeric overflow/underflow.
getFloatValue
in class JsonParser
float
(if numeric token within
Java float
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic int getIntValue() throws IOException
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 InputCoercionException
may be thrown to indicate numeric overflow/underflow.
getIntValue
in class JsonParser
int
(if numeric token within
Java 32-bit signed int
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic long getLongValue() throws IOException
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 InputCoercionException
may be thrown to indicate numeric overflow/underflow.
getLongValue
in class JsonParser
long
(if numeric token within
Java 32-bit signed long
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic JsonParser.NumberType getNumberType() throws IOException
JsonParser
JsonToken.VALUE_NUMBER_INT
or
JsonToken.VALUE_NUMBER_FLOAT
, returns
one of JsonParser.NumberType
constants; otherwise returns null.getNumberType
in class JsonParser
null
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic Number getNumberValue() throws IOException
JsonParser
getNumberValue
in class JsonParser
IOException
- Problem with access: JsonParseException
if
the current token is not numeric, or if decoding of the value fails
(invalid format for numbers); plain IOException
if underlying
content read fails (possible if values are extracted lazily)public Number getNumberValueExact() throws IOException
JsonParser
JsonParser.getNumberValue()
with the difference that
for floating-point numbers value returned may be BigDecimal
if the underlying format does not store floating-point numbers using
native representation: for example, textual formats represent numbers
as Strings (which are 10-based), and conversion to Double
is potentially lossy operation.
Default implementation simply returns JsonParser.getNumberValue()
getNumberValueExact
in class JsonParser
IOException
- Problem with access: JsonParseException
if
the current token is not numeric, or if decoding of the value fails
(invalid format for numbers); plain IOException
if underlying
content read fails (possible if values are extracted lazily)public int getValueAsInt() throws IOException
JsonParser
int
value.
Numbers are coerced using default Java rules; booleans convert to 0 (false)
and 1 (true), and Strings are parsed using default Java language integer
parsing rules.
If representation can not be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.
getValueAsInt
in class JsonParser
int
value current token is converted to, if possible; exception thrown
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic int getValueAsInt(int defaultValue) throws IOException
JsonParser
If 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 JsonParser
defaultValue
- Default value to return if conversion to int
is not possibleint
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic long getValueAsLong() throws IOException
JsonParser
If representation can not be converted to a long (including structured type markers like start/end Object/Array) default value of 0L will be returned; no exceptions are thrown.
getValueAsLong
in class JsonParser
long
value current token is converted to, if possible; exception thrown
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic long getValueAsLong(long defaultValue) throws IOException
JsonParser
If representation can not be converted to a long (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
getValueAsLong
in class JsonParser
defaultValue
- Default value to return if conversion to long
is not possiblelong
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic double getValueAsDouble() throws IOException
JsonParser
If representation can not be converted to a double (including structured types like Objects and Arrays), default value of 0.0 will be returned; no exceptions are thrown.
getValueAsDouble
in class JsonParser
double
value current token is converted to, if possible; exception thrown
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic double getValueAsDouble(double defaultValue) throws IOException
JsonParser
If representation can not be converted to a double (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
getValueAsDouble
in class JsonParser
defaultValue
- Default value to return if conversion to double
is not possibledouble
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean getValueAsBoolean() throws IOException
JsonParser
If 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 JsonParser
boolean
value current token is converted to, if possible; exception thrown
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean getValueAsBoolean(boolean defaultValue) throws IOException
JsonParser
If 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 JsonParser
defaultValue
- Default value to return if conversion to boolean
is not possibleboolean
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic String getValueAsString() throws IOException
JsonParser
String
.
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 JsonParser
String
value current token is converted to, if possible; null
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic String getValueAsString(String defaultValue) throws IOException
JsonParser
String
.
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 JsonParser
defaultValue
- Default value to return if conversion to String
is not possibleString
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic Object getEmbeddedObject() throws IOException
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). One exception
is access to binary content (whether via base64 encoding or not)
which typically is accessible using this method, as well as
JsonParser.getBinaryValue()
.
getEmbeddedObject
in class JsonParser
null otherwise
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic byte[] getBinaryValue(Base64Variant b64variant) throws IOException
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
- for low-level read issues, or
JsonParseException
for decoding problemspublic int readBinaryValue(Base64Variant b64variant, OutputStream out) throws IOException
JsonParser
JsonParser.readBinaryValue(OutputStream)
but allows explicitly
specifying base64 variant to use.readBinaryValue
in class JsonParser
b64variant
- base64 variant to useout
- Output stream to use for passing decoded binary dataOutputStream
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic JsonLocation getTokenLocation()
JsonParser
Note that the location is not guaranteed to be accurate (although most
implementation will try their best): some implementations may only
return JsonLocation.NA
due to not having access
to input location information (when delegating actual decoding work
to other library)
getTokenLocation
in class JsonParser
public JsonToken nextToken() throws IOException
JsonParser
nextToken
in class JsonParser
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic JsonToken nextValue() throws IOException
JsonParser
JsonToken.FIELD_NAME
is returned, another
time to get the value for the field.
Method is most useful for iterating over value entries
of JSON objects; field name will still be available
by calling JsonParser.getCurrentName()
when parser points to
the value.nextValue
in class JsonParser
JsonToken.NOT_AVAILABLE
if no tokens were
available yet)IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic void finishToken() throws IOException
JsonParser
JsonParser.getTextCharacters()
, would
achieve).
Note that for many dataformat implementations this method will not do anything; this is the default implementation unless overridden by sub-classes.
finishToken
in class JsonParser
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic JsonParser skipChildren() throws IOException
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
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean canReadObjectId()
JsonParser
Default 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 JsonParser
True
if the format being read supports native Object Ids;
false
if notpublic boolean canReadTypeId()
JsonParser
Default 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 JsonParser
True
if the format being read supports native Type Ids;
false
if notpublic Object getObjectId() throws IOException
JsonParser
JsonParser.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 JsonParser
null
if noneIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic Object getTypeId() throws IOException
JsonParser
JsonParser.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 JsonParser
null
if noneIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic JsonParser delegate()
JsonParser
this parser delegates calls to.Copyright © 2021 JBoss by Red Hat. All rights reserved.