Jackson 3.0.1 · tools.jackson.core.base.ParserBase · APIdia, the JavaDoc alternative

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` will not need to decode data more than once.
protected ByteArrayBuilder	_byteArrayBuilder ByteArrayBuilder is needed if 'getBinaryValue' is called.
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 BigDecimal	_numberBigDecimal
protected BigInteger	_numberBigInt
protected double	_numberDouble
protected float	_numberFloat
protected int	_numberInt
protected boolean	_numberIsNaN Marker for explicit "Not a Number" (NaN) values that may be read by some formats: this includes positive and negative infinity, as well as "NaN" result for some arithmetic operations.
protected long	_numberLong
protected boolean	_numberNegative Flag that indicates whether numeric value has a negative value.
protected String	_numberString Textual number representation captured from input in cases lazy-parsing is desired.
protected int	_numTypesValid Bitfield that indicates which numeric representations have been calculated for the current type
protected final TextBuffer	_textBuffer Buffer that contains contents of String values, including property 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.

Access	Constructor and Description
protected	ParserBase(ObjectReadContext readCtxt, IOContext ctxt, int streamReadFeatures)

Method Summary

Modifier and Type	Method and Description
protected ContentReference	Returns: ContentReference object to use. _contentReference() Helper method used to encapsulate logic of including (or not) of "content reference" when constructing `TokenStreamLocation` instances.
protected ContentReference	Returns: ContentReference object to use when source is not to be included _contentReferenceRedacted() Helper method used to encapsulate logic of providing "content reference" when constructing `TokenStreamLocation` instances and source information is NOT to be included (`StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION` disabled).
protected BigInteger	_convertBigDecimalToBigInteger(BigDecimal bigDec)
protected final int	_decodeBase64Escape(Base64Variant b64variant, int ch, int index)
protected final int	_decodeBase64Escape(Base64Variant b64variant, char ch, int index)
protected char	Returns: Character decoded, if any _decodeEscaped() Method that sub-classes must implement to support escaped sequences in base64-encoded sections.
protected final int	Returns: If no exception is thrown, `-1` which is used as marked for "end-of-input" _eofAsNextChar()
protected BigDecimal	Returns: BigDecimal value decoded or converted for the current event _getBigDecimal() Internal accessor that needs to be used for accessing number value of type `BigDecimal` which -- as of 2.14 -- is typically lazily parsed.
protected BigInteger	Returns: BigInteger value decoded or converted for the current event _getBigInteger() Internal accessor that needs to be used for accessing number value of type `BigInteger` which -- as of 2.14 -- is typically lazily parsed.
protected ByteArrayBuilder	_getByteArrayBuilder()
protected double	Returns: `double` value decoded or converted for the current event _getNumberDouble() Internal accessor that needs to be used for accessing number value of type `double` which will be lazily parsed.
protected float	Returns: `float` value decoded or converted for the current event _getNumberFloat() Internal accessor that needs to be used for accessing number value of type `float` which will be lazily parsed.
protected int[]	_growNameDecodeBuffer(int[] arr, int more)
protected <T> T	_handleBase64MissingPadding(Base64Variant b64variant)
protected void	_handleEOF() Implements abstract tools.jackson.core.base.ParserMinimalBase._handleEOF. Method called when an EOF is encountered between tokens.
protected abstract int	_parseIntValue()
protected abstract void	_parseNumericValue(int Numeric type that we will immediately need, if any; mostly necessary to optimize handling of floating point numbers expType) Method that will parse actual numeric value out of a syntactically valid number value.
protected void	_releaseBuffers() Implements abstract tools.jackson.core.base.ParserMinimalBase._releaseBuffers. Method called to release internal buffers owned by the base reader.
protected <T> T	_reportInvalidBase64Char(Base64Variant b64variant, int ch, int bindex)
protected <T> T	_reportInvalidBase64Char(Base64Variant b64variant, int ch, int bindex, String msg)
public void	assignCurrentValue(Object v) Implements abstract tools.jackson.core.JsonParser.assignCurrentValue. Helper method, usually equivalent to: `getParsingContext().assignCurrentValue(v);`
public void	close() Overrides tools.jackson.core.base.ParserMinimalBase.close. Implements java.io.Closeable.close. Method that can be called to get the name associated with the current event.
protected void	convertNumberToBigDecimal()
protected void	convertNumberToBigInteger()
protected void	convertNumberToDouble()
protected void	convertNumberToFloat()
protected void	convertNumberToInt()
protected void	convertNumberToLong()
public Object	currentValue() Implements abstract tools.jackson.core.JsonParser.currentValue. Helper method, usually equivalent to: `getParsingContext().currentValue();` Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality.
public BigInteger	getBigIntegerValue() Implements abstract tools.jackson.core.JsonParser.getBigIntegerValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_INT` and it cannot be used as a Java long primitive type due to its magnitude.
public byte[]	getBinaryValue(Base64Variant variant) Implements abstract tools.jackson.core.JsonParser.getBinaryValue. 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.
public BigDecimal	getDecimalValue() Implements abstract tools.jackson.core.JsonParser.getDecimalValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_FLOAT` or `JsonToken#VALUE_NUMBER_INT`.
public double	getDoubleValue() Implements abstract tools.jackson.core.JsonParser.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.
public float	getFloatValue() Implements abstract tools.jackson.core.JsonParser.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.
public int	getIntValue() Implements abstract tools.jackson.core.JsonParser.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.
public long	getLongValue() Implements abstract tools.jackson.core.JsonParser.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.
public JsonParser.NumberType	getNumberType() Implements abstract tools.jackson.core.JsonParser.getNumberType. If current token is of type `JsonToken#VALUE_NUMBER_INT` or `JsonToken#VALUE_NUMBER_FLOAT`, returns one of `NumberType` constants; otherwise returns null.
public Number	getNumberValue() Implements abstract tools.jackson.core.JsonParser.getNumberValue. Generic number value accessor method that will work for all kinds of numeric values.
public Object	getNumberValueDeferred() Overrides tools.jackson.core.base.ParserMinimalBase.getNumberValueDeferred. Method similar to `getNumberValue` but that returns either same `Number` value as `getNumberValue()` (if already decoded), or `String` representation of as-of-yet undecoded number.
public Number	getNumberValueExact() Overrides tools.jackson.core.base.ParserMinimalBase.getNumberValueExact. Method similar to `getNumberValue` with the difference that for floating-point numbers value returned may be `BigDecimal` if the underlying format does not store floating-point numbers using native representation: for example, textual formats represent numbers as Strings (which are 10-based), and conversion to `java.lang.Double` is potentially lossy operation.
public long	getTokenCharacterOffset()
public int	getTokenColumnNr()
public int	getTokenLineNr()
protected static int[]	growArrayBy(int[] arr, int more)
public boolean	hasStringCharacters() Implements abstract tools.jackson.core.JsonParser.hasStringCharacters. Method that can be used to determine whether calling of `getStringCharacters` would be the most efficient way to access String value for the event parser currently points to (compared to `getString()`).
public boolean	isNaN() Implements abstract tools.jackson.core.JsonParser.isNaN. Accessor for checking whether current token is a special "not-a-number" (NaN) token (including both "NaN" AND positive/negative infinity!).
protected final JsonToken	reset(boolean negative, int intLen, int fractLen, int expLen)
protected final JsonToken	resetAsNaN(String valueStr, double value)
protected final JsonToken	resetFloat(boolean negative, int intLen, int fractLen, int expLen)
protected final JsonToken	resetInt(boolean negative, int intLen)

