public class FilteringParserDelegate extends JsonParserDelegate
JsonParserDelegate
that allows use of
TokenFilter
for outputting a subset of content that
is visible to callerJsonParser.Feature, JsonParser.NumberType
Modifier and Type | Field and Description |
---|---|
protected boolean |
_allowMultipleMatches
Flag that determines whether filtering will continue after the first
match is indicated or not: if `false`, output is based on just the first
full match (returning
TokenFilter.INCLUDE_ALL ) and no more
checks are made; if `true` then filtering will be applied as necessary
until end of content. |
protected JsonToken |
_currToken
Last token retrieved via
nextToken() , if any. |
protected TokenFilterContext |
_exposedContext
In cases where
_headContext is "ahead" of context exposed to
caller, this context points to what is currently exposed to caller. |
protected TokenFilterContext |
_headContext
During traversal this is the actual "open" parse tree, which sometimes
is the same as
_exposedContext , and at other times is ahead
of it. |
protected TokenFilter.Inclusion |
_inclusion
Flag that determines whether path leading up to included content should
also be automatically included or not.
|
protected TokenFilter |
_itemFilter
State that applies to the item within container, used where applicable.
|
protected JsonToken |
_lastClearedToken
Last cleared token, if any: that is, value that was in
effect when
clearCurrentToken() was called. |
protected int |
_matchCount
Number of tokens for which
TokenFilter.INCLUDE_ALL
has been returned. |
protected TokenFilter |
rootFilter
Object consulted to determine whether to write parts of content generator
is asked to write or not.
|
delegate
_features, _requestPayload, DEFAULT_READ_CAPABILITIES
Constructor and Description |
---|
FilteringParserDelegate(JsonParser p,
TokenFilter f,
boolean includePath,
boolean allowMultipleMatches)
Deprecated.
|
FilteringParserDelegate(JsonParser p,
TokenFilter f,
TokenFilter.Inclusion inclusion,
boolean allowMultipleMatches) |
Modifier and Type | Method and Description |
---|---|
protected JsonStreamContext |
_filterContext() |
protected JsonToken |
_nextToken2()
Offlined handling for cases where there was no buffered token to
return, and the token read next could not be returned as-is,
at least not yet, but where we have not yet established that
buffering is needed.
|
protected JsonToken |
_nextTokenWithBuffering(TokenFilterContext buffRoot)
Method called when a new potentially included context is found.
|
void |
clearCurrentToken()
Method called to "consume" the current token by effectively
removing it so that
JsonParser.hasCurrentToken() returns false, and
JsonParser.getCurrentToken() null). |
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). |
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. |
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.
|
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 . |
TokenFilter |
getFilter() |
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. |
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. |
int |
getMatchCount()
Accessor for finding number of matches, where specific token and sub-tree
starting (if structured type) are passed.
|
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 |
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 |
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. |
JsonParser |
skipChildren()
Need to override, re-implement similar to how method defined in
ParserMinimalBase , to keep
state correct here. |
canReadObjectId, canReadTypeId, canUseSchema, close, delegate, disable, enable, finishToken, getCodec, getCurrentValue, getFeatureMask, getInputSource, getNumberValueExact, getObjectId, getReadCapabilities, getSchema, getText, getTypeId, isClosed, isEnabled, isExpectedNumberIntToken, isNaN, overrideFormatFeatures, overrideStdFeatures, requiresCustomCodec, setCodec, setCurrentValue, setFeatureMask, setSchema, version
_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 TokenFilter rootFilter
protected boolean _allowMultipleMatches
TokenFilter.INCLUDE_ALL
) and no more
checks are made; if `true` then filtering will be applied as necessary
until end of content.protected TokenFilter.Inclusion _inclusion
protected JsonToken _currToken
nextToken()
, if any.
Null before the first call to nextToken()
,
as well as if token has been explicitly clearedprotected JsonToken _lastClearedToken
clearCurrentToken()
was called.protected TokenFilterContext _headContext
_exposedContext
, and at other times is ahead
of it. Note that this context is never null.protected TokenFilterContext _exposedContext
_headContext
is "ahead" of context exposed to
caller, this context points to what is currently exposed to caller.
When the two are in sync, this context reference will be null
.protected TokenFilter _itemFilter
protected int _matchCount
TokenFilter.INCLUDE_ALL
has been returned.@Deprecated public FilteringParserDelegate(JsonParser p, TokenFilter f, boolean includePath, boolean allowMultipleMatches)
public FilteringParserDelegate(JsonParser p, TokenFilter f, TokenFilter.Inclusion inclusion, boolean allowMultipleMatches)
public TokenFilter getFilter()
public int getMatchCount()
public JsonToken getCurrentToken()
JsonParser
JsonParser.currentToken()
, may be deprecated sometime after
Jackson 2.12 (will be removed from 3.0).getCurrentToken
in class JsonParserDelegate
public JsonToken currentToken()
JsonParser
currentToken
in class JsonParserDelegate
@Deprecated public final int getCurrentTokenId()
JsonParser
JsonParser.currentTokenId()
.getCurrentTokenId
in class JsonParserDelegate
int
matching one of constants from JsonTokenId
.public final 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 JsonParserDelegate
int
matching one of constants from JsonTokenId
.public boolean hasCurrentToken()
JsonParser
parser.getCurrentToken() != null
.hasCurrentToken
in class JsonParserDelegate
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 JsonParserDelegate
id
- Token id to match (from (@link JsonTokenId})True
if the parser current points to specified tokenpublic final 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 JsonParserDelegate
t
- Token to matchTrue
if the parser current points to specified tokenpublic 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 JsonParserDelegate
JsonToken.START_ARRAY
);
false
if notpublic boolean isExpectedStartObjectToken()
JsonParser
JsonParser.isExpectedStartArrayToken()
, but checks whether stream
currently points to JsonToken.START_OBJECT
.isExpectedStartObjectToken
in class JsonParserDelegate
JsonToken.START_OBJECT
);
false
if notpublic 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 JsonParserDelegate
public JsonStreamContext getParsingContext()
JsonParser
getParsingContext
in class JsonParserDelegate
JsonStreamContext
) associated with this parserpublic String getCurrentName() throws IOException
JsonParser
getCurrentName
in class JsonParserDelegate
IOException
- 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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
name
- Name to use as the current name; may be null.public JsonToken nextToken() throws IOException
JsonParser
nextToken
in class JsonParserDelegate
IOException
- for low-level read issues, or
JsonParseException
for decoding problemsprotected final JsonToken _nextToken2() throws IOException
IOException
protected final JsonToken _nextTokenWithBuffering(TokenFilterContext buffRoot) throws IOException
IOException
public 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 JsonParserDelegate
JsonToken.NOT_AVAILABLE
if no tokens were
available yet)IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic JsonParser skipChildren() throws IOException
ParserMinimalBase
, to keep
state correct here.skipChildren
in class JsonParserDelegate
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic 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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
JsonParser.getTextCharacters()
that is part of
textual content of the current token.IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic 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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
null
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic Number getNumberValue() throws IOException
JsonParser
getNumberValue
in class JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
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 JsonParserDelegate
protected JsonStreamContext _filterContext()
Copyright © 2021 JBoss by Red Hat. All rights reserved.