Class ReaderBasedJsonParser
- java.lang.Object
-
- com.fasterxml.jackson.core.JsonParser
-
- com.fasterxml.jackson.core.base.ParserMinimalBase
-
- com.fasterxml.jackson.core.base.ParserBase
-
- com.fasterxml.jackson.core.json.JsonParserBase
-
- com.fasterxml.jackson.core.json.ReaderBasedJsonParser
-
- All Implemented Interfaces:
Versioned,java.io.Closeable,java.lang.AutoCloseable
public class ReaderBasedJsonParser extends JsonParserBase
This is a concrete implementation ofJsonParser, which is based on aReaderto handle low-level character conversion tasks.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser
JsonParser.Feature, JsonParser.NumberType, JsonParser.NumberTypeFP
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean_bufferRecyclableFlag that indicates whether the input buffer is recycable (and needs to be returned to recycler once we are done) or not.protected int_hashSeedprotected char[]_inputBufferCurrent buffer from which data is read; generally data is read into buffer from input source.protected int_nameStartColprotected long_nameStartOffsetValue ofParserBase._inputPtrat the time when the first character of name token was read.protected int_nameStartRowprotected ObjectCodec_objectCodecprotected java.io.Reader_readerReader that can be used for reading more content, if one buffer from input source, but in some cases pre-loaded buffer is handed to the parser.protected CharsToNameCanonicalizer_symbolsprotected boolean_tokenIncompleteFlag that indicates that the current token has not yet been fully processed, and needs to be finished for some access (or skipped to obtain the next token)-
Fields inherited from class com.fasterxml.jackson.core.json.JsonParserBase
FEAT_MASK_ALLOW_CTRL_RS, FEAT_MASK_ALLOW_JAVA_COMMENTS, FEAT_MASK_ALLOW_MISSING, FEAT_MASK_ALLOW_SINGLE_QUOTES, FEAT_MASK_ALLOW_UNQUOTED_NAMES, FEAT_MASK_ALLOW_YAML_COMMENTS, FEAT_MASK_LEADING_ZEROS, FEAT_MASK_NON_NUM_NUMBERS, FEAT_MASK_TRAILING_COMMA, INPUT_CODES_LATIN1, INPUT_CODES_UTF8
-
Fields inherited from class com.fasterxml.jackson.core.base.ParserBase
_binaryValue, _byteArrayBuilder, _closed, _currInputProcessed, _currInputRow, _currInputRowStart, _expLength, _fractLength, _inputEnd, _inputPtr, _intLength, _ioContext, _nameCopied, _nameCopyBuffer, _nextToken, _numberBigDecimal, _numberBigInt, _numberDouble, _numberFloat, _numberInt, _numberIsNaN, _numberLong, _numberNegative, _numberString, _numTypesValid, _parsingContext, _textBuffer, _tokenInputCol, _tokenInputRow, _tokenInputTotal, JSON_READ_CAPABILITIES
-
Fields inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase
_currToken, _lastClearedToken, _streamReadConstraints, _tokenCount, _trackMaxTokenCount, 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_RS, INT_SLASH, INT_SPACE, INT_TAB, MAX_ERROR_TOKEN_LENGTH, MAX_INT_D, MAX_INT_L, MAX_LONG_D, MIN_INT_D, MIN_INT_L, MIN_LONG_D, NO_BYTES, NO_INTS, NR_BIGDECIMAL, NR_BIGINT, NR_DOUBLE, NR_FLOAT, NR_INT, NR_LONG, NR_UNKNOWN
-
Fields inherited from class com.fasterxml.jackson.core.JsonParser
_features, _requestPayload, DEFAULT_READ_CAPABILITIES
-
-
Constructor Summary
Constructors Constructor Description ReaderBasedJsonParser(IOContext ctxt, int features, java.io.Reader r, ObjectCodec codec, CharsToNameCanonicalizer st)Constructor called when input comes as aReader, and buffer allocation can be done using default mechanism.ReaderBasedJsonParser(IOContext ctxt, int features, java.io.Reader r, ObjectCodec codec, CharsToNameCanonicalizer st, char[] inputBuffer, int start, int end, boolean bufferRecyclable)Constructor called when caller wants to provide input buffer directly (or needs to, in case of bootstrapping having read some of contents) and it may or may not be recyclable use standard recycle context.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description private void_checkMatchEnd(java.lang.String matchStr, int i, int c)protected void_closeInput()private void_closeScope(int i)protected JsonLocation_currentLocationMinusOne()Factory method used to provide location for cases where we must read and consume a single "wrong" character (to possibly allow error recovery), but need to report accurate location for that character: if so, the current location is past location we want, and location we want will be "one location earlier".protected byte[]_decodeBase64(Base64Variant b64variant)Efficient handling for incremental parsing of base64-encoded textual content.protected char_decodeEscaped()Method that sub-classes must implement to support escaped sequences in base64-encoded sections.protected void_finishString()protected void_finishString2()protected java.lang.String_getText2(JsonToken t)protected JsonToken_handleApos()protected JsonToken_handleInvalidNumberStart(int ch, boolean negative)protected JsonToken_handleInvalidNumberStart(int ch, boolean negative, boolean hasSign)protected java.lang.String_handleOddName(int i)Method called when we see non-white space character other than double quote, when expecting a field name.private java.lang.String_handleOddName2(int startPtr, int hash, int[] codes)protected JsonToken_handleOddValue(int i)Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content.protected boolean_isNextTokenNameMaybe(int i, java.lang.String nameToMatch)private void_isNextTokenNameYes(int i)protected boolean_loadMore()protected void_loadMoreGuaranteed()private void_matchFalse()private void_matchNull()protected void_matchToken(java.lang.String matchStr, int i)private void_matchToken2(java.lang.String matchStr, int i)private void_matchTrue()private JsonToken_nextAfterName()private JsonToken_nextTokenNotInObject(int i)protected java.lang.String_parseAposName()private JsonToken_parseFloat(int ch, int startPtr, int ptr, boolean neg, int intLen)protected JsonToken_parseFloatThatStartsWithPeriod()Deprecated.protected JsonToken_parseFloatThatStartsWithPeriod(boolean neg)protected java.lang.String_parseName()private java.lang.String_parseName2(int startPtr, int hash, int endChar)private JsonToken_parseNumber2(boolean neg, int startPtr)Method called to parse a number, when the primary parse method has failed to parse it, due to it being split on buffer boundary.private JsonToken_parseSignedNumber(boolean negative)protected JsonToken_parseUnsignedNumber(int ch)Initial parsing method for number values.protected int_readBinary(Base64Variant b64variant, java.io.OutputStream out, byte[] buffer)protected void_releaseBuffers()Method called to release internal buffers owned by the base reader.protected void_reportInvalidToken(java.lang.String matchedPart)protected void_reportInvalidToken(java.lang.String matchedPart, java.lang.String msg)private int_skipAfterComma2()private void_skipCComment()private int_skipColon()private int_skipColon2(boolean gotColon)private int_skipColonFast(int ptr)private int_skipComma(int i)private void_skipComment()protected void_skipCR()private void_skipLine()protected void_skipString()Method called to skim through rest of unparsed String value, if it is not needed.private int_skipWSOrEnd()private int_skipWSOrEnd2()private boolean_skipYAMLComment()private void_updateLocation()private void_updateNameLocation()private char_verifyNLZ2()private char_verifyNoLeadingZeroes()private void_verifyRootSpace(int ch)Method called to ensure that a root-value is followed by a space token.JsonLocationcurrentLocation()Method that returns location of the last processed input unit (character or byte) from the input; usually for error reporting purposes.JsonLocationcurrentTokenLocation()Method that return the starting location of the current (most recently returned) token; that is, the position of the first input unit (character or byte) from input that starts the current token.voidfinishToken()Method that may be used to force full handling of the current token so that even if lazy processing is enabled, the whole contents are read for possible retrieval.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.java.lang.ObjectgetInputSource()Method that can be used to get access to object that is used to access input being parsed; this is usually eitherInputStreamorReader, depending on what parser was constructed with.protected chargetNextChar(java.lang.String eofMsg)Deprecated.protected chargetNextChar(java.lang.String eofMsg, JsonToken forToken)java.lang.StringgetText()Method for accessing textual representation of the current event; if no current event (before first call tonextToken(), or after encountering end-of-input), returns null.intgetText(java.io.Writer writer)Method to read the textual representation of the current token in chunks and pass it to the given Writer.char[]getTextCharacters()Method similar toJsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.intgetTextLength()Accessor used withJsonParser.getTextCharacters(), to know length of String stored in returned buffer.intgetTextOffset()Accessor used withJsonParser.getTextCharacters(), to know offset of the first text content character within buffer.java.lang.StringgetValueAsString()Method that will try to convert value of current token to aString.java.lang.StringgetValueAsString(java.lang.String defValue)Method that will try to convert value of current token to aString.java.lang.BooleannextBooleanValue()Method that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_TRUEorJsonToken.VALUE_FALSEreturns matching Boolean value; otherwise return null.java.lang.StringnextFieldName()Method that fetches next token (as if callingJsonParser.nextToken()) and verifies whether it isJsonToken.FIELD_NAME; if it is, returns same asJsonParser.currentName(), otherwise null.booleannextFieldName(SerializableString sstr)Method that fetches next token (as if callingJsonParser.nextToken()) and verifies whether it isJsonToken.FIELD_NAMEwith specified name and returns result of that comparison.intnextIntValue(int defaultValue)Method that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_NUMBER_INTreturns 32-bit int value; otherwise returns specified default value It is functionally equivalent to:longnextLongValue(long defaultValue)Method that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_NUMBER_INTreturns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:java.lang.StringnextTextValue()Method that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_STRINGreturns contained String value; otherwise returns null.JsonTokennextToken()Main iteration method, which will advance stream enough to determine type of the next token, if any.intreadBinaryValue(Base64Variant b64variant, java.io.OutputStream out)Similar toJsonParser.readBinaryValue(OutputStream)but allows explicitly specifying base64 variant to use.intreleaseBuffered(java.io.Writer w)Method that can be called to push back any content that has been read but not consumed by the parser.-
Methods inherited from class com.fasterxml.jackson.core.json.JsonParserBase
_isAllowedCtrlCharRS, getCodec, getCurrentLocation, getNumberTypeFP, getReadCapabilities, getTokenLocation, setCodec
-
Methods inherited from class com.fasterxml.jackson.core.base.ParserBase
_checkStdFeatureChanges, _contentReference, _contentReferenceRedacted, _convertBigDecimalToBigInteger, _decodeBase64Escape, _decodeBase64Escape, _eofAsNextChar, _getBigDecimal, _getBigInteger, _getByteArrayBuilder, _getNumberDouble, _getNumberFloat, _getSourceReference, _growNameDecodeBuffer, _handleBase64MissingPadding, _handleEOF, _handleUnrecognizedCharacterEscape, _parseIntValue, _parseNumericValue, _reportExtraEndMarker, _reportMismatchedEndMarker, _reportTooLongIntegral, _throwUnquotedSpace, _validJsonTokenList, _validJsonValueList, assignCurrentValue, close, convertNumberToBigDecimal, convertNumberToBigInteger, convertNumberToDouble, convertNumberToFloat, convertNumberToInt, convertNumberToLong, createChildArrayContext, createChildObjectContext, currentValue, disable, enable, getBigIntegerValue, getCurrentName, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberType, getNumberValue, getNumberValueDeferred, getNumberValueExact, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, growArrayBy, hasTextCharacters, isClosed, isNaN, loadMore, loadMoreGuaranteed, overrideCurrentName, overrideStdFeatures, reportInvalidBase64Char, reportInvalidBase64Char, reset, resetAsNaN, resetFloat, resetInt, setFeatureMask, version
-
Methods inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase
_ascii, _asciiBytes, _constructError, _decodeBase64, _getCharDesc, _hasTextualNull, _longIntegerDesc, _longNumberDesc, _nullSafeUpdateToken, _reportError, _reportError, _reportError, _reportInputCoercion, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportInvalidUTF8Surrogate, _reportMissingRootWS, _reportUnexpectedChar, _reportUnexpectedNumberChar, _throwInternal, _throwInternalReturnAny, _throwInvalidSpace, _updateToken, _updateTokenToNA, _updateTokenToNull, _wrapError, clearCurrentToken, currentToken, currentTokenCount, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, hasCurrentToken, hasToken, hasTokenId, isExpectedNumberIntToken, isExpectedStartArrayToken, isExpectedStartObjectToken, nextValue, reportInvalidNumber, reportOverflowInt, reportOverflowInt, reportOverflowInt, reportOverflowLong, reportOverflowLong, reportOverflowLong, reportUnexpectedNumberChar, skipChildren, streamReadConstraints
-
Methods inherited from class com.fasterxml.jackson.core.JsonParser
_codec, _constructError, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _reportUnsupportedOperation, canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentName, getBinaryValue, getBooleanValue, getByteValue, getCurrentValue, getEmbeddedObject, getFeatureMask, getFormatFeatures, getNonBlockingInputFeeder, getObjectId, getSchema, getShortValue, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, overrideFormatFeatures, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, requiresCustomCodec, setCurrentValue, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema
-
-
-
-
Field Detail
-
_reader
protected java.io.Reader _reader
Reader that can be used for reading more content, if one buffer from input source, but in some cases pre-loaded buffer is handed to the parser.
-
_inputBuffer
protected char[] _inputBuffer
Current buffer from which data is read; generally data is read into buffer from input source.
-
_bufferRecyclable
protected boolean _bufferRecyclable
Flag that indicates whether the input buffer is recycable (and needs to be returned to recycler once we are done) or not.If it is not, it also means that parser can NOT modify underlying buffer.
-
_objectCodec
protected ObjectCodec _objectCodec
-
_symbols
protected final CharsToNameCanonicalizer _symbols
-
_hashSeed
protected final int _hashSeed
-
_tokenIncomplete
protected boolean _tokenIncomplete
Flag that indicates that the current token has not yet been fully processed, and needs to be finished for some access (or skipped to obtain the next token)
-
_nameStartOffset
protected long _nameStartOffset
Value ofParserBase._inputPtrat the time when the first character of name token was read. Used for calculating token location when requested; combined withParserBase._currInputProcessed, may be updated appropriately as needed.- Since:
- 2.7
-
_nameStartRow
protected int _nameStartRow
- Since:
- 2.7
-
_nameStartCol
protected int _nameStartCol
- Since:
- 2.7
-
-
Constructor Detail
-
ReaderBasedJsonParser
public ReaderBasedJsonParser(IOContext ctxt, int features, java.io.Reader r, ObjectCodec codec, CharsToNameCanonicalizer st, char[] inputBuffer, int start, int end, boolean bufferRecyclable)
Constructor called when caller wants to provide input buffer directly (or needs to, in case of bootstrapping having read some of contents) and it may or may not be recyclable use standard recycle context.- Parameters:
ctxt- I/O context to usefeatures- Standard stream read features enabledr- Reader used for reading actual content, if any;nullif nonecodec-ObjectCodecto delegate object deserialization tost- Name canonicalizer to useinputBuffer- Input buffer to read initial content from (before Reader)start- Pointer ininputBufferthat has the first content character to decodeend- Pointer past the last content character ininputBufferbufferRecyclable- WhetherinputBufferpassed is managed by Jackson core (and thereby needs recycling)- Since:
- 2.4
-
ReaderBasedJsonParser
public ReaderBasedJsonParser(IOContext ctxt, int features, java.io.Reader r, ObjectCodec codec, CharsToNameCanonicalizer st)
Constructor called when input comes as aReader, and buffer allocation can be done using default mechanism.- Parameters:
ctxt- I/O context to usefeatures- Standard stream read features enabledr- Reader used for reading actual content, if any;nullif nonecodec-ObjectCodecto delegate object deserialization tost- Name canonicalizer to use
-
-
Method Detail
-
releaseBuffered
public int releaseBuffered(java.io.Writer w) throws java.io.IOExceptionDescription copied from class:JsonParserMethod that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given writer if possible; if underlying input is char-based it can released, if not (byte-based) it cannot.- Overrides:
releaseBufferedin classJsonParser- Parameters:
w- Writer to which buffered but unprocessed content is written to- Returns:
- -1 if the underlying content source is not char-based
(that is, input cannot be sent to
Writer; otherwise number of chars released (0 if there was nothing to release) - Throws:
java.io.IOException- if write using Writer threw exception
-
getInputSource
public java.lang.Object getInputSource()
Description copied from class:JsonParserMethod that can be used to get access to object that is used to access input being parsed; this is usually eitherInputStreamorReader, depending on what parser was constructed with. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser and decorator object.In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.
- Overrides:
getInputSourcein classJsonParser- Returns:
- Input source this parser was configured with
-
getNextChar
@Deprecated protected char getNextChar(java.lang.String eofMsg) throws java.io.IOExceptionDeprecated.- Throws:
java.io.IOException
-
getNextChar
protected char getNextChar(java.lang.String eofMsg, JsonToken forToken) throws java.io.IOException- Throws:
java.io.IOException
-
_closeInput
protected void _closeInput() throws java.io.IOException- Specified by:
_closeInputin classParserBase- Throws:
java.io.IOException
-
_releaseBuffers
protected void _releaseBuffers() throws java.io.IOExceptionMethod 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).- Overrides:
_releaseBuffersin classParserBase- Throws:
java.io.IOException- Not thrown by base implementation but could be thrown by sub-classes
-
_loadMoreGuaranteed
protected void _loadMoreGuaranteed() throws java.io.IOException- Throws:
java.io.IOException
-
_loadMore
protected boolean _loadMore() throws java.io.IOException- Throws:
java.io.IOException
-
getText
public final java.lang.String getText() throws java.io.IOExceptionMethod for accessing textual representation of the current event; if no current event (before first call tonextToken(), or after encountering end-of-input), returns null. Method can be called for any event.- Specified by:
getTextin classParserMinimalBase- Returns:
- Textual value associated with the current token (one returned
by
JsonParser.nextToken()or other iteration methods) - Throws:
java.io.IOException- if there are general I/O or parse issues, including if the text is too large, seeStreamReadConstraints.Builder.maxStringLength(int)
-
getText
public int getText(java.io.Writer writer) throws java.io.IOExceptionDescription copied from class:JsonParserMethod to read the textual representation of the current token in chunks and pass it to the given Writer. Conceptually same as calling:writer.write(parser.getText());
but should typically be more efficient as longer content does need to be combined into a singleStringto return, and write can occur directly from intermediate buffers Jackson uses.NOTE: textual content will still be buffered (usually using
TextBuffer) and will be accessible with othergetText()calls (that is, it will not be consumed). So this accessor only avoids construction ofStringcompared to plainJsonParser.getText()method.- Overrides:
getTextin classJsonParser- Parameters:
writer- Writer to write textual content to- Returns:
- The number of characters written to the Writer
- Throws:
java.io.IOException- for low-level read issues or writes using passedwriter, orJsonParseExceptionfor decoding problems
-
getValueAsString
public final java.lang.String getValueAsString() throws java.io.IOExceptionDescription copied from class:JsonParserMethod that will try to convert value of current token to aString. JSON Strings map naturally; scalar values get converted to their textual representation. If representation cannot be converted to a String value (including structured types like Objects and Arrays andnulltoken), default value of null will be returned; no exceptions are thrown.- Overrides:
getValueAsStringin classParserMinimalBase- Returns:
Stringvalue current token is converted to, if possible;nullotherwise- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsString
public final java.lang.String getValueAsString(java.lang.String defValue) throws java.io.IOExceptionDescription copied from class:JsonParserMethod that will try to convert value of current token to aString. JSON Strings map naturally; scalar values get converted to their textual representation. If representation cannot be converted to a String value (including structured types like Objects and Arrays andnulltoken), specified default value will be returned; no exceptions are thrown.- Overrides:
getValueAsStringin classParserMinimalBase- Parameters:
defValue- Default value to return if conversion toStringis not possible- Returns:
Stringvalue current token is converted to, if possible;defotherwise- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_getText2
protected final java.lang.String _getText2(JsonToken t) throws java.io.IOException
- Throws:
java.io.IOException
-
getTextCharacters
public final char[] getTextCharacters() throws java.io.IOExceptionDescription copied from class:JsonParserMethod similar toJsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:- Textual contents are not guaranteed to start at
index 0 (rather, call
JsonParser.getTextOffset()) to know the actual offset - Length of textual contents may be less than the
length of returned buffer: call
JsonParser.getTextLength()for actual length of returned content.
Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.
The only reason to call this method (over
JsonParser.getText()) is to avoid construction of a String object (which will make a copy of contents).- Specified by:
getTextCharactersin classParserMinimalBase- Returns:
- Buffer that contains the current textual value (but not necessarily at offset 0, and not necessarily until the end of buffer)
- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems, including if the text is too large, seeStreamReadConstraints.Builder.maxStringLength(int)
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
getTextLength
public final int getTextLength() throws java.io.IOExceptionDescription copied from class:JsonParserAccessor used withJsonParser.getTextCharacters(), to know length of String stored in returned buffer.- Specified by:
getTextLengthin classParserMinimalBase- Returns:
- Number of characters within buffer returned
by
JsonParser.getTextCharacters()that are part of textual content of the current token. - Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getTextOffset
public final int getTextOffset() throws java.io.IOExceptionDescription copied from class:JsonParserAccessor used withJsonParser.getTextCharacters(), to know offset of the first text content character within buffer.- Specified by:
getTextOffsetin classParserMinimalBase- Returns:
- Offset of the first character within buffer returned
by
JsonParser.getTextCharacters()that is part of textual content of the current token. - Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getBinaryValue
public byte[] getBinaryValue(Base64Variant b64variant) throws java.io.IOException
Description copied from class:JsonParserMethod that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value. It works similar to getting String value viaJsonParser.getText()and decoding result (except for decoding part), but should be significantly more performant.Note that non-decoded textual contents of the current token are not guaranteed to be accessible after this method is called. Current implementation, for example, clears up textual content during decoding. Decoded binary content, however, will be retained until parser is advanced to the next event.
- Overrides:
getBinaryValuein classParserBase- Parameters:
b64variant- Expected variant of base64 encoded content (seeBase64Variantsfor definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
readBinaryValue
public int readBinaryValue(Base64Variant b64variant, java.io.OutputStream out) throws java.io.IOException
Description copied from class:JsonParserSimilar toJsonParser.readBinaryValue(OutputStream)but allows explicitly specifying base64 variant to use.- Overrides:
readBinaryValuein classJsonParser- Parameters:
b64variant- base64 variant to useout- Output stream to use for passing decoded binary data- Returns:
- Number of bytes that were decoded and written via
OutputStream - Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_readBinary
protected int _readBinary(Base64Variant b64variant, java.io.OutputStream out, byte[] buffer) throws java.io.IOException
- Throws:
java.io.IOException
-
nextToken
public final JsonToken nextToken() throws java.io.IOException
Description copied from class:JsonParserMain iteration method, which will advance stream enough to determine type of the next token, if any. If none remaining (stream has no content other than possible white space before ending), null will be returned.- Specified by:
nextTokenin classParserMinimalBase- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_nextAfterName
private final JsonToken _nextAfterName() throws java.io.IOException
- Throws:
java.io.IOException
-
finishToken
public void finishToken() throws java.io.IOExceptionDescription copied from class:JsonParserMethod that may be used to force full handling of the current token so that even if lazy processing is enabled, the whole contents are read for possible retrieval. This is usually used to ensure that the token end location is available, as well as token contents (similar to what calling, sayJsonParser.getTextCharacters(), would achieve).Note that for many dataformat implementations this method will not do anything; this is the default implementation unless overridden by sub-classes.
- Overrides:
finishTokenin classJsonParser- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
nextFieldName
public boolean nextFieldName(SerializableString sstr) throws java.io.IOException
Description copied from class:JsonParserMethod that fetches next token (as if callingJsonParser.nextToken()) and verifies whether it isJsonToken.FIELD_NAMEwith specified name and returns result of that comparison. It is functionally equivalent to:return (nextToken() == JsonToken.FIELD_NAME) && str.getValue().equals(currentName());
but may be faster for parser to verify, and can therefore be used if caller expects to get such a property name from input next.- Overrides:
nextFieldNamein classJsonParser- Parameters:
sstr- Property name to compare next token to (if next token isJsonToken.FIELD_NAME)- Returns:
Trueif parser advanced toJsonToken.FIELD_NAMEwith specified name;falseotherwise (different token or non-matching name)- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
nextFieldName
public java.lang.String nextFieldName() throws java.io.IOExceptionDescription copied from class:JsonParserMethod that fetches next token (as if callingJsonParser.nextToken()) and verifies whether it isJsonToken.FIELD_NAME; if it is, returns same asJsonParser.currentName(), otherwise null.- Overrides:
nextFieldNamein classJsonParser- Returns:
- Name of the the
JsonToken.FIELD_NAMEparser advanced to, if any;nullif next token is of some other type - Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_isNextTokenNameYes
private final void _isNextTokenNameYes(int i) throws java.io.IOException- Throws:
java.io.IOException
-
_isNextTokenNameMaybe
protected boolean _isNextTokenNameMaybe(int i, java.lang.String nameToMatch) throws java.io.IOException- Throws:
java.io.IOException
-
_nextTokenNotInObject
private final JsonToken _nextTokenNotInObject(int i) throws java.io.IOException
- Throws:
java.io.IOException
-
nextTextValue
public final java.lang.String nextTextValue() throws java.io.IOExceptionDescription copied from class:JsonParserMethod that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_STRINGreturns contained String value; otherwise returns null. It is functionally equivalent to:return (nextToken() == JsonToken.VALUE_STRING) ? getText() : null;
but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.- Overrides:
nextTextValuein classJsonParser- Returns:
- Text value of the
JsonToken.VALUE_STRINGtoken parser advanced to; ornullif next token is of some other type - Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
nextIntValue
public final int nextIntValue(int defaultValue) throws java.io.IOExceptionDescription copied from class:JsonParserMethod that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_NUMBER_INTreturns 32-bit int value; otherwise returns specified default value It is functionally equivalent to:return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getIntValue() : defaultValue;
but may be faster for parser to process, and can therefore be used if caller expects to get an int value next from input.NOTE: value checks are performed similar to
JsonParser.getIntValue()- Overrides:
nextIntValuein classJsonParser- Parameters:
defaultValue- Value to return if next token is NOT of typeJsonToken.VALUE_NUMBER_INT- Returns:
- Integer (
int) value of theJsonToken.VALUE_NUMBER_INTtoken parser advanced to; ordefaultValueif next token is of some other type - Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problemsInputCoercionException- if integer number does not fit in Javaint
-
nextLongValue
public final long nextLongValue(long defaultValue) throws java.io.IOExceptionDescription copied from class:JsonParserMethod that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_NUMBER_INTreturns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getLongValue() : defaultValue;
but may be faster for parser to process, and can therefore be used if caller expects to get a long value next from input.NOTE: value checks are performed similar to
JsonParser.getLongValue()- Overrides:
nextLongValuein classJsonParser- Parameters:
defaultValue- Value to return if next token is NOT of typeJsonToken.VALUE_NUMBER_INT- Returns:
longvalue of theJsonToken.VALUE_NUMBER_INTtoken parser advanced to; ordefaultValueif next token is of some other type- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problemsInputCoercionException- if integer number does not fit in Javalong
-
nextBooleanValue
public final java.lang.Boolean nextBooleanValue() throws java.io.IOExceptionDescription copied from class:JsonParserMethod that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_TRUEorJsonToken.VALUE_FALSEreturns matching Boolean value; otherwise return null. It is functionally equivalent to:JsonToken t = nextToken(); if (t == JsonToken.VALUE_TRUE) return Boolean.TRUE; if (t == JsonToken.VALUE_FALSE) return Boolean.FALSE; return null;
but may be faster for parser to process, and can therefore be used if caller expects to get a Boolean value next from input.- Overrides:
nextBooleanValuein classJsonParser- Returns:
Booleanvalue of theJsonToken.VALUE_TRUEorJsonToken.VALUE_FALSEtoken parser advanced to; ornullif next token is of some other type- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_parseFloatThatStartsWithPeriod
@Deprecated protected final JsonToken _parseFloatThatStartsWithPeriod() throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
_parseFloatThatStartsWithPeriod
protected final JsonToken _parseFloatThatStartsWithPeriod(boolean neg) throws java.io.IOException
- Throws:
java.io.IOException
-
_parseUnsignedNumber
protected final JsonToken _parseUnsignedNumber(int ch) throws java.io.IOException
Initial parsing method for number values. It needs to be able to parse enough input to be able to determine whether the value is to be considered a simple integer value, or a more generic decimal value: latter of which needs to be expressed as a floating point number. The basic rule is that if the number has no fractional or exponential part, it is an integer; otherwise a floating point number.Because much of input has to be processed in any case, no partial parsing is done: all input text will be stored for further processing. However, actual numeric value conversion will be deferred, since it is usually the most complicated and costliest part of processing.
- Parameters:
ch- The first non-null digit character of the number to parse- Returns:
- Type of token decoded, usually
JsonToken.VALUE_NUMBER_INTorJsonToken.VALUE_NUMBER_FLOAT - Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_parseFloat
private final JsonToken _parseFloat(int ch, int startPtr, int ptr, boolean neg, int intLen) throws java.io.IOException
- Throws:
java.io.IOException
-
_parseSignedNumber
private final JsonToken _parseSignedNumber(boolean negative) throws java.io.IOException
- Throws:
java.io.IOException
-
_parseNumber2
private final JsonToken _parseNumber2(boolean neg, int startPtr) throws java.io.IOException
Method called to parse a number, when the primary parse method has failed to parse it, due to it being split on buffer boundary. As a result code is very similar, except that it has to explicitly copy contents to the text buffer instead of just sharing the main input buffer.- Parameters:
neg- Whether number being decoded is negative or notstartPtr- Offset in input buffer for the next character of content- Returns:
- Type of token decoded, usually
JsonToken.VALUE_NUMBER_INTorJsonToken.VALUE_NUMBER_FLOAT - Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_verifyNoLeadingZeroes
private final char _verifyNoLeadingZeroes() throws java.io.IOException- Throws:
java.io.IOException
-
_verifyNLZ2
private char _verifyNLZ2() throws java.io.IOException- Throws:
java.io.IOException
-
_handleInvalidNumberStart
protected JsonToken _handleInvalidNumberStart(int ch, boolean negative) throws java.io.IOException
- Throws:
java.io.IOException
-
_handleInvalidNumberStart
protected JsonToken _handleInvalidNumberStart(int ch, boolean negative, boolean hasSign) throws java.io.IOException
- Throws:
java.io.IOException
-
_verifyRootSpace
private final void _verifyRootSpace(int ch) throws java.io.IOExceptionMethod called to ensure that a root-value is followed by a space token.NOTE: caller MUST ensure there is at least one character available; and that input pointer is AT given char (not past)
- Parameters:
ch- First character of likely white space to skip- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems (invalid white space)
-
_parseName
protected final java.lang.String _parseName() throws java.io.IOException- Throws:
java.io.IOException
-
_parseName2
private java.lang.String _parseName2(int startPtr, int hash, int endChar) throws java.io.IOException- Throws:
java.io.IOException
-
_handleOddName
protected java.lang.String _handleOddName(int i) throws java.io.IOExceptionMethod called when we see non-white space character other than double quote, when expecting a field name. In standard mode will just throw an expection; but in non-standard modes may be able to parse name.- Parameters:
i- First undecoded character of possible "odd name" to decode- Returns:
- Name decoded, if allowed and successful
- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems (invalid name)
-
_parseAposName
protected java.lang.String _parseAposName() throws java.io.IOException- Throws:
java.io.IOException
-
_handleOddValue
protected JsonToken _handleOddValue(int i) throws java.io.IOException
Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content.- Parameters:
i- First undecoded character of possible "odd value" to decode- Returns:
- Type of value decoded, if allowed and successful
- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems (invalid white space)
-
_handleApos
protected JsonToken _handleApos() throws java.io.IOException
- Throws:
java.io.IOException
-
_handleOddName2
private java.lang.String _handleOddName2(int startPtr, int hash, int[] codes) throws java.io.IOException- Throws:
java.io.IOException
-
_finishString
protected final void _finishString() throws java.io.IOException- Overrides:
_finishStringin classParserBase- Throws:
java.io.IOException
-
_finishString2
protected void _finishString2() throws java.io.IOException- Throws:
java.io.IOException
-
_skipString
protected final void _skipString() throws java.io.IOExceptionMethod called to skim through rest of unparsed String value, if it is not needed. This can be done bit faster if contents need not be stored for future access.- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems (invalid white space)
-
_skipCR
protected final void _skipCR() throws java.io.IOException- Throws:
java.io.IOException
-
_skipColon
private final int _skipColon() throws java.io.IOException- Throws:
java.io.IOException
-
_skipColon2
private final int _skipColon2(boolean gotColon) throws java.io.IOException- Throws:
java.io.IOException
-
_skipColonFast
private final int _skipColonFast(int ptr) throws java.io.IOException- Throws:
java.io.IOException
-
_skipComma
private final int _skipComma(int i) throws java.io.IOException- Throws:
java.io.IOException
-
_skipAfterComma2
private final int _skipAfterComma2() throws java.io.IOException- Throws:
java.io.IOException
-
_skipWSOrEnd
private final int _skipWSOrEnd() throws java.io.IOException- Throws:
java.io.IOException
-
_skipWSOrEnd2
private int _skipWSOrEnd2() throws java.io.IOException- Throws:
java.io.IOException
-
_skipComment
private void _skipComment() throws java.io.IOException- Throws:
java.io.IOException
-
_skipCComment
private void _skipCComment() throws java.io.IOException- Throws:
java.io.IOException
-
_skipYAMLComment
private boolean _skipYAMLComment() throws java.io.IOException- Throws:
java.io.IOException
-
_skipLine
private void _skipLine() throws java.io.IOException- Throws:
java.io.IOException
-
_decodeEscaped
protected char _decodeEscaped() throws java.io.IOExceptionDescription copied from class:ParserBaseMethod 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- Overrides:
_decodeEscapedin classParserBase- Returns:
- Character decoded, if any
- Throws:
java.io.IOException- If escape decoding fails
-
_matchTrue
private final void _matchTrue() throws java.io.IOException- Throws:
java.io.IOException
-
_matchFalse
private final void _matchFalse() throws java.io.IOException- Throws:
java.io.IOException
-
_matchNull
private final void _matchNull() throws java.io.IOException- Throws:
java.io.IOException
-
_matchToken
protected final void _matchToken(java.lang.String matchStr, int i) throws java.io.IOException- Throws:
java.io.IOException
-
_matchToken2
private final void _matchToken2(java.lang.String matchStr, int i) throws java.io.IOException- Throws:
java.io.IOException
-
_checkMatchEnd
private final void _checkMatchEnd(java.lang.String matchStr, int i, int c) throws java.io.IOException- Throws:
java.io.IOException
-
_decodeBase64
protected byte[] _decodeBase64(Base64Variant b64variant) throws java.io.IOException
Efficient handling for incremental parsing of base64-encoded textual content.- Parameters:
b64variant- Type of base64 encoding expected in context- Returns:
- Fully decoded value of base64 content
- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems (invalid content)
-
currentLocation
public JsonLocation currentLocation()
Description copied from class:JsonParserMethod that returns location of the last processed input unit (character or byte) from the input; usually for error reporting purposes.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.NAdue to not having access to input location information (when delegating actual decoding work to other library)- Specified by:
currentLocationin classJsonParserBase- Returns:
- Location of the last processed input unit (byte or character)
-
_currentLocationMinusOne
protected JsonLocation _currentLocationMinusOne()
Description copied from class:ParserMinimalBaseFactory method used to provide location for cases where we must read and consume a single "wrong" character (to possibly allow error recovery), but need to report accurate location for that character: if so, the current location is past location we want, and location we want will be "one location earlier".Default implementation simply returns
JsonParser.currentLocation()- Specified by:
_currentLocationMinusOnein classJsonParserBase- Returns:
- Same as
JsonParser.currentLocation()except offset by -1
-
currentTokenLocation
public JsonLocation currentTokenLocation()
Description copied from class:JsonParserMethod that return the starting location of the current (most recently returned) token; that is, the position of the first input unit (character or byte) from input that starts the current token.Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only return
JsonLocation.NAdue to not having access to input location information (when delegating actual decoding work to other library)- Specified by:
currentTokenLocationin classJsonParserBase- Returns:
- Starting location of the token parser currently points to
-
_updateLocation
private final void _updateLocation()
-
_updateNameLocation
private final void _updateNameLocation()
-
_reportInvalidToken
protected void _reportInvalidToken(java.lang.String matchedPart) throws java.io.IOException- Throws:
java.io.IOException
-
_reportInvalidToken
protected void _reportInvalidToken(java.lang.String matchedPart, java.lang.String msg) throws java.io.IOException- Throws:
java.io.IOException
-
_closeScope
private void _closeScope(int i) throws java.io.IOException- Throws:
java.io.IOException
-
-