public class TreeTraversingParser extends ParserMinimalBase
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.JsonParser.Feature, JsonParser.NumberType| Modifier and Type | Field and Description |
|---|---|
protected boolean |
_closed
Flag that indicates whether parser is closed or not.
|
protected com.fasterxml.jackson.databind.node.NodeCursor |
_nodeCursor
Traversal context within tree
|
protected ObjectCodec |
_objectCodec |
_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_features, _requestPayload, DEFAULT_READ_CAPABILITIES| Constructor and Description |
|---|
TreeTraversingParser(JsonNode n) |
TreeTraversingParser(JsonNode n,
ObjectCodec codec) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
_handleEOF()
Method sub-classes need to implement
|
void |
close()
Closes the parser so that no further iteration or data access
can be made; will also close the underlying input source
if parser either owns the input source, or feature
JsonParser.Feature.AUTO_CLOSE_SOURCE is enabled. |
protected JsonNode |
currentNode() |
protected JsonNode |
currentNumericNode() |
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.
|
ObjectCodec |
getCodec()
Accessor for
ObjectCodec associated with this
parser, if any. |
JsonLocation |
getCurrentLocation()
Method that returns location of the last processed character;
usually for error reporting purposes.
|
String |
getCurrentName()
|
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. |
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. |
long |
getLongValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_INT and
it can be expressed as a Java long primitive type. |
JsonParser.NumberType |
getNumberType()
If current token is of type
JsonToken.VALUE_NUMBER_INT or
JsonToken.VALUE_NUMBER_FLOAT, returns
one of JsonParser.NumberType constants; otherwise returns null. |
Number |
getNumberValue()
Generic number value accessor method that will work for
all kinds of numeric values.
|
JsonStreamContext |
getParsingContext()
Method that can be used to access current parsing context reader
is in.
|
JacksonFeatureSet<StreamReadCapability> |
getReadCapabilities()
Accessor for getting metadata on capabilities of this parser, based on
underlying data format being read (directly or indirectly).
|
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 |
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 |
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 for
JsonToken.VALUE_NUMBER_FLOAT. |
JsonToken |
nextToken()
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 to
JsonParser.readBinaryValue(OutputStream) but allows explicitly
specifying base64 variant to use. |
void |
setCodec(ObjectCodec c)
Setter that allows defining
ObjectCodec associated with this
parser, if any. |
JsonParser |
skipChildren()
Method that will skip all child tokens of an array or
object token that the parser currently points to,
iff stream points to
JsonToken.START_OBJECT or JsonToken.START_ARRAY. |
Version |
version()
Accessor for getting version of the core package, given a parser instance.
|
_ascii, _asciiBytes, _constructError, _decodeBase64, _getCharDesc, _hasTextualNull, _longIntegerDesc, _longNumberDesc, _reportError, _reportError, _reportError, _reportInputCoercion, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportInvalidEOFInValue, _reportMissingRootWS, _reportUnexpectedChar, _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_codec, _constructError, _reportUnsupportedOperation, canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentName, 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, setSchemaprotected ObjectCodec _objectCodec
protected com.fasterxml.jackson.databind.node.NodeCursor _nodeCursor
protected boolean _closed
close()) or when end-of-input is reached.public TreeTraversingParser(JsonNode n)
public TreeTraversingParser(JsonNode n, ObjectCodec codec)
public void setCodec(ObjectCodec c)
JsonParserObjectCodec associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).setCodec in class JsonParserc - Codec to assign, if any; null if nonepublic ObjectCodec getCodec()
JsonParserObjectCodec associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).getCodec in class JsonParsernull if nonepublic Version version()
JsonParserversion in interface Versionedversion in class JsonParserjackson-core jar that contains the classpublic JacksonFeatureSet<StreamReadCapability> getReadCapabilities()
JsonParsergetReadCapabilities in class JsonParserpublic void close()
throws IOException
JsonParserJsonParser.Feature.AUTO_CLOSE_SOURCE is enabled.
Whether parser owns the input source depends on factory
method that was used to construct instance (so check
JsonFactory for details,
but the general
idea is that if caller passes in closable resource (such
as InputStream or Reader) parser does NOT
own the source; but if it passes a reference (such as
File or URL and creates
stream or reader it does own them.close in interface Closeableclose in interface AutoCloseableclose in class ParserMinimalBaseIOException - if there is either an underlying I/O problempublic JsonToken nextToken() throws IOException, JsonParseException
JsonParsernextToken in class ParserMinimalBaseIOException - for low-level read issues, or
JsonParseException for decoding problemsJsonParseExceptionpublic JsonParser skipChildren() throws IOException
JsonParserJsonToken.START_OBJECT or JsonToken.START_ARRAY.
If not, it will do nothing.
After skipping, stream will point to matching
JsonToken.END_OBJECT or JsonToken.END_ARRAY
(possibly skipping nested pairs of START/END OBJECT/ARRAY tokens
as well as value tokens).
The idea is that after calling this method, application
will call JsonParser.nextToken() to point to the next
available token, if any.skipChildren in class ParserMinimalBaseIOException - for low-level read issues, or
JsonParseException for decoding problemspublic boolean isClosed()
JsonParserJsonParser.nextToken() (and the underlying
stream may be closed). Closing may be due to an explicit
call to JsonParser.close() or because parser has encountered
end of input.isClosed in class ParserMinimalBaseTrue if this parser instance has been closedpublic String getCurrentName()
JsonParsergetCurrentName in class ParserMinimalBasepublic void overrideCurrentName(String name)
JsonParserNote that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
overrideCurrentName in class ParserMinimalBasename - Name to use as the current name; may be null.public JsonStreamContext getParsingContext()
JsonParsergetParsingContext in class ParserMinimalBaseJsonStreamContext) associated with this parserpublic 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 JsonParserpublic 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 JsonParserpublic String getText()
JsonParserJsonParser.nextToken(), or
after encountering end-of-input), returns null.
Method can be called for any token type.getText in class ParserMinimalBaseJsonParser.nextToken() or other iteration methods)public char[] getTextCharacters()
throws IOException,
JsonParseException
JsonParserJsonParser.getText(), but that will return
underlying (unmodifiable) character array that contains
textual value, instead of constructing a String object
to contain this information.
Note, however, that:
JsonParser.getTextOffset()) to
know the actual offset
JsonParser.getTextLength()
for actual length of returned content.
Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.
The only reason to call this method (over JsonParser.getText())
is to avoid construction of a String object (which
will make a copy of contents).
getTextCharacters in class ParserMinimalBaseIOException - for low-level read issues, or
JsonParseException for decoding problemsJsonParseExceptionpublic int getTextLength()
throws IOException,
JsonParseException
JsonParserJsonParser.getTextCharacters(), to know length
of String stored in returned buffer.getTextLength in class ParserMinimalBaseJsonParser.getTextCharacters() that are part of
textual content of the current token.IOException - for low-level read issues, or
JsonParseException for decoding problemsJsonParseExceptionpublic int getTextOffset()
throws IOException,
JsonParseException
JsonParserJsonParser.getTextCharacters(), to know offset
of the first text content character within buffer.getTextOffset in class ParserMinimalBaseJsonParser.getTextCharacters() that is part of
textual content of the current token.IOException - for low-level read issues, or
JsonParseException for decoding problemsJsonParseExceptionpublic boolean hasTextCharacters()
JsonParserJsonParser.getTextCharacters() would be the most efficient
way to access textual content for the event parser currently
points to.
Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.
hasTextCharacters in class ParserMinimalBaseJsonParser.getTextCharacters(); false
means that it may or may not existpublic JsonParser.NumberType getNumberType() throws IOException
JsonParserJsonToken.VALUE_NUMBER_INT or
JsonToken.VALUE_NUMBER_FLOAT, returns
one of JsonParser.NumberType constants; otherwise returns null.getNumberType in class JsonParsernull otherwiseIOException - for low-level read issues, or
JsonParseException for decoding problemspublic BigInteger getBigIntegerValue() throws IOException
JsonParserJsonToken.VALUE_NUMBER_INT and
it can not be used as a Java long primitive type due to its
magnitude.
It can also be called for JsonToken.VALUE_NUMBER_FLOAT;
if so, it is equivalent to calling JsonParser.getDecimalValue()
and then constructing a BigInteger from that value.getBigIntegerValue in class JsonParserBigInteger (if numeric token);
otherwise exception thrownIOException - for low-level read issues, or
JsonParseException for decoding problemspublic BigDecimal getDecimalValue() throws IOException
JsonParserJsonToken.VALUE_NUMBER_FLOAT or
JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions
are ever thrown.getDecimalValue in class JsonParserBigDecimal (if numeric token);
otherwise exception thrownIOException - for low-level read issues, or
JsonParseException for decoding problemspublic double getDoubleValue()
throws IOException
JsonParserJsonToken.VALUE_NUMBER_FLOAT and
it can be expressed as a Java double primitive type.
It can also be called for JsonToken.VALUE_NUMBER_INT;
if so, it is equivalent to calling JsonParser.getLongValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the value falls
outside of range of Java double, a InputCoercionException
will be thrown to indicate numeric overflow/underflow.
getDoubleValue in class JsonParserdouble (if numeric token within
Java double range); otherwise exception thrownIOException - for low-level read issues, or
JsonParseException for decoding problemspublic float getFloatValue()
throws IOException
JsonParserJsonToken.VALUE_NUMBER_FLOAT and
it can be expressed as a Java float primitive type.
It can also be called for JsonToken.VALUE_NUMBER_INT;
if so, it is equivalent to calling JsonParser.getLongValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the value falls
outside of range of Java float, a InputCoercionException
will be thrown to indicate numeric overflow/underflow.
getFloatValue in class JsonParserfloat (if numeric token within
Java float range); otherwise exception thrownIOException - for low-level read issues, or
JsonParseException for decoding problemspublic int getIntValue()
throws IOException
JsonParserJsonToken.VALUE_NUMBER_INT and
it can be expressed as a value of Java int primitive type.
It can also be called for JsonToken.VALUE_NUMBER_FLOAT;
if so, it is equivalent to calling JsonParser.getDoubleValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the resulting integer value falls outside range of
Java int, a InputCoercionException
may be thrown to indicate numeric overflow/underflow.
getIntValue in class JsonParserint (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
JsonParserJsonToken.VALUE_NUMBER_INT and
it can be expressed as a Java long primitive type.
It can also be called for JsonToken.VALUE_NUMBER_FLOAT;
if so, it is equivalent to calling JsonParser.getDoubleValue()
and then casting to int; except for possible overflow/underflow
exception.
Note: if the token is an integer, but its value falls
outside of range of Java long, a InputCoercionException
may be thrown to indicate numeric overflow/underflow.
getLongValue in class JsonParserlong (if numeric token within
Java 32-bit signed long range); otherwise exception thrownIOException - for low-level read issues, or
JsonParseException for decoding problemspublic Number getNumberValue() throws IOException
JsonParsergetNumberValue in class JsonParserIOException - 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 Object getEmbeddedObject()
JsonParserJsonToken.VALUE_EMBEDDED_OBJECT. For other token types,
null is returned.
Note: only some specialized parser implementations support
embedding of objects (usually ones that are facades on top
of non-streaming sources, such as object trees). 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 JsonParsernull otherwisepublic boolean isNaN()
JsonParserJsonToken.VALUE_NUMBER_FLOAT.
NOTE: roughly equivalent to calling !Double.isFinite()
on value you would get from calling JsonParser.getDoubleValue().isNaN in class JsonParserTrue if the current token is of type JsonToken.VALUE_NUMBER_FLOAT
but represents a "Not a Number"; false for other tokens and regular
floating-point numberspublic byte[] getBinaryValue(Base64Variant b64variant) throws IOException, JsonParseException
JsonParserJsonParser.getText()
and decoding result (except for decoding part),
but should be significantly more performant.
Note that non-decoded textual contents of the current token are not guaranteed to be accessible after this method is called. Current implementation, for example, clears up textual content during decoding. Decoded binary content, however, will be retained until parser is advanced to the next event.
getBinaryValue in class ParserMinimalBaseb64variant - Expected variant of base64 encoded
content (see Base64Variants for definitions
of "standard" variants).IOException - for low-level read issues, or
JsonParseException for decoding problemsJsonParseExceptionpublic int readBinaryValue(Base64Variant b64variant, OutputStream out) throws IOException, JsonParseException
JsonParserJsonParser.readBinaryValue(OutputStream) but allows explicitly
specifying base64 variant to use.readBinaryValue in class JsonParserb64variant - base64 variant to useout - Output stream to use for passing decoded binary dataOutputStreamIOException - for low-level read issues, or
JsonParseException for decoding problemsJsonParseExceptionprotected JsonNode currentNode()
protected JsonNode currentNumericNode() throws JsonParseException
JsonParseExceptionprotected void _handleEOF()
throws JsonParseException
ParserMinimalBase_handleEOF in class ParserMinimalBaseJsonParseExceptionCopyright © 2021 JBoss by Red Hat. All rights reserved.