Class JsonParserBase
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Versioned
- Direct Known Subclasses:
JsonNumericParserBase
,ReaderBasedParser
,ReaderBasedParserBase
,SmileParser
,StreamBasedParserBase
,Utf8StreamParser
JsonParser
implementations. Contains most common things that are independent
of actual underlying input source- Author:
- Tatu Saloranta
-
Nested Class Summary
Nested classes/interfaces inherited from class org.codehaus.jackson.JsonParser
JsonParser.Feature, JsonParser.NumberType
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected byte[]
We will hold on to decoded binary data, for duration of current event, so that multiple calls toJsonParserMinimalBase.getBinaryValue(org.codehaus.jackson.Base64Variant)
will not need to decode data more than once.protected ByteArrayBuilder
ByteArrayBuilder is needed if 'getBinaryValue' is called.protected boolean
Flag that indicates whether parser is closed or not.protected long
Number of characters/bytes that were contained in previous blocks (blocks that were already processed prior to the current buffer).protected int
Current row location of current point in input buffer, starting from 1, if available.protected int
Current index of the first character of the current row in input buffer.protected int
Length of the exponent part of the number, if any, not including 'e' marker or sign, just digits.protected int
Length of the fractional part (not including decimal point or exponent), in characters.protected int
Index of character after last available one in the buffer.protected int
Pointer to next available character in bufferprotected int
Length of integer part of the number, in charactersprotected final IOContext
I/O context for this reader.protected boolean
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[]
Temporary buffer that is needed if field name is accessed usingJsonParserMinimalBase.getTextCharacters()
method (instead of String returning alternatives)protected JsonToken
Secondary token related to the next token after current one; used if its type is known.protected BigDecimal
protected BigInteger
protected double
protected int
protected long
protected boolean
Flag that indicates whether numeric value has a negative value.protected int
Bitfield that indicates which numeric representations have been calculated for the current typeprotected JsonReadContext
Information about parser context, context in which the next token is to be parsed (root, array, object).protected final 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
Column on input row that current token starts; 0-based (although in the end it'll be converted to 1-based)protected int
Input row on which current token starts, 1-basedprotected long
Total number of bytes/characters read before start of current token.protected static final char
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
Fields inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase
INT_APOSTROPHE, INT_ASTERISK, INT_b, INT_BACKSLASH, INT_COLON, INT_COMMA, INT_CR, INT_f, INT_LBRACKET, INT_LCURLY, INT_LF, INT_n, INT_QUOTE, INT_r, INT_RBRACKET, INT_RCURLY, INT_SLASH, INT_SPACE, INT_t, INT_TAB, INT_u
Fields inherited from class org.codehaus.jackson.JsonParser
_currToken, _features, _lastClearedToken
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
protected final int
_decodeBase64Escape
(Base64Variant b64variant, char ch, int index) protected final int
_decodeBase64Escape
(Base64Variant b64variant, int ch, int index) protected char
Method that sub-classes must implement to support escaped sequences in base64-encoded sections.protected abstract void
protected void
Method called when an EOF is encountered between tokens.protected void
_parseNumericValue
(int expType) Method that will parse actual numeric value out of a syntactically valid number value.protected void
Method called to release internal buffers owned by the base reader.protected void
_reportMismatchedEndMarker
(int actCh, char expCh) 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 void
protected void
protected void
protected void
protected void
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.Method that returns location of the last processed character; usually for error reporting purposesMethod that can be called to get the name associated with the current event.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.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.final long
final int
final int
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
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.protected abstract boolean
loadMore()
protected final void
protected IllegalArgumentException
reportInvalidBase64Char
(Base64Variant b64variant, int ch, int bindex) protected IllegalArgumentException
reportInvalidBase64Char
(Base64Variant b64variant, int ch, int bindex, String msg) protected void
protected void
protected void
protected void
reportUnexpectedNumberChar
(int ch, String comment) 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) version()
Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (seeVersion
for details).Methods inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase
_constructError, _decodeBase64, _getCharDesc, _handleUnrecognizedCharacterEscape, _reportBase64EOF, _reportError, _reportInvalidBase64, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportUnexpectedChar, _throwInternal, _throwInvalidSpace, _throwUnquotedSpace, _wrapError, getBinaryValue, getText, getTextCharacters, getTextLength, getTextOffset, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, nextToken, skipChildren
Methods inherited from class org.codehaus.jackson.JsonParser
_constructError, canUseSchema, clearCurrentToken, configure, disable, disableFeature, enable, enableFeature, getBinaryValue, getBooleanValue, getByteValue, getCodec, getCurrentToken, getEmbeddedObject, getInputSource, getLastClearedToken, getShortValue, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, hasCurrentToken, isEnabled, isExpectedStartArrayToken, isFeatureEnabled, nextBooleanValue, nextFieldName, nextIntValue, nextLongValue, nextTextValue, nextValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setCodec, setFeature, setSchema
-
Field Details
-
_ioContext
I/O context for this reader. It handles buffer allocation for the reader. -
_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. -
_inputPtr
protected int _inputPtrPointer to next available character in buffer -
_inputEnd
protected int _inputEndIndex of character after last available one in the buffer. -
_currInputProcessed
protected long _currInputProcessedNumber of characters/bytes that were contained in previous blocks (blocks that were already processed prior to the current buffer). -
_currInputRow
protected int _currInputRowCurrent row location of current point in input buffer, starting from 1, if available. -
_currInputRowStart
protected int _currInputRowStartCurrent 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. -
_tokenInputTotal
protected long _tokenInputTotalTotal 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. -
_tokenInputRow
protected int _tokenInputRowInput row on which current token starts, 1-based -
_tokenInputCol
protected int _tokenInputColColumn on input row that current token starts; 0-based (although in the end it'll be converted to 1-based) -
_parsingContext
Information about parser context, context in which the next token is to be parsed (root, array, object). -
_nextToken
Secondary token related to the next token after current one; used if its type is known. This may be value token that follows FIELD_NAME, for example. -
_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) -
_nameCopyBuffer
protected char[] _nameCopyBufferTemporary buffer that is needed if field name is accessed usingJsonParserMinimalBase.getTextCharacters()
method (instead of String returning alternatives) -
_nameCopied
protected boolean _nameCopiedFlag 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) -
_byteArrayBuilder
ByteArrayBuilder is needed if 'getBinaryValue' is called. If so, we better reuse it for remainder of content. -
_binaryValue
protected byte[] _binaryValueWe will hold on to decoded binary data, for duration of current event, so that multiple calls toJsonParserMinimalBase.getBinaryValue(org.codehaus.jackson.Base64Variant)
will not need to decode data more than once. -
NR_UNKNOWN
protected static final int NR_UNKNOWN- See Also:
-
NR_INT
protected static final int NR_INT- See Also:
-
NR_LONG
protected static final int NR_LONG- See Also:
-
NR_BIGINT
protected static final int NR_BIGINT- See Also:
-
NR_DOUBLE
protected static final int NR_DOUBLE- See Also:
-
NR_BIGDECIMAL
protected static final int NR_BIGDECIMAL- See Also:
-
INT_0
protected static final int INT_0- See Also:
-
INT_1
protected static final int INT_1- See Also:
-
INT_2
protected static final int INT_2- See Also:
-
INT_3
protected static final int INT_3- See Also:
-
INT_4
protected static final int INT_4- See Also:
-
INT_5
protected static final int INT_5- See Also:
-
INT_6
protected static final int INT_6- See Also:
-
INT_7
protected static final int INT_7- See Also:
-
INT_8
protected static final int INT_8- See Also:
-
INT_9
protected static final int INT_9- See Also:
-
INT_MINUS
protected static final int INT_MINUS- See Also:
-
INT_PLUS
protected static final int INT_PLUS- See Also:
-
INT_DECIMAL_POINT
protected static final int INT_DECIMAL_POINT- See Also:
-
INT_e
protected static final int INT_e- See Also:
-
INT_E
protected static final int INT_E- See Also:
-
CHAR_NULL
protected static final char CHAR_NULL- See Also:
-
_numTypesValid
protected int _numTypesValidBitfield that indicates which numeric representations have been calculated for the current type -
_numberInt
protected int _numberInt -
_numberLong
protected long _numberLong -
_numberDouble
protected double _numberDouble -
_numberBigInt
-
_numberBigDecimal
-
_numberNegative
protected boolean _numberNegativeFlag that indicates whether numeric value has a negative value. That is, whether its textual representation starts with minus character. -
_intLength
protected int _intLengthLength of integer part of the number, in characters -
_fractLength
protected int _fractLengthLength of the fractional part (not including decimal point or exponent), in characters. Not used for pure integer values. -
_expLength
protected int _expLengthLength of the exponent part of the number, if any, not including 'e' marker or sign, just digits. Not used for pure integer values.
-
-
Constructor Details
-
JsonParserBase
-
-
Method Details
-
version
Description copied from interface:Versioned
Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (seeVersion
for details).- Specified by:
version
in interfaceVersioned
- Overrides:
version
in classJsonParser
-
getCurrentName
Method that can be called to get the name associated with the current event.- Specified by:
getCurrentName
in classJsonParserMinimalBase
- Throws:
IOException
JsonParseException
-
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 classJsonParserMinimalBase
- Throws:
IOException
-
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 classJsonParserMinimalBase
-
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 classJsonParserMinimalBase
-
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.- Specified by:
getTokenLocation
in classJsonParser
-
getCurrentLocation
Method that returns location of the last processed character; usually for error reporting purposes- Specified by:
getCurrentLocation
in classJsonParser
-
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 classJsonParserMinimalBase
- 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
-
getTokenCharacterOffset
public final long getTokenCharacterOffset() -
getTokenLineNr
public final int getTokenLineNr() -
getTokenColumnNr
public final int getTokenColumnNr() -
loadMoreGuaranteed
- Throws:
IOException
-
loadMore
- Throws:
IOException
-
_finishString
- Throws:
IOException
JsonParseException
-
_closeInput
- Throws:
IOException
-
_releaseBuffers
Method called to release internal buffers owned by the base reader. This may be called along with_closeInput()
(for example, when explicitly closing this reader instance), or separately (if need be).- Throws:
IOException
-
_handleEOF
Method called when an EOF is encountered between tokens. If so, it may be a legitimate EOF, but only iff there is no open non-root context.- Specified by:
_handleEOF
in classJsonParserMinimalBase
- Throws:
JsonParseException
-
_reportMismatchedEndMarker
- Throws:
JsonParseException
-
_getByteArrayBuilder
-
reset
-
resetInt
-
resetFloat
-
resetAsNaN
-
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
- Throws:
IOException
JsonParseException
-
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
- Throws:
IOException
JsonParseException
-
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, a
JsonParseException
may be thrown to indicate numeric overflow/underflow.- Specified by:
getIntValue
in classJsonParser
- Throws:
IOException
JsonParseException
-
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
JsonParseException
may be thrown to indicate numeric overflow/underflow.- Specified by:
getLongValue
in classJsonParser
- Throws:
IOException
JsonParseException
-
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
- Throws:
IOException
JsonParseException
-
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
JsonParseException
will be thrown to indicate numeric overflow/underflow.- Specified by:
getFloatValue
in classJsonParser
- Throws:
IOException
JsonParseException
-
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
JsonParseException
will be thrown to indicate numeric overflow/underflow.- Specified by:
getDoubleValue
in classJsonParser
- Throws:
IOException
JsonParseException
-
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
- Throws:
IOException
JsonParseException
-
_parseNumericValue
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
- Numeric type that we will immediately need, if any; mostly necessary to optimize handling of floating point numbers- Throws:
IOException
JsonParseException
-
convertNumberToInt
- Throws:
IOException
JsonParseException
-
convertNumberToLong
- Throws:
IOException
JsonParseException
-
convertNumberToBigInteger
- Throws:
IOException
JsonParseException
-
convertNumberToDouble
- Throws:
IOException
JsonParseException
-
convertNumberToBigDecimal
- Throws:
IOException
JsonParseException
-
reportUnexpectedNumberChar
- Throws:
JsonParseException
-
reportInvalidNumber
- Throws:
JsonParseException
-
reportOverflowInt
- Throws:
IOException
JsonParseException
-
reportOverflowLong
- Throws:
IOException
JsonParseException
-
_decodeEscaped
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- Throws:
IOException
JsonParseException
-
_decodeBase64Escape
protected final int _decodeBase64Escape(Base64Variant b64variant, int ch, int index) throws IOException, JsonParseException - Throws:
IOException
JsonParseException
-
_decodeBase64Escape
protected final int _decodeBase64Escape(Base64Variant b64variant, char ch, int index) throws IOException, JsonParseException - Throws:
IOException
JsonParseException
-
reportInvalidBase64Char
protected IllegalArgumentException reportInvalidBase64Char(Base64Variant b64variant, int ch, int bindex) throws IllegalArgumentException - Throws:
IllegalArgumentException
-
reportInvalidBase64Char
protected IllegalArgumentException reportInvalidBase64Char(Base64Variant b64variant, int ch, int bindex, String msg) throws IllegalArgumentException - Parameters:
bindex
- Relative index within base64 character unit; between 0 and 3 (as unit has exactly 4 characters)- Throws:
IllegalArgumentException
-