Class TreeTraversingParser
- All Implemented Interfaces:
Versioned
,Closeable
,AutoCloseable
JsonNode
that implements JsonParser
to allow
accessing contents of JSON tree in alternate form (stream of tokens).
Useful when a streaming source is expected by code, such as data binding
functionality.-
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 indicates whether parser is closed or not.protected edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.node.NodeCursor
Traversal context within treeprotected ObjectCodec
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.base.ParserMinimalBase
_currToken, _lastClearedToken, BD_MAX_INT, BD_MAX_LONG, BD_MIN_INT, BD_MIN_LONG, BI_MAX_INT, BI_MAX_LONG, BI_MIN_INT, BI_MIN_LONG, CHAR_NULL, INT_0, INT_9, INT_APOS, INT_ASTERISK, INT_BACKSLASH, INT_COLON, INT_COMMA, INT_CR, INT_e, INT_E, INT_HASH, INT_LBRACKET, INT_LCURLY, INT_LF, INT_MINUS, INT_PERIOD, INT_PLUS, INT_QUOTE, INT_RBRACKET, INT_RCURLY, INT_SLASH, INT_SPACE, INT_TAB, MAX_ERROR_TOKEN_LENGTH, MAX_INT_D, MAX_INT_L, MAX_LONG_D, MIN_INT_D, MIN_INT_L, MIN_LONG_D, NO_BYTES, NO_INTS, NR_BIGDECIMAL, NR_BIGINT, NR_DOUBLE, NR_FLOAT, NR_INT, NR_LONG, NR_UNKNOWN
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser
_features, _requestPayload, DEFAULT_READ_CAPABILITIES
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
Method sub-classes need to implement for verifying that end-of-content is acceptable at current input position.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 featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled.protected JsonNode
protected JsonNode
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.getCodec()
Accessor forObjectCodec
associated with this parser, if any.Alias forJsonParser.currentLocation()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).Alias ofJsonParser.currentName()
.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.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.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.Accessor for getting metadata on capabilities of this parser, based on underlying data format being read (directly or indirectly).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 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.boolean
isClosed()
Method that can be called to determine whether this parser is closed or not.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 forJsonToken.VALUE_NUMBER_FLOAT
.Main iteration method, which will advance stream enough to determine type of the next token, if any.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.void
Setter that allows definingObjectCodec
associated with this parser, if any.Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points toJsonToken.START_OBJECT
orJsonToken.START_ARRAY
.version()
Accessor for getting version of the core package, given a parser instance.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.base.ParserMinimalBase
_ascii, _asciiBytes, _constructError, _decodeBase64, _getCharDesc, _hasTextualNull, _longIntegerDesc, _longNumberDesc, _reportError, _reportError, _reportError, _reportInputCoercion, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportInvalidEOFInValue, _reportMissingRootWS, _reportUnexpectedChar, _reportUnexpectedNumberChar, _throwInternal, _throwInvalidSpace, _wrapError, clearCurrentToken, currentToken, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, getValueAsString, getValueAsString, hasCurrentToken, hasToken, hasTokenId, isExpectedNumberIntToken, isExpectedStartArrayToken, isExpectedStartObjectToken, nextValue, reportInvalidNumber, reportOverflowInt, reportOverflowInt, reportOverflowInt, reportOverflowLong, reportOverflowLong, reportOverflowLong, reportUnexpectedNumberChar
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser
_codec, _constructError, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _reportUnsupportedOperation, assignCurrentValue, canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentLocation, currentName, currentTokenLocation, currentValue, disable, enable, finishToken, getBinaryValue, getBooleanValue, getByteValue, getCurrentValue, getFeatureMask, getFormatFeatures, getInputSource, getNonBlockingInputFeeder, getNumberValueExact, getObjectId, getSchema, getShortValue, getText, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, overrideFormatFeatures, overrideStdFeatures, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, requiresCustomCodec, setCurrentValue, setFeatureMask, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema
-
Field Details
-
_objectCodec
-
_nodeCursor
protected edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.node.NodeCursor _nodeCursorTraversal context within tree -
_closed
protected boolean _closedFlag that indicates whether parser is closed or not. Gets set when parser is either closed by explicit call (close()
) or when end-of-input is reached.
-
-
Constructor Details
-
TreeTraversingParser
-
TreeTraversingParser
-
-
Method Details
-
setCodec
Description copied from class:JsonParser
Setter that allows definingObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
setCodec
in classJsonParser
- Parameters:
c
- Codec to assign, if any;null
if none
-
getCodec
Description copied from class:JsonParser
Accessor forObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
getCodec
in classJsonParser
- Returns:
- Codec assigned to this parser, if any;
null
if none
-
version
Description copied from class:JsonParser
Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.- Specified by:
version
in interfaceVersioned
- Specified by:
version
in classJsonParser
- Returns:
- Version of this generator (derived from version declared for
jackson-core
jar that contains the class
-
getReadCapabilities
Description copied from class:JsonParser
Accessor for getting metadata on capabilities of this parser, based on underlying data format being read (directly or indirectly).- Overrides:
getReadCapabilities
in classJsonParser
- Returns:
- Set of read capabilities for content to read via this parser
-
close
Description copied from class:JsonParser
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 featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so checkJsonFactory
for details, but the general idea is that if caller passes in closable resource (such asInputStream
orReader
) parser does NOT own the source; but if it passes a reference (such asFile
orURL
and creates stream or reader it does own them.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classParserMinimalBase
- Throws:
IOException
- if there is either an underlying I/O problem
-
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.- Specified by:
nextToken
in classParserMinimalBase
- 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
-
skipChildren
Description copied from class:JsonParser
Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points toJsonToken.START_OBJECT
orJsonToken.START_ARRAY
. If not, it will do nothing. After skipping, stream will point to matchingJsonToken.END_OBJECT
orJsonToken.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 callJsonParser.nextToken()
to point to the next available token, if any.- Overrides:
skipChildren
in classParserMinimalBase
- Returns:
- This parser, to allow call chaining
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
isClosed
public boolean isClosed()Description copied from class:JsonParser
Method that can be called to determine whether this parser is closed or not. If it is closed, no new tokens can be retrieved by callingJsonParser.nextToken()
(and the underlying stream may be closed). Closing may be due to an explicit call toJsonParser.close()
or because parser has encountered end of input.- Specified by:
isClosed
in classParserMinimalBase
- Returns:
True
if this parser instance has been closed
-
getCurrentName
Description copied from class:JsonParser
Alias ofJsonParser.currentName()
.- Specified by:
getCurrentName
in classParserMinimalBase
- Returns:
- Name of the current field in the parsing context
-
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.
- Specified by:
overrideCurrentName
in classParserMinimalBase
- Parameters:
name
- Name to use as the current name; may be null.
-
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.- Specified by:
getParsingContext
in classParserMinimalBase
- Returns:
- Stream input context (
JsonStreamContext
) associated with this parser
-
getTokenLocation
Description copied from class:JsonParser
Alias forJsonParser.currentTokenLocation()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).- Specified by:
getTokenLocation
in classJsonParser
- Returns:
- Starting location of the token parser currently points to
-
getCurrentLocation
Description copied from class:JsonParser
Alias forJsonParser.currentLocation()
, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).- Specified by:
getCurrentLocation
in classJsonParser
- Returns:
- Location of the last processed input unit (byte or character)
-
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.- Specified by:
getText
in classParserMinimalBase
- Returns:
- Textual value associated with the current token (one returned
by
JsonParser.nextToken()
or other iteration methods)
-
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).- Specified by:
getTextCharacters
in classParserMinimalBase
- 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.- Specified by:
getTextLength
in classParserMinimalBase
- 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.- Specified by:
getTextOffset
in classParserMinimalBase
- 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
-
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.
- Specified by:
hasTextCharacters
in classParserMinimalBase
- 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
-
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.- Specified by:
getNumberType
in classJsonParser
- Returns:
- Type of current number, if parser points to numeric token;
null
otherwise - 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.- Specified by:
getBigIntegerValue
in classJsonParser
- Returns:
- Current number value as
BigInteger
(if numeric token); 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.- Specified by:
getDecimalValue
in classJsonParser
- 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.- Specified by:
getDoubleValue
in classJsonParser
- 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.- Specified by:
getFloatValue
in classJsonParser
- 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.- Specified by:
getIntValue
in classJsonParser
- 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.- Specified by:
getLongValue
in classJsonParser
- 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
-
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.- Specified by:
getNumberValue
in classJsonParser
- 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)
-
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 classJsonParser
- Returns:
- Embedded value (usually of "native" type supported by format)
for the current token, if any;
null otherwise
-
isNaN
public boolean isNaN()Description copied from class:JsonParser
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 forJsonToken.VALUE_NUMBER_FLOAT
. NOTE: roughly equivalent to calling!Double.isFinite()
on value you would get from callingJsonParser.getDoubleValue()
.- Overrides:
isNaN
in classJsonParser
- Returns:
True
if the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
but represents a "Not a Number";false
for other tokens and regular floating-point numbers
-
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.
- Specified by:
getBinaryValue
in classParserMinimalBase
- 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 classJsonParser
- 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
-
currentNode
-
currentNumericNode
- Throws:
JacksonException
-
_handleEOF
protected void _handleEOF()Description copied from class:ParserMinimalBase
Method sub-classes need to implement for verifying that end-of-content is acceptable at current input position.- Specified by:
_handleEOF
in classParserMinimalBase
-