Inherited from tools.jackson.core.base.ParserMinimalBase:: _closeInput _constructInputCoercion _constructNotNumericType _currentLocationMinusOne _decodeBase64 _getCharDesc _hasTextualNull _longIntegerDesc _longNumberDesc _nullSafeUpdateToken _reportBadInputStream _reportBadReader _reportError _reportError _reportError _reportError _reportInvalidEOF _reportInvalidEOF _reportInvalidEOFInValue _reportInvalidNumber _reportInvalidSpace _reportMissingRootWS _reportOverflowByte _reportOverflowInt _reportOverflowInt _reportOverflowInt _reportOverflowLong _reportOverflowLong _reportOverflowLong _reportOverflowShort _reportUnexpectedChar _reportUnexpectedNumberChar _throwInternal _updateToken _updateTokenToNA _updateTokenToNull _wrapIOFailure clearCurrentToken currentNameMatch currentToken currentTokenCount currentTokenId finishToken getBooleanValue getByteValue getEmbeddedObject getLastClearedToken getNumberTypeFP getShortValue getString getValueAsBoolean getValueAsDouble getValueAsInt getValueAsInt getValueAsLong getValueAsLong getValueAsString getValueAsString hasCurrentToken hasToken hasTokenId isClosed isEnabled isExpectedNumberIntToken isExpectedStartArrayToken isExpectedStartObjectToken nextName nextName nextNameMatch nextValue objectReadContext readValueAs readValueAs readValueAs readValueAsTree skipChildren streamReadCapabilities streamReadConstraints streamReadFeatures

