Class FilteringParserDelegate
- All Implemented Interfaces:
Versioned
,Closeable
,AutoCloseable
JsonParserDelegate
that allows use of
TokenFilter
for outputting a subset of content that
is visible to caller- Since:
- 2.6
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser
JsonParser.Feature, JsonParser.NumberType
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
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 (returningTokenFilter.INCLUDE_ALL
) and no more checks are made; if `true` then filtering will be applied as necessary until end of content.protected JsonToken
Last token retrieved vianextToken()
, if any.protected TokenFilterContext
In cases where_headContext
is "ahead" of context exposed to caller, this context points to what is currently exposed to caller.protected TokenFilterContext
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
Flag that determines whether path leading up to included content should also be automatically included or not.protected TokenFilter
State that applies to the item within container, used where applicable.protected JsonToken
Last cleared token, if any: that is, value that was in effect whenclearCurrentToken()
was called.protected int
Number of tokens for whichTokenFilter.INCLUDE_ALL
has been returned.protected TokenFilter
Object consulted to determine whether to write parts of content generator is asked to write or not.Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.util.JsonParserDelegate
delegate
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser
_features, _requestPayload, DEFAULT_READ_CAPABILITIES
-
Constructor Summary
ConstructorDescriptionFilteringParserDelegate
(JsonParser p, TokenFilter f, boolean includePath, boolean allowMultipleMatches) Deprecated.FilteringParserDelegate
(JsonParser p, TokenFilter f, TokenFilter.Inclusion inclusion, boolean allowMultipleMatches) -
Method Summary
Modifier and TypeMethodDescriptionprotected JsonStreamContext
protected final JsonToken
protected final JsonToken
_nextTokenWithBuffering
(TokenFilterContext buffRoot) void
Method called to "consume" the current token by effectively removing it so thatJsonParser.hasCurrentToken()
returns false, andJsonParser.getCurrentToken()
null).Method that can be called to get the name associated with the current token: forJsonToken.FIELD_NAME
s it will be the same as whatJsonParser.getText()
returns; for field values it will be preceding field name; and for others (array values, root-level values) null.Accessor to find which token parser currently points to, if any; null will be returned if none.final int
Method similar toJsonParser.getCurrentToken()
but that returns anint
instead ofJsonToken
(enum value).Numeric accessor that can be called when the current token is of typeJsonToken.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
Convenience accessor that can be called when the current token isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
, to return matchingboolean
value.byte
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java byte primitive type.Alias forJsonParser.currentLocation()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).Alias ofJsonParser.currentName()
.Alias forJsonParser.currentToken()
, may be deprecated sometime after Jackson 2.13 (will be removed from 3.0).final int
Deprecated.Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
orJsonToken.VALUE_NUMBER_INT
.double
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java double primitive type.Accessor that can be called if (and only if) the current token isJsonToken.VALUE_EMBEDDED_OBJECT
.float
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java float primitive type.int
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java int primitive type.Method that can be called to get the last token that was cleared usingJsonParser.clearCurrentToken()
.long
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a Java long primitive type.int
Accessor for finding number of matches, where specific token and sub-tree starting (if structured type) are passed.If current token is of typeJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
, returns one ofJsonParser.NumberType
constants; otherwise returns null.Generic number value accessor method that will work for all kinds of numeric values.Method that can be used to access current parsing context reader is in.short
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java short primitive type.getText()
Method for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken()
, or after encountering end-of-input), returns null.char[]
Method similar toJsonParser.getText()
, but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.int
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.int
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.Alias forJsonParser.currentTokenLocation()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).boolean
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
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
Method that will try to convert value of current token to a Javaint
value.int
getValueAsInt
(int defaultValue) Method that will try to convert value of current token to a int.long
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.Method that will try to convert value of current token to aString
.getValueAsString
(String defaultValue) Method that will try to convert value of current token to aString
.boolean
Method for checking whether parser currently points to a token (and data for that token is available).boolean
Method that can be used to determine whether calling ofJsonParser.getTextCharacters()
would be the most efficient way to access textual content for the event parser currently points to.final boolean
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
Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token isJsonToken.START_ARRAY
) when start array is expected.boolean
Similar toJsonParser.isExpectedStartArrayToken()
, but checks whether stream currently points toJsonToken.START_OBJECT
.Main iteration method, which will advance stream enough to determine type of the next token, if any.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 toJsonParser.readBinaryValue(OutputStream)
but allows explicitly specifying base64 variant to use.Need to override, re-implement similar to how method defined inParserMinimalBase
, to keep state correct here.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.util.JsonParserDelegate
assignCurrentValue, canReadObjectId, canReadTypeId, canUseSchema, close, currentLocation, currentTokenLocation, currentValue, 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
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser
_codec, _constructError, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _reportUnsupportedOperation, canParseAsync, configure, getBinaryValue, getFormatFeatures, getNonBlockingInputFeeder, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError
-
Field Details
-
rootFilter
Object consulted to determine whether to write parts of content generator is asked to write or not. -
_allowMultipleMatches
protected boolean _allowMultipleMatchesFlag 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 (returningTokenFilter.INCLUDE_ALL
) and no more checks are made; if `true` then filtering will be applied as necessary until end of content. -
_inclusion
Flag that determines whether path leading up to included content should also be automatically included or not. If `false`, no path inclusion is done and only explicitly included entries are output; if `true` then path from main level down to match is also included as necessary. -
_currToken
Last token retrieved vianextToken()
, if any. Null before the first call tonextToken()
, as well as if token has been explicitly cleared -
_lastClearedToken
Last cleared token, if any: that is, value that was in effect whenclearCurrentToken()
was called. -
_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. Note that this context is never null. -
_exposedContext
In cases where_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 benull
. -
_itemFilter
State that applies to the item within container, used where applicable. Specifically used to pass inclusion state between property name and property, and also used for array elements. -
_matchCount
protected int _matchCountNumber of tokens for whichTokenFilter.INCLUDE_ALL
has been returned.
-
-
Constructor Details
-
FilteringParserDelegate
@Deprecated public FilteringParserDelegate(JsonParser p, TokenFilter f, boolean includePath, boolean allowMultipleMatches) Deprecated. -
FilteringParserDelegate
public FilteringParserDelegate(JsonParser p, TokenFilter f, TokenFilter.Inclusion inclusion, boolean allowMultipleMatches) - Parameters:
p
- Parser to delegate calls tof
- Filter to useinclusion
- Definition of inclusion criteriaallowMultipleMatches
- Whether to allow multiple matches
-
-
Method Details
-
getFilter
-
getMatchCount
public int getMatchCount()Accessor for finding number of matches, where specific token and sub-tree starting (if structured type) are passed.- Returns:
- Number of matches
-
getCurrentToken
Description copied from class:JsonParser
Alias forJsonParser.currentToken()
, may be deprecated sometime after Jackson 2.13 (will be removed from 3.0).- Overrides:
getCurrentToken
in classJsonParserDelegate
- Returns:
- Type of the token this parser currently points to, if any: null before any tokens have been read, and
-
currentToken
Description copied from class:JsonParser
Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.- Overrides:
currentToken
in classJsonParserDelegate
- Returns:
- Type of the token this parser currently points to, if any: null before any tokens have been read, and after end-of-input has been encountered, as well as if the current token has been explicitly cleared.
-
getCurrentTokenId
Deprecated.Description copied from class:JsonParser
Deprecated alias forJsonParser.currentTokenId()
.- Overrides:
getCurrentTokenId
in classJsonParserDelegate
- Returns:
int
matching one of constants fromJsonTokenId
.
-
currentTokenId
public final int currentTokenId()Description copied from class:JsonParser
Method similar toJsonParser.getCurrentToken()
but that returns anint
instead ofJsonToken
(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.
- Overrides:
currentTokenId
in classJsonParserDelegate
- Returns:
int
matching one of constants fromJsonTokenId
.
-
hasCurrentToken
public boolean hasCurrentToken()Description copied from class:JsonParser
Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check forparser.getCurrentToken() != null
.- Overrides:
hasCurrentToken
in classJsonParserDelegate
- Returns:
- True if the parser just returned a valid
token via
JsonParser.nextToken()
; false otherwise (parser was just constructed, encountered end-of-input and returned null fromJsonParser.nextToken()
, or the token has been consumed)
-
hasTokenId
public boolean hasTokenId(int id) Description copied from class:JsonParser
Method that is functionally equivalent to: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.- Overrides:
hasTokenId
in classJsonParserDelegate
- Parameters:
id
- Token id to match (from (@link JsonTokenId})- Returns:
True
if the parser current points to specified token
-
hasToken
Description copied from class:JsonParser
Method that is functionally equivalent to: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.- Overrides:
hasToken
in classJsonParserDelegate
- Parameters:
t
- Token to match- Returns:
True
if the parser current points to specified token
-
isExpectedStartArrayToken
public boolean isExpectedStartArrayToken()Description copied from class:JsonParser
Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token isJsonToken.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_ARRAY
but may be overridden by custom parser implementations.- Overrides:
isExpectedStartArrayToken
in classJsonParserDelegate
- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_ARRAY
);false
if not
-
isExpectedStartObjectToken
public boolean isExpectedStartObjectToken()Description copied from class:JsonParser
Similar toJsonParser.isExpectedStartArrayToken()
, but checks whether stream currently points toJsonToken.START_OBJECT
.- Overrides:
isExpectedStartObjectToken
in classJsonParserDelegate
- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_OBJECT
);false
if not
-
getCurrentLocation
Description copied from class:JsonParser
Alias forJsonParser.currentLocation()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).- Overrides:
getCurrentLocation
in classJsonParserDelegate
- Returns:
- Location of the last processed input unit (byte or character)
-
getParsingContext
Description copied from class:JsonParser
Method that can be used to access current parsing context reader is in. There are 3 different types: root, array and object contexts, with slightly different available information. Contexts are hierarchically nested, and can be used for example for figuring out part of the input document that correspond to specific array or object (for highlighting purposes, or error reporting). Contexts can also be used for simple xpath-like matching of input, if so desired.- Overrides:
getParsingContext
in classJsonParserDelegate
- Returns:
- Stream input context (
JsonStreamContext
) associated with this parser
-
getCurrentName
Description copied from class:JsonParser
Alias ofJsonParser.currentName()
.- Overrides:
getCurrentName
in classJsonParserDelegate
- Returns:
- Name of the current field in the parsing context
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
currentName
Description copied from class:JsonParser
Method that can be called to get the name associated with the current token: forJsonToken.FIELD_NAME
s it will be the same as whatJsonParser.getText()
returns; for field values it will be preceding field name; and for others (array values, root-level values) null.- Overrides:
currentName
in classJsonParserDelegate
- Returns:
- Name of the current field in the parsing context
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
clearCurrentToken
public void clearCurrentToken()Description copied from class:JsonParser
Method called to "consume" the current token by effectively removing it so thatJsonParser.hasCurrentToken()
returns false, andJsonParser.getCurrentToken()
null). Cleared token value can still be accessed by callingJsonParser.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).
- Overrides:
clearCurrentToken
in classJsonParserDelegate
-
getLastClearedToken
Description copied from class:JsonParser
Method that can be called to get the last token that was cleared usingJsonParser.clearCurrentToken()
. This is not necessarily the latest token read. Will return null if no tokens have been cleared, or if parser has been closed.- Overrides:
getLastClearedToken
in classJsonParserDelegate
- Returns:
- Last cleared token, if any;
null
otherwise
-
overrideCurrentName
Description copied from class:JsonParser
Method that can be used to change what is considered to be the current (field) name. May be needed to support non-JSON data formats or unusual binding conventions; not needed for typical processing.Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
- Overrides:
overrideCurrentName
in classJsonParserDelegate
- Parameters:
name
- Name to use as the current name; may be null.
-
nextToken
Description copied from class:JsonParser
Main iteration method, which will advance stream enough to determine type of the next token, if any. If none remaining (stream has no content other than possible white space before ending), null will be returned.- Overrides:
nextToken
in classJsonParserDelegate
- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
_nextToken2
- Throws:
IOException
-
_nextTokenWithBuffering
- Throws:
IOException
-
nextValue
Description copied from class:JsonParser
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). Or put another way, nextToken() will be called once, and ifJsonToken.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 callingJsonParser.getCurrentName()
when parser points to the value.- Overrides:
nextValue
in classJsonParserDelegate
- Returns:
- Next non-field-name token from the stream, if any found,
or null to indicate end-of-input (or, for non-blocking
parsers,
JsonToken.NOT_AVAILABLE
if no tokens were available yet) - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
skipChildren
Need to override, re-implement similar to how method defined inParserMinimalBase
, to keep state correct here.- Overrides:
skipChildren
in classJsonParserDelegate
- Returns:
- This parser, to allow call chaining
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getText
Description copied from class:JsonParser
Method for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken()
, or after encountering end-of-input), returns null. Method can be called for any token type.- Overrides:
getText
in classJsonParserDelegate
- Returns:
- Textual value associated with the current token (one returned
by
JsonParser.nextToken()
or other iteration methods) - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
hasTextCharacters
public boolean hasTextCharacters()Description copied from class:JsonParser
Method that can be used to determine whether calling ofJsonParser.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.
- Overrides:
hasTextCharacters
in classJsonParserDelegate
- Returns:
- True if parser currently has character array that can
be efficiently returned via
JsonParser.getTextCharacters()
; false means that it may or may not exist
-
getTextCharacters
Description copied from class:JsonParser
Method similar toJsonParser.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:- Textual contents are not guaranteed to start at
index 0 (rather, call
JsonParser.getTextOffset()
) to know the actual offset - Length of textual contents may be less than the
length of returned buffer: call
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).- Overrides:
getTextCharacters
in classJsonParserDelegate
- Returns:
- Buffer that contains the current textual value (but not necessarily at offset 0, and not necessarily until the end of buffer)
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
getTextLength
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.- Overrides:
getTextLength
in classJsonParserDelegate
- Returns:
- Number of characters within buffer returned
by
JsonParser.getTextCharacters()
that are part of textual content of the current token. - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getTextOffset
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.- Overrides:
getTextOffset
in classJsonParserDelegate
- Returns:
- Offset of the first character within buffer returned
by
JsonParser.getTextCharacters()
that is part of textual content of the current token. - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getBigIntegerValue
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can not be used as a Java long primitive type due to its magnitude. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDecimalValue()
and then constructing aBigInteger
from that value.- Overrides:
getBigIntegerValue
in classJsonParserDelegate
- Returns:
- Current number value as
BigInteger
(if numeric token); otherwise exception thrown - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getBooleanValue
Description copied from class:JsonParser
Convenience accessor that can be called when the current token isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
, to return matchingboolean
value. If the current token is of some other type,JsonParseException
will be thrown- Overrides:
getBooleanValue
in classJsonParserDelegate
- Returns:
True
if current token isJsonToken.VALUE_TRUE
,false
if current token isJsonToken.VALUE_FALSE
; otherwise throwsJsonParseException
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getByteValue
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.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 callingJsonParser.getDoubleValue()
and then casting; except for possible overflow/underflow exception.Note: if the resulting integer value falls outside range of
[-128, 255]
, aInputCoercionException
will be thrown to indicate numeric overflow/underflow.- Overrides:
getByteValue
in classJsonParserDelegate
- Returns:
- Current number value as
byte
(if numeric token within range of[-128, 255]
); otherwise exception thrown - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getShortValue
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java short primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.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.- Overrides:
getShortValue
in classJsonParserDelegate
- Returns:
- Current number value as
short
(if numeric token within Java 16-bit signedshort
range); otherwise exception thrown - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getDecimalValue
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
orJsonToken.VALUE_NUMBER_INT
. No under/overflow exceptions are ever thrown.- Overrides:
getDecimalValue
in classJsonParserDelegate
- Returns:
- Current number value as
BigDecimal
(if numeric token); otherwise exception thrown - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getDoubleValue
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java double primitive type. It can also be called forJsonToken.VALUE_NUMBER_INT
; if so, it is equivalent to callingJsonParser.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.- Overrides:
getDoubleValue
in classJsonParserDelegate
- Returns:
- Current number value as
double
(if numeric token within Javadouble
range); otherwise exception thrown - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getFloatValue
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java float primitive type. It can also be called forJsonToken.VALUE_NUMBER_INT
; if so, it is equivalent to callingJsonParser.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.- Overrides:
getFloatValue
in classJsonParserDelegate
- Returns:
- Current number value as
float
(if numeric token within Javafloat
range); otherwise exception thrown - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getIntValue
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java int primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDoubleValue()
and then casting; except for possible overflow/underflow exception.Note: if the resulting integer value falls outside range of Java
int
, aInputCoercionException
may be thrown to indicate numeric overflow/underflow.- Overrides:
getIntValue
in classJsonParserDelegate
- Returns:
- Current number value as
int
(if numeric token within Java 32-bit signedint
range); otherwise exception thrown - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getLongValue
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a Java long primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.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.- Overrides:
getLongValue
in classJsonParserDelegate
- Returns:
- Current number value as
long
(if numeric token within Java 32-bit signedlong
range); otherwise exception thrown - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getNumberType
Description copied from class:JsonParser
If current token is of typeJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
, returns one ofJsonParser.NumberType
constants; otherwise returns null.- Overrides:
getNumberType
in classJsonParserDelegate
- Returns:
- Type of current number, if parser points to numeric token;
null
otherwise - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getNumberValue
Description copied from class:JsonParser
Generic number value accessor method that will work for all kinds of numeric values. It will return the optimal (simplest/smallest possible) wrapper object that can express the numeric value just parsed.- Overrides:
getNumberValue
in classJsonParserDelegate
- Returns:
- Numeric value of the current token in its most optimal representation
- Throws:
IOException
- Problem with access:JsonParseException
if the current token is not numeric, or if decoding of the value fails (invalid format for numbers); plainIOException
if underlying content read fails (possible if values are extracted lazily)
-
getValueAsInt
Description copied from class:JsonParser
Method that will try to convert value of current token to a Javaint
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.
- Overrides:
getValueAsInt
in classJsonParserDelegate
- Returns:
int
value current token is converted to, if possible; exception thrown otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsInt
Description copied from class:JsonParser
Method that will try to convert value of current token to a int. 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) specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsInt
in classJsonParserDelegate
- Parameters:
defaultValue
- Default value to return if conversion toint
is not possible- Returns:
int
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsLong
Description copied from class:JsonParser
Method that will try to convert value of current token to a long. 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 a long (including structured type markers like start/end Object/Array) default value of 0L will be returned; no exceptions are thrown.
- Overrides:
getValueAsLong
in classJsonParserDelegate
- Returns:
long
value current token is converted to, if possible; exception thrown otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsLong
Description copied from class:JsonParser
Method that will try to convert value of current token to a long. 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 a long (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsLong
in classJsonParserDelegate
- Parameters:
defaultValue
- Default value to return if conversion tolong
is not possible- Returns:
long
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsDouble
Description copied from class:JsonParser
Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language floating point parsing rules.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.
- Overrides:
getValueAsDouble
in classJsonParserDelegate
- Returns:
double
value current token is converted to, if possible; exception thrown otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsDouble
Description copied from class:JsonParser
Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language floating point parsing rules.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.
- Overrides:
getValueAsDouble
in classJsonParserDelegate
- Parameters:
defaultValue
- Default value to return if conversion todouble
is not possible- Returns:
double
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsBoolean
Description copied from class:JsonParser
Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.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.
- Overrides:
getValueAsBoolean
in classJsonParserDelegate
- Returns:
boolean
value current token is converted to, if possible; exception thrown otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsBoolean
Description copied from class:JsonParser
Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.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.
- Overrides:
getValueAsBoolean
in classJsonParserDelegate
- Parameters:
defaultValue
- Default value to return if conversion toboolean
is not possible- Returns:
boolean
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsString
Description copied from class:JsonParser
Method that will try to convert value of current token to aString
. 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 andnull
token), default value of null will be returned; no exceptions are thrown.- Overrides:
getValueAsString
in classJsonParserDelegate
- Returns:
String
value current token is converted to, if possible;null
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsString
Description copied from class:JsonParser
Method that will try to convert value of current token to aString
. 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 andnull
token), specified default value will be returned; no exceptions are thrown.- Overrides:
getValueAsString
in classJsonParserDelegate
- Parameters:
defaultValue
- Default value to return if conversion toString
is not possible- Returns:
String
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getEmbeddedObject
Description copied from class:JsonParser
Accessor that can be called if (and only if) the current token isJsonToken.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()
.- Overrides:
getEmbeddedObject
in classJsonParserDelegate
- Returns:
- Embedded value (usually of "native" type supported by format)
for the current token, if any;
null otherwise
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getBinaryValue
Description copied from class:JsonParser
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. It works similar to getting String value viaJsonParser.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.
- Overrides:
getBinaryValue
in classJsonParserDelegate
- Parameters:
b64variant
- Expected variant of base64 encoded content (seeBase64Variants
for definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
readBinaryValue
Description copied from class:JsonParser
Similar toJsonParser.readBinaryValue(OutputStream)
but allows explicitly specifying base64 variant to use.- Overrides:
readBinaryValue
in classJsonParserDelegate
- Parameters:
b64variant
- base64 variant to useout
- Output stream to use for passing decoded binary data- Returns:
- Number of bytes that were decoded and written via
OutputStream
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getTokenLocation
Description copied from class:JsonParser
Alias forJsonParser.currentTokenLocation()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).- Overrides:
getTokenLocation
in classJsonParserDelegate
- Returns:
- Starting location of the token parser currently points to
-
_filterContext
-