public abstract class ParserBase extends ParserMinimalBase
JsonParser
implementations. Contains most common things that are independent
of actual underlying input source.JsonParser.Feature, JsonParser.NumberType| Modifier and Type | Field and Description |
|---|---|
protected byte[] |
_binaryValue
We will hold on to decoded binary data, for duration of
current event, so that multiple calls to
getBinaryValue(com.fasterxml.jackson.core.Base64Variant) will not need to decode data more
than once. |
protected ByteArrayBuilder |
_byteArrayBuilder
ByteArrayBuilder is needed if 'getBinaryValue' is called.
|
protected boolean |
_closed
Flag that indicates whether parser is closed or not.
|
protected long |
_currInputProcessed
Number of characters/bytes that were contained in previous blocks
(blocks that were already processed prior to the current buffer).
|
protected int |
_currInputRow
Current row location of current point in input buffer, starting
from 1, if available.
|
protected int |
_currInputRowStart
Current index of the first character of the current row in input
buffer.
|
protected int |
_expLength
Length of the exponent part of the number, if any, not
including 'e' marker or sign, just digits.
|
protected int |
_fractLength
Length of the fractional part (not including decimal
point or exponent), in characters.
|
protected int |
_inputEnd
Index of character after last available one in the buffer.
|
protected int |
_inputPtr
Pointer to next available character in buffer
|
protected int |
_intLength
Length of integer part of the number, in characters
|
protected IOContext |
_ioContext
I/O context for this reader.
|
protected boolean |
_nameCopied
Flag set to indicate whether the field name is available
from the name copy buffer or not (in addition to its String
representation being available via read context)
|
protected char[] |
_nameCopyBuffer
Temporary buffer that is needed if field name is accessed
using
ParserMinimalBase.getTextCharacters() method (instead of String
returning alternatives) |
protected JsonToken |
_nextToken
Secondary token related to the next token after current one;
used if its type is known.
|
protected BigDecimal |
_numberBigDecimal |
protected BigInteger |
_numberBigInt |
protected double |
_numberDouble |
protected int |
_numberInt |
protected long |
_numberLong |
protected boolean |
_numberNegative
Flag that indicates whether numeric value has a negative
value.
|
protected int |
_numTypesValid
Bitfield that indicates which numeric representations
have been calculated for the current type
|
protected JsonReadContext |
_parsingContext
Information about parser context, context in which
the next token is to be parsed (root, array, object).
|
protected TextBuffer |
_textBuffer
Buffer that contains contents of String values, including
field names if necessary (name split across boundary,
contains escape sequence, or access needed to char array)
|
protected int |
_tokenInputCol
Column on input row that current token starts; 0-based (although
in the end it'll be converted to 1-based)
|
protected int |
_tokenInputRow
Input row on which current token starts, 1-based
|
protected long |
_tokenInputTotal
Total number of bytes/characters read before start of current token.
|
_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| Modifier | Constructor and Description |
|---|---|
protected |
ParserBase(IOContext ctxt,
int features) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
_checkStdFeatureChanges(int newFeatureFlags,
int changedFeatures)
Helper method called to verify changes to standard features.
|
protected abstract void |
_closeInput() |
protected int |
_decodeBase64Escape(Base64Variant b64variant,
char ch,
int index) |
protected int |
_decodeBase64Escape(Base64Variant b64variant,
int ch,
int index) |
protected char |
_decodeEscaped()
Method that sub-classes must implement to support escaped sequences
in base64-encoded sections.
|
protected int |
_eofAsNextChar() |
protected void |
_finishString() |
ByteArrayBuilder |
_getByteArrayBuilder() |
protected Object |
_getSourceReference()
Helper method used to encapsulate logic of including (or not) of
"source reference" when constructing
JsonLocation instances. |
protected void |
_handleBase64MissingPadding(Base64Variant b64variant) |
protected void |
_handleEOF()
Method called when an EOF is encountered between tokens.
|
protected char |
_handleUnrecognizedCharacterEscape(char ch) |
protected int |
_parseIntValue() |
protected void |
_parseNumericValue(int expType)
Method that will parse actual numeric value out of a syntactically
valid number value.
|
protected void |
_releaseBuffers()
Method called to release internal buffers owned by the base
reader.
|
protected void |
_reportMismatchedEndMarker(int actCh,
char expCh) |
protected void |
_reportTooLongIntegral(int expType,
String rawNum) |
protected void |
_throwUnquotedSpace(int i,
String ctxtDesc)
Method called to report a problem with unquoted control character.
|
protected String |
_validJsonTokenList() |
protected String |
_validJsonValueList() |
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 void |
convertNumberToBigDecimal() |
protected void |
convertNumberToBigInteger() |
protected void |
convertNumberToDouble() |
protected void |
convertNumberToInt() |
protected void |
convertNumberToLong() |
JsonParser |
disable(JsonParser.Feature f)
Method for disabling specified feature
(check
JsonParser.Feature for list of features) |
JsonParser |
enable(JsonParser.Feature f)
Method for enabling specified parser feature
(check
JsonParser.Feature for list of features) |
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 variant)
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.
|
JsonLocation |
getCurrentLocation()
Method that returns location of the last processed character;
usually for error reporting purposes
|
String |
getCurrentName()
Method that can be called to get the name associated with
the current event.
|
Object |
getCurrentValue()
Helper method, usually equivalent to:
getParsingContext().getCurrentValue();
|
BigDecimal |
getDecimalValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_FLOAT or
JsonToken.VALUE_NUMBER_INT. |
double |
getDoubleValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_FLOAT and
it can be expressed as a Java double primitive type. |
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.
|
JsonReadContext |
getParsingContext()
Method that can be used to access current parsing context reader
is in.
|
long |
getTokenCharacterOffset() |
int |
getTokenColumnNr() |
int |
getTokenLineNr() |
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.
|
protected static int[] |
growArrayBy(int[] arr,
int more) |
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. |
protected boolean |
loadMore()
Deprecated.
|
protected void |
loadMoreGuaranteed()
Deprecated.
|
void |
overrideCurrentName(String name)
Method that can be used to change what is considered to be
the current (field) name.
|
JsonParser |
overrideStdFeatures(int values,
int mask)
Bulk set method for (re)setting states of features specified by
mask. |
protected IllegalArgumentException |
reportInvalidBase64Char(Base64Variant b64variant,
int ch,
int bindex) |
protected IllegalArgumentException |
reportInvalidBase64Char(Base64Variant b64variant,
int ch,
int bindex,
String msg) |
protected JsonToken |
reset(boolean negative,
int intLen,
int fractLen,
int expLen) |
protected JsonToken |
resetAsNaN(String valueStr,
double value) |
protected JsonToken |
resetFloat(boolean negative,
int intLen,
int fractLen,
int expLen) |
protected JsonToken |
resetInt(boolean negative,
int intLen) |
void |
setCurrentValue(Object v)
Helper method, usually equivalent to:
getParsingContext().setCurrentValue(v);
|
JsonParser |
setFeatureMask(int newMask)
Deprecated.
|
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, getText, getTextCharacters, getTextLength, getTextOffset, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, getValueAsString, getValueAsString, hasCurrentToken, hasToken, hasTokenId, isExpectedStartArrayToken, isExpectedStartObjectToken, nextToken, nextValue, reportInvalidNumber, reportOverflowInt, reportOverflowInt, reportOverflowInt, reportOverflowLong, reportOverflowLong, reportOverflowLong, reportUnexpectedNumberChar, skipChildren_codec, _constructError, _reportUnsupportedOperation, canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentName, finishToken, getBinaryValue, getBooleanValue, getByteValue, getCodec, getEmbeddedObject, getFeatureMask, getFormatFeatures, getInputSource, getNonBlockingInputFeeder, getObjectId, getSchema, getShortValue, getText, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, overrideFormatFeatures, readBinaryValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, requiresCustomCodec, setCodec, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchemaprotected final IOContext _ioContext
protected boolean _closed
close()) or when end-of-input is reached.protected int _inputPtr
protected int _inputEnd
protected long _currInputProcessed
protected int _currInputRow
protected int _currInputRowStart
protected long _tokenInputTotal
protected int _tokenInputRow
protected int _tokenInputCol
protected JsonReadContext _parsingContext
protected JsonToken _nextToken
protected final TextBuffer _textBuffer
protected char[] _nameCopyBuffer
ParserMinimalBase.getTextCharacters() method (instead of String
returning alternatives)protected boolean _nameCopied
protected ByteArrayBuilder _byteArrayBuilder
protected byte[] _binaryValue
getBinaryValue(com.fasterxml.jackson.core.Base64Variant) will not need to decode data more
than once.protected int _numTypesValid
protected int _numberInt
protected long _numberLong
protected double _numberDouble
protected BigInteger _numberBigInt
protected BigDecimal _numberBigDecimal
protected boolean _numberNegative
protected int _intLength
protected int _fractLength
protected int _expLength
protected ParserBase(IOContext ctxt, int features)
public Version version()
JsonParserversion in interface Versionedversion in class JsonParserpublic Object getCurrentValue()
JsonParser
getParsingContext().getCurrentValue();
Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.
getCurrentValue in class JsonParserpublic void setCurrentValue(Object v)
JsonParser
getParsingContext().setCurrentValue(v);
setCurrentValue in class JsonParserpublic JsonParser enable(JsonParser.Feature f)
JsonParserJsonParser.Feature for list of features)enable in class JsonParserpublic JsonParser disable(JsonParser.Feature f)
JsonParserJsonParser.Feature for list of features)disable in class JsonParser@Deprecated public JsonParser setFeatureMask(int newMask)
JsonParserJsonParser.FeaturessetFeatureMask in class JsonParserpublic JsonParser overrideStdFeatures(int values, int mask)
JsonParsermask.
Functionally equivalent to
int oldState = getFeatureMask();
int newState = (oldState & ~mask) | (values & mask);
setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.overrideStdFeatures in class JsonParservalues - Bit mask of set/clear state for features to changemask - Bit mask of features to changeprotected void _checkStdFeatureChanges(int newFeatureFlags,
int changedFeatures)
newFeatureFlags - Bitflag of standard features after they were changedchangedFeatures - Bitflag of standard features for which setting
did changepublic String getCurrentName() throws IOException
getCurrentName in class ParserMinimalBaseIOExceptionpublic 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 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 ParserMinimalBaseIOExceptionpublic 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 ParserMinimalBasepublic JsonReadContext getParsingContext()
JsonParsergetParsingContext in class ParserMinimalBasepublic JsonLocation getTokenLocation()
getTokenLocation in class JsonParserpublic JsonLocation getCurrentLocation()
getCurrentLocation in class JsonParserpublic 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 byte[] getBinaryValue(Base64Variant variant) throws IOException
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 ParserMinimalBasevariant - Expected variant of base64 encoded
content (see Base64Variants for definitions
of "standard" variants).IOExceptionpublic long getTokenCharacterOffset()
public int getTokenLineNr()
public int getTokenColumnNr()
protected abstract void _closeInput()
throws IOException
IOExceptionprotected void _releaseBuffers()
throws IOException
_closeInput() (for
example, when explicitly closing this reader instance), or
separately (if need be).IOExceptionprotected void _handleEOF()
throws JsonParseException
_handleEOF in class ParserMinimalBaseJsonParseExceptionprotected final int _eofAsNextChar()
throws JsonParseException
JsonParseExceptionpublic ByteArrayBuilder _getByteArrayBuilder()
protected final JsonToken reset(boolean negative, int intLen, int fractLen, int expLen)
protected final JsonToken resetInt(boolean negative, int intLen)
protected final JsonToken resetFloat(boolean negative, int intLen, int fractLen, int expLen)
public 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 JsonParserpublic Number getNumberValue() throws IOException
JsonParsergetNumberValue in class JsonParserIOExceptionpublic 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 JsonParserIOExceptionpublic 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 JsonParseException
may be thrown to indicate numeric overflow/underflow.
getIntValue in class JsonParserIOExceptionpublic 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 JsonParseException
may be thrown to indicate numeric overflow/underflow.
getLongValue in class JsonParserIOExceptionpublic 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 JsonParserIOExceptionpublic 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 JsonParseException
will be thrown to indicate numeric overflow/underflow.
getFloatValue in class JsonParserIOExceptionpublic 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 JsonParseException
will be thrown to indicate numeric overflow/underflow.
getDoubleValue in class JsonParserIOExceptionpublic BigDecimal getDecimalValue() throws IOException
JsonParserJsonToken.VALUE_NUMBER_FLOAT or
JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions
are ever thrown.getDecimalValue in class JsonParserIOExceptionprotected void _parseNumericValue(int expType)
throws IOException
expType - Numeric type that we will immediately need, if any;
mostly necessary to optimize handling of floating point numbersIOExceptionprotected int _parseIntValue()
throws IOException
IOExceptionprotected void _reportTooLongIntegral(int expType,
String rawNum)
throws IOException
IOExceptionprotected void convertNumberToInt()
throws IOException
IOExceptionprotected void convertNumberToLong()
throws IOException
IOExceptionprotected void convertNumberToBigInteger()
throws IOException
IOExceptionprotected void convertNumberToDouble()
throws IOException
IOExceptionprotected void convertNumberToBigDecimal()
throws IOException
IOExceptionprotected void _reportMismatchedEndMarker(int actCh,
char expCh)
throws JsonParseException
JsonParseExceptionprotected char _handleUnrecognizedCharacterEscape(char ch)
throws JsonProcessingException
JsonProcessingExceptionprotected void _throwUnquotedSpace(int i,
String ctxtDesc)
throws JsonParseException
JsonParser.Feature.ALLOW_UNQUOTED_CONTROL_CHARS.JsonParseExceptionprotected String _validJsonTokenList() throws IOException
IOExceptionprotected String _validJsonValueList() throws IOException
IOExceptionprotected char _decodeEscaped()
throws IOException
IOExceptionprotected final int _decodeBase64Escape(Base64Variant b64variant, int ch, int index) throws IOException
IOExceptionprotected final int _decodeBase64Escape(Base64Variant b64variant, char ch, int index) throws IOException
IOExceptionprotected IllegalArgumentException reportInvalidBase64Char(Base64Variant b64variant, int ch, int bindex) throws IllegalArgumentException
IllegalArgumentExceptionprotected IllegalArgumentException reportInvalidBase64Char(Base64Variant b64variant, int ch, int bindex, String msg) throws IllegalArgumentException
bindex - Relative index within base64 character unit; between 0
and 3 (as unit has exactly 4 characters)IllegalArgumentExceptionprotected void _handleBase64MissingPadding(Base64Variant b64variant) throws IOException
IOExceptionprotected Object _getSourceReference()
JsonLocation instances.protected static int[] growArrayBy(int[] arr,
int more)
@Deprecated protected void loadMoreGuaranteed() throws IOException
IOException@Deprecated protected boolean loadMore() throws IOException
IOExceptionprotected void _finishString()
throws IOException
IOExceptionCopyright © 2008–2019 FasterXML. All rights reserved.