_binaryValue	back to summary
protected byte[] _binaryValue We will hold on to decoded binary data, for duration of current event, so that multiple calls to `getBinaryValue` will not need to decode data more than once.

_byteArrayBuilder	back to summary
protected ByteArrayBuilder _byteArrayBuilder ByteArrayBuilder is needed if 'getBinaryValue' is called. If so, we better reuse it for remainder of content.

_currInputProcessed	back to summary
protected long _currInputProcessed Number of characters/bytes that were contained in previous blocks (blocks that were already processed prior to the current buffer).

_currInputRow	back to summary
protected int _currInputRow Current row location of current point in input buffer, starting from 1, if available.

_currInputRowStart	back to summary
protected int _currInputRowStart Current index of the first character of the current row in input buffer. Needed to calculate column position, if necessary; benefit of not having column itself is that this only has to be updated once per line.

_expLength	back to summary
protected int _expLength Length of the exponent part of the number, if any, not including 'e' marker or sign, just digits. Not used for pure integer values.

_fractLength	back to summary
protected int _fractLength Length of the fractional part (not including decimal point or exponent), in characters. Not used for pure integer values.

_inputEnd	back to summary
protected int _inputEnd Index of character after last available one in the buffer.

_inputPtr	back to summary
protected int _inputPtr Pointer to next available character in buffer

_intLength	back to summary
protected int _intLength Length of integer part of the number, in characters

_numberBigDecimal	back to summary
protected BigDecimal _numberBigDecimal

_numberBigInt	back to summary
protected BigInteger _numberBigInt

_numberDouble	back to summary
protected double _numberDouble

_numberFloat	back to summary
protected float _numberFloat

_numberInt	back to summary
protected int _numberInt

_numberIsNaN	back to summary
protected boolean _numberIsNaN Marker for explicit "Not a Number" (NaN) values that may be read by some formats: this includes positive and negative infinity, as well as "NaN" result for some arithmetic operations. In case of JSON, such values can only be handled with non-standard processing: for some other formats they can be passed normally. Note this marker is NOT set in case of value overflow/underflow for `double` or `float` values. Since 2.17

_numberLong	back to summary
protected long _numberLong

_numberNegative	back to summary
protected boolean _numberNegative Flag that indicates whether numeric value has a negative value. That is, whether its textual representation starts with minus character.

_numberString	back to summary
protected String _numberString Textual number representation captured from input in cases lazy-parsing is desired.

_numTypesValid	back to summary
protected int _numTypesValid Bitfield that indicates which numeric representations have been calculated for the current type

_textBuffer	back to summary
protected final TextBuffer _textBuffer Buffer that contains contents of String values, including property names if necessary (name split across boundary, contains escape sequence, or access needed to char array)

_tokenInputCol	back to summary
protected int _tokenInputCol Column on input row that current token starts; 0-based (although in the end it'll be converted to 1-based)

_tokenInputRow	back to summary
protected int _tokenInputRow Input row on which current token starts, 1-based

_tokenInputTotal	back to summary
protected long _tokenInputTotal Total number of bytes/characters read before start of current token. For big (gigabyte-sized) sizes are possible, needs to be long, unlike pointers and sizes related to in-memory buffers.

ParserBase	back to summary
protected ParserBase(ObjectReadContext readCtxt, IOContext ctxt, int streamReadFeatures)

Method Detail

_contentReference back to summary

_contentReference	back to summary
protected ContentReference _contentReference() Helper method used to encapsulate logic of including (or not) of "content reference" when constructing `TokenStreamLocation` instances. Returns:ContentReference ContentReference object to use.

protected ContentReference _contentReference()

Helper method used to encapsulate logic of including (or not) of "content reference" when constructing TokenStreamLocation instances.

Returns:ContentReference: ContentReference object to use.

_contentReferenceRedacted back to summary

_contentReferenceRedacted	back to summary
protected ContentReference _contentReferenceRedacted() Helper method used to encapsulate logic of providing "content reference" when constructing `TokenStreamLocation` instances and source information is NOT to be included (`StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION` disabled). Default implementation will simply return `ContentReference#redacted()`. Returns:ContentReference ContentReference object to use when source is not to be included

protected ContentReference _contentReferenceRedacted()

Helper method used to encapsulate logic of providing "content reference" when constructing TokenStreamLocation instances and source information is NOT to be included (StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION disabled).

Default implementation will simply return ContentReference#redacted().

Returns:ContentReference: ContentReference object to use when source is not to be included

_convertBigDecimalToBigInteger	back to summary
protected BigInteger _convertBigDecimalToBigInteger(BigDecimal bigDec)

_decodeBase64Escape	back to summary
protected final int _decodeBase64Escape(Base64Variant b64variant, int ch, int index) throws JacksonException

_decodeBase64Escape	back to summary
protected final int _decodeBase64Escape(Base64Variant b64variant, char ch, int index) throws JacksonException

_decodeEscaped	back to summary
protected char _decodeEscaped() throws JacksonException Method that sub-classes must implement to support escaped sequences in base64-encoded sections. Sub-classes that do not need base64 support can leave this as is Returns:char Character decoded, if any Exceptions JacksonException: If escape decoding fails

_decodeEscaped

back to summary

protected char _decodeEscaped() throws JacksonException

Method that sub-classes must implement to support escaped sequences in base64-encoded sections. Sub-classes that do not need base64 support can leave this as is

Returns:char

Character decoded, if any

Exceptions

JacksonException:: If escape decoding fails

_eofAsNextChar	back to summary
protected final int _eofAsNextChar() throws StreamReadException Returns:int If no exception is thrown, `-1` which is used as marked for "end-of-input" Exceptions StreamReadException: If check on `_handleEOF()` fails; usually because the current context is not root context (missing end markers in content)

_getBigDecimal back to summary

_getBigDecimal	back to summary
protected BigDecimal _getBigDecimal() Internal accessor that needs to be used for accessing number value of type `BigDecimal` which -- as of 2.14 -- is typically lazily parsed. Returns:BigDecimal BigDecimal value decoded or converted for the current event

protected BigDecimal _getBigDecimal()

Internal accessor that needs to be used for accessing number value of type BigDecimal which -- as of 2.14 -- is typically lazily parsed.

Returns:BigDecimal: BigDecimal value decoded or converted for the current event

_getBigInteger back to summary

_getBigInteger	back to summary
protected BigInteger _getBigInteger() Internal accessor that needs to be used for accessing number value of type `BigInteger` which -- as of 2.14 -- is typically lazily parsed. Returns:BigInteger BigInteger value decoded or converted for the current event

protected BigInteger _getBigInteger()

Internal accessor that needs to be used for accessing number value of type BigInteger which -- as of 2.14 -- is typically lazily parsed.

Returns:BigInteger: BigInteger value decoded or converted for the current event

_getByteArrayBuilder	back to summary
protected ByteArrayBuilder _getByteArrayBuilder()

_getNumberDouble back to summary

_getNumberDouble	back to summary
protected double _getNumberDouble() Internal accessor that needs to be used for accessing number value of type `double` which will be lazily parsed. Returns:double `double` value decoded or converted for the current event

protected double _getNumberDouble()

Internal accessor that needs to be used for accessing number value of type double which will be lazily parsed.

Returns:double: double value decoded or converted for the current event

_getNumberFloat back to summary

_getNumberFloat	back to summary
protected float _getNumberFloat() Internal accessor that needs to be used for accessing number value of type `float` which will be lazily parsed. Returns:float `float` value decoded or converted for the current event Since 2.15

protected float _getNumberFloat()

Internal accessor that needs to be used for accessing number value of type float which will be lazily parsed.

Returns:float: float value decoded or converted for the current event
Since: 2.15

_growNameDecodeBuffer	back to summary
protected int[] _growNameDecodeBuffer(int[] arr, int more) throws StreamConstraintsException

_handleBase64MissingPadding	back to summary
protected <T> T _handleBase64MissingPadding(Base64Variant b64variant) throws StreamReadException

_handleEOF	back to summary
protected void _handleEOF() throws JacksonException Implements abstract tools.jackson.core.base.ParserMinimalBase._handleEOF. Method called when an EOF is encountered between tokens. If so, it may be a legitimate EOF, but only if there is no open non-root context. Annotations @Override Exceptions JacksonException: Doc from tools.jackson.core.base.ParserMinimalBase._handleEOF. if end-of-content not allowed at current position.

_handleEOF

back to summary

protected void _handleEOF() throws JacksonException

Implements abstract tools.jackson.core.base.ParserMinimalBase._handleEOF.

Method called when an EOF is encountered between tokens. If so, it may be a legitimate EOF, but only if there is no open non-root context.

Annotations

@Override

Exceptions

JacksonException:

Doc from tools.jackson.core.base.ParserMinimalBase._handleEOF.

if end-of-content not allowed at current position.

_parseIntValue	back to summary
protected abstract int _parseIntValue() throws JacksonException

_parseNumericValue	back to summary
protected abstract void _parseNumericValue(int expType) throws JacksonException, InputCoercionException Method that will parse actual numeric value out of a syntactically valid number value. Type it will parse into depends on whether it is a floating point number, as well as its magnitude: smallest legal type (of ones available) is used for efficiency. Parameters expType:int Numeric type that we will immediately need, if any; mostly necessary to optimize handling of floating point numbers Exceptions InputCoercionException: if the current token not of numeric type JacksonIOException: for low-level read issues StreamReadException: for number decoding problems

_parseNumericValue

back to summary

protected abstract void _parseNumericValue(int expType) throws JacksonException, InputCoercionException

Method that will parse actual numeric value out of a syntactically valid number value. Type it will parse into depends on whether it is a floating point number, as well as its magnitude: smallest legal type (of ones available) is used for efficiency.

Parameters

expType:int: Numeric type that we will immediately need, if any; mostly necessary to optimize handling of floating point numbers

Exceptions

InputCoercionException:: if the current token not of numeric type
JacksonIOException:: for low-level read issues
StreamReadException:: for number decoding problems

_releaseBuffers back to summary

_releaseBuffers	back to summary
protected void _releaseBuffers() Implements abstract tools.jackson.core.base.ParserMinimalBase._releaseBuffers. Doc from tools.jackson.core.base.ParserMinimalBase._releaseBuffers. Method called to release internal buffers owned by the base reader. This is expected to be called after `_closeInput` since the buffers are expected not to be needed any longer. Annotations @Override

protected void _releaseBuffers()

Implements abstract tools.jackson.core.base.ParserMinimalBase._releaseBuffers.

Doc from tools.jackson.core.base.ParserMinimalBase._releaseBuffers.

Method called to release internal buffers owned by the base reader. This is expected to be called after _closeInput since the buffers are expected not to be needed any longer.

Annotations

@Override

_reportInvalidBase64Char	back to summary
protected <T> T _reportInvalidBase64Char(Base64Variant b64variant, int ch, int bindex) throws StreamReadException

_reportInvalidBase64Char	back to summary
protected <T> T _reportInvalidBase64Char(Base64Variant b64variant, int ch, int bindex, String msg) throws StreamReadException

assignCurrentValue back to summary

assignCurrentValue	back to summary
public void assignCurrentValue(Object v) Implements abstract tools.jackson.core.JsonParser.assignCurrentValue. Doc from tools.jackson.core.JsonParser.assignCurrentValue. Helper method, usually equivalent to: `getParsingContext().assignCurrentValue(v);` Annotations @Override

public void assignCurrentValue(Object v)

Implements abstract tools.jackson.core.JsonParser.assignCurrentValue.

Doc from tools.jackson.core.JsonParser.assignCurrentValue.

Helper method, usually equivalent to: getParsingContext().assignCurrentValue(v);

Annotations

@Override

close	back to summary
public void close() throws JacksonException Overrides tools.jackson.core.base.ParserMinimalBase.close. Implements java.io.Closeable.close. Method that can be called to get the name associated with the current event. Annotations @Override

back to summary

public void close() throws JacksonException

Overrides tools.jackson.core.base.ParserMinimalBase.close.

Implements java.io.Closeable.close.

Method that can be called to get the name associated with the current event.

Annotations

@Override

convertNumberToBigDecimal	back to summary
protected void convertNumberToBigDecimal()

convertNumberToBigInteger	back to summary
protected void convertNumberToBigInteger()

convertNumberToDouble	back to summary
protected void convertNumberToDouble()

convertNumberToFloat	back to summary
protected void convertNumberToFloat()

convertNumberToInt	back to summary
protected void convertNumberToInt() throws InputCoercionException

convertNumberToLong	back to summary
protected void convertNumberToLong() throws InputCoercionException

currentValue back to summary

public Object currentValue()

Implements abstract tools.jackson.core.JsonParser.currentValue.

Doc from tools.jackson.core.JsonParser.currentValue.

Helper method, usually equivalent to: getParsingContext().currentValue();

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.

Annotations

@Override

getBigIntegerValue back to summary

public BigInteger getBigIntegerValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getBigIntegerValue.

Doc from tools.jackson.core.JsonParser.getBigIntegerValue.

Numeric accessor that can be called when the current token is of type JsonToken#VALUE_NUMBER_INT and it cannot 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 getDecimalValue and then constructing a BigInteger from that value.

Annotations

@Override

getBinaryValue back to summary

public byte[] getBinaryValue(Base64Variant variant) throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getBinaryValue.

Doc from tools.jackson.core.JsonParser.getBinaryValue.

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 via getString() 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.

Annotations

@SuppressWarnings:resource
@Override

getDecimalValue back to summary

public BigDecimal getDecimalValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getDecimalValue.

Doc from tools.jackson.core.JsonParser.getDecimalValue.

Numeric accessor that can be called when the current token is of type JsonToken#VALUE_NUMBER_FLOAT or JsonToken#VALUE_NUMBER_INT. No under/overflow exceptions are ever thrown.

Annotations

@Override

getDoubleValue back to summary

public double getDoubleValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getDoubleValue.

Doc from tools.jackson.core.JsonParser.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. It can also be called for JsonToken#VALUE_NUMBER_INT; if so, it is equivalent to calling 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.

Annotations

@Override

getFloatValue back to summary

public float getFloatValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getFloatValue.

Doc from tools.jackson.core.JsonParser.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. It can also be called for JsonToken#VALUE_NUMBER_INT; if so, it is equivalent to calling 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.

Annotations

@Override

getIntValue back to summary

public int getIntValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getIntValue.

Doc from tools.jackson.core.JsonParser.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. It can also be called for JsonToken#VALUE_NUMBER_FLOAT; if so, it is equivalent to calling 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.

Annotations

@Override

getLongValue back to summary

public long getLongValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getLongValue.

Doc from tools.jackson.core.JsonParser.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. It can also be called for JsonToken#VALUE_NUMBER_FLOAT; if so, it is equivalent to calling 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.

Annotations

@Override

getNumberType back to summary

public JsonParser.NumberType getNumberType()

Implements abstract tools.jackson.core.JsonParser.getNumberType.

Doc from tools.jackson.core.JsonParser.getNumberType.

If current token is of type JsonToken#VALUE_NUMBER_INT or JsonToken#VALUE_NUMBER_FLOAT, returns one of NumberType constants; otherwise returns null.

Note

in Jackson 2.x, an exception was wrong if called for non-numeric token.

Annotations

@Override

getNumberValue

back to summary

public Number getNumberValue()

Implements abstract tools.jackson.core.JsonParser.getNumberValue.

Doc from tools.jackson.core.JsonParser.getNumberValue.

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.

Annotations

@Override

getNumberValueDeferred back to summary

public Object getNumberValueDeferred()

Overrides tools.jackson.core.base.ParserMinimalBase.getNumberValueDeferred.

Doc from tools.jackson.core.JsonParser.getNumberValueDeferred.

Method similar to getNumberValue but that returns either same Number value as getNumberValue() (if already decoded), or String representation of as-of-yet undecoded number. Typically textual formats allow deferred decoding from String, whereas binary formats either decode numbers eagerly or have binary representation from which to decode value to return.

Same constraints apply to calling this method as to getNumberValue(): current token must be either JsonToken#VALUE_NUMBER_INT or JsonToken#VALUE_NUMBER_FLOAT; otherwise an exception is thrown

Default implementation simply returns getNumberValue()

Annotations

@Override

getNumberValueExact back to summary

public Number getNumberValueExact()

Overrides tools.jackson.core.base.ParserMinimalBase.getNumberValueExact.

Doc from tools.jackson.core.JsonParser.getNumberValueExact.

Method similar to getNumberValue with the difference that for floating-point numbers value returned may be BigDecimal if the underlying format does not store floating-point numbers using native representation: for example, textual formats represent numbers as Strings (which are 10-based), and conversion to java.lang.Double is potentially lossy operation.

Default implementation simply returns getNumberValue()

Annotations

@Override

getTokenCharacterOffset	back to summary
public long getTokenCharacterOffset()

getTokenColumnNr	back to summary
public int getTokenColumnNr()

getTokenLineNr	back to summary
public int getTokenLineNr()

growArrayBy	back to summary
protected static int[] growArrayBy(int[] arr, int more) throws IllegalArgumentException

hasStringCharacters back to summary

public boolean hasStringCharacters()

Implements abstract tools.jackson.core.JsonParser.hasStringCharacters.

Doc from tools.jackson.core.JsonParser.hasStringCharacters.

Method that can be used to determine whether calling of getStringCharacters would be the most efficient way to access String value for the event parser currently points to (compared to getString()).

Annotations

@Override

isNaN back to summary

public boolean isNaN()

Implements abstract tools.jackson.core.JsonParser.isNaN.

Doc from tools.jackson.core.JsonParser.isNaN.

Accessor for checking whether current token is a special "not-a-number" (NaN) token (including both "NaN" AND positive/negative infinity!). These values are not supported by all formats: JSON, for example, only supports them if JsonReadFeature#ALLOW_NON_NUMERIC_NUMBERS is enabled.

Note

in case where numeric value is outside range of requested type -- most notably java.lang.Float or java.lang.Double -- and decoding results effectively in a NaN value, this method DOES NOT return true: only explicit incoming markers do. This is because value could still be accessed as a valid BigDecimal.

Annotations

@Override

reset	back to summary
protected final JsonToken reset(boolean negative, int intLen, int fractLen, int expLen) throws JacksonException

resetAsNaN	back to summary
protected final JsonToken resetAsNaN(String valueStr, double value)

resetFloat	back to summary
protected final JsonToken resetFloat(boolean negative, int intLen, int fractLen, int expLen) throws JacksonException

resetInt	back to summary
protected final JsonToken resetInt(boolean negative, int intLen) throws JacksonException

public abstract Class ParserBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail