Class UTF8DataInputJsonParser
- 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.UTF8DataInputJsonParser
-
- All Implemented Interfaces:
Versioned,java.io.Closeable,java.lang.AutoCloseable
public class UTF8DataInputJsonParser extends JsonParserBase
This is a concrete implementation ofJsonParser, which is based on aDataInputas the input source.Due to limitations in look-ahead (basically there's none), as well as overhead of reading content mostly byte-by-byte, there are some minor differences from regular streaming parsing. Specifically:
- Input location offsets not being tracked, as offsets would need to
be updated for each read from all over the place. If caller wants
this information, it has to track this with
DataInput. This also affects column number, so the only location information available is the row (line) number (but even that is approximate in case of two-byte linefeeds -- it should work with single CR or LF tho) - No white space validation: checks are simplified NOT to check for control characters.
- Since:
- 2.8
-
-
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 java.io.DataInput_inputDataprotected int_nextByteSometimes we need buffering for just a single byte we read but have to "push back"private int_quad1Temporary storage for partially parsed name bytes.protected int[]_quadBufferTemporary buffer used for name parsing.protected ByteQuadsCanonicalizer_symbolsSymbol table that contains field names encountered so farprotected 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
_objectCodec, 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 UTF8DataInputJsonParser(IOContext ctxt, int features, java.io.DataInput inputData, ObjectCodec codec, ByteQuadsCanonicalizer sym, int firstByte)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description private void_checkMatchEnd(java.lang.String matchStr, int i, int ch)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 int_decodeCharForError(int firstByte)protected char_decodeEscaped()Method that sub-classes must implement to support escaped sequences in base64-encoded sections.private int_decodeUtf8_2(int c)private int_decodeUtf8_3(int c1)private int_decodeUtf8_4(int c)private java.lang.String_finishAndReturnString()protected void_finishString()private void_finishString2(char[] outBuf, int outPtr, int c)protected java.lang.String_getText2(JsonToken t)protected JsonToken_handleApos()protected JsonToken_handleInvalidNumberStart(int ch, boolean neg)protected JsonToken_handleInvalidNumberStart(int ch, boolean neg, boolean hasSign)private int_handleLeadingZeroes()Method called when we have seen one zero, and want to ensure it is not followed by another, or, if leading zeroes allowed, skipped redundant ones.protected java.lang.String_handleOddName(int ch)Method called when we see non-white space character other than double quote, when expecting a field name.protected JsonToken_handleUnexpectedValue(int c)Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content.protected void_matchToken(java.lang.String matchStr, int i)private JsonToken_nextAfterName()private JsonToken_nextTokenNotInObject(int i)protected java.lang.String_parseAposName()private JsonToken_parseFloat(char[] outBuf, int outPtr, int c, boolean negative, int integerPartLength)protected JsonToken_parseFloatThatStartsWithPeriod()Deprecated.protected JsonToken_parseFloatThatStartsWithPeriod(boolean neg, boolean hasSign)private java.lang.String_parseLongName(int q, int q2, int q3)private java.lang.String_parseMediumName(int q2)private java.lang.String_parseMediumName2(int q3, int q2)protected java.lang.String_parseName(int i)protected JsonToken_parseNegNumber()protected JsonToken_parsePosNumber()private JsonToken_parseSignedNumber(boolean negative)protected JsonToken_parseUnsignedNumber(int c)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_reportInvalidChar(int c)protected void_reportInvalidInitial(int mask)private void_reportInvalidOther(int mask)protected void_reportInvalidToken(int ch, java.lang.String matchedPart)protected void_reportInvalidToken(int ch, java.lang.String matchedPart, java.lang.String msg)private void_skipCComment()private int_skipColon()private int_skipColon2(int i, boolean gotColon)private void_skipComment()private void_skipLine()Method for skipping contents of an input line; usually for CPP and YAML style comments.protected void_skipString()Method called to skim through rest of unparsed String value, if it is not needed.private void_skipUtf8_2()private void_skipUtf8_3()private void_skipUtf8_4()private int_skipWS()private int_skipWSComment(int i)private int_skipWSOrEnd()Alternative to_skipWS()that handles possibleEOFExceptioncaused by trying to read past the end of theDataInput.private boolean_skipYAMLComment()private void_verifyRootSpace()private java.lang.StringaddName(int[] quads, int qlen, int lastQuadBytes)This is the main workhorse method used when we take a symbol table miss.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.private java.lang.StringfindName(int[] quads, int qlen, int lastQuad, int lastQuadBytes)private java.lang.StringfindName(int q1, int lastQuadBytes)private java.lang.StringfindName(int q1, int q2, int lastQuadBytes)private java.lang.StringfindName(int q1, int q2, int q3, int lastQuadBytes)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.java.lang.StringgetText()Method for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken(), 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.intgetValueAsInt()Method that will try to convert value of current token to a Javaintvalue.intgetValueAsInt(int defValue)Method that will try to convert value of current token to a int.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.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.private static intpad(int q, int bytes)Helper method needed to fix [core#148], masking of 0x00 characterprotected java.lang.StringparseEscapedName(int[] quads, int qlen, int currQuad, int ch, int currQuadBytes)private java.lang.StringparseName(int q1, int ch, int lastQuadBytes)private java.lang.StringparseName(int q1, int q2, int ch, int lastQuadBytes)private java.lang.StringparseName(int q1, int q2, int q3, int ch, int lastQuadBytes)intreadBinaryValue(Base64Variant b64variant, java.io.OutputStream out)Similar toJsonParser.readBinaryValue(OutputStream)but allows explicitly specifying base64 variant to use.intreleaseBuffered(java.io.OutputStream out)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, 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, nextFieldName, overrideFormatFeatures, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, requiresCustomCodec, setCurrentValue, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema
-
-
-
-
Field Detail
-
_symbols
protected final ByteQuadsCanonicalizer _symbols
Symbol table that contains field names encountered so far
-
_quadBuffer
protected int[] _quadBuffer
Temporary buffer used for name parsing.
-
_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)
-
_quad1
private int _quad1
Temporary storage for partially parsed name bytes.
-
_inputData
protected java.io.DataInput _inputData
-
_nextByte
protected int _nextByte
Sometimes we need buffering for just a single byte we read but have to "push back"
-
-
Constructor Detail
-
UTF8DataInputJsonParser
public UTF8DataInputJsonParser(IOContext ctxt, int features, java.io.DataInput inputData, ObjectCodec codec, ByteQuadsCanonicalizer sym, int firstByte)
-
-
Method Detail
-
releaseBuffered
public int releaseBuffered(java.io.OutputStream out) 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 stream if possible; if underlying input is byte-based it can released, if not (char-based) it cannot.- Overrides:
releaseBufferedin classJsonParser- Parameters:
out- OutputStream to which buffered, undecoded content is written to- Returns:
- -1 if the underlying content source is not byte based
(that is, input cannot be sent to
OutputStream; otherwise number of bytes released (0 if there was nothing to release) - Throws:
java.io.IOException- if write to stream 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
-
_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
-
getText
public java.lang.String getText() throws java.io.IOExceptionDescription copied from class:JsonParserMethod for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken(), or after encountering end-of-input), returns null. Method can be called for any token type.- 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- for low-level read issues, orJsonParseExceptionfor decoding problems, 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 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 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
-
getValueAsInt
public int getValueAsInt() throws java.io.IOExceptionDescription copied from class:JsonParserMethod that will try to convert value of current token to a Javaintvalue. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation cannot be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.
- Overrides:
getValueAsIntin classParserMinimalBase- Returns:
intvalue current token is converted to, if possible; exception thrown otherwise- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsInt
public int getValueAsInt(int defValue) throws java.io.IOExceptionDescription copied from class:JsonParserMethod that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation cannot be converted to an int (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsIntin classParserMinimalBase- Parameters:
defValue- Default value to return if conversion tointis not possible- Returns:
intvalue 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 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 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 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 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
-
_nextTokenNotInObject
private final JsonToken _nextTokenNotInObject(int i) throws java.io.IOException
- Throws:
java.io.IOException
-
_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 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
-
nextTextValue
public 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 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 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 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, boolean hasSign) throws java.io.IOException
- Throws:
java.io.IOException
-
_parseUnsignedNumber
protected JsonToken _parseUnsignedNumber(int c) 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:
c- 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
-
_parsePosNumber
protected final JsonToken _parsePosNumber() throws java.io.IOException
- Throws:
java.io.IOException
-
_parseNegNumber
protected final JsonToken _parseNegNumber() throws java.io.IOException
- Throws:
java.io.IOException
-
_parseSignedNumber
private final JsonToken _parseSignedNumber(boolean negative) throws java.io.IOException
- Throws:
java.io.IOException
-
_handleLeadingZeroes
private final int _handleLeadingZeroes() throws java.io.IOExceptionMethod called when we have seen one zero, and want to ensure it is not followed by another, or, if leading zeroes allowed, skipped redundant ones.- Returns:
- Character immediately following zeroes
- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_parseFloat
private final JsonToken _parseFloat(char[] outBuf, int outPtr, int c, boolean negative, int integerPartLength) throws java.io.IOException
- Throws:
java.io.IOException
-
_verifyRootSpace
private final void _verifyRootSpace() throws java.io.IOException- Throws:
java.io.IOException
-
_parseName
protected final java.lang.String _parseName(int i) throws java.io.IOException- Throws:
java.io.IOException
-
_parseMediumName
private final java.lang.String _parseMediumName(int q2) throws java.io.IOException- Throws:
java.io.IOException
-
_parseMediumName2
private final java.lang.String _parseMediumName2(int q3, int q2) throws java.io.IOException- Throws:
java.io.IOException
-
_parseLongName
private final java.lang.String _parseLongName(int q, int q2, int q3) throws java.io.IOException- Throws:
java.io.IOException
-
parseName
private final java.lang.String parseName(int q1, int ch, int lastQuadBytes) throws java.io.IOException- Throws:
java.io.IOException
-
parseName
private final java.lang.String parseName(int q1, int q2, int ch, int lastQuadBytes) throws java.io.IOException- Throws:
java.io.IOException
-
parseName
private final java.lang.String parseName(int q1, int q2, int q3, int ch, int lastQuadBytes) throws java.io.IOException- Throws:
java.io.IOException
-
parseEscapedName
protected final java.lang.String parseEscapedName(int[] quads, int qlen, int currQuad, int ch, int currQuadBytes) throws java.io.IOException- Throws:
java.io.IOException
-
_handleOddName
protected java.lang.String _handleOddName(int ch) 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 exception; but in non-standard modes may be able to parse name.- Parameters:
ch- 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
-
findName
private final java.lang.String findName(int q1, int lastQuadBytes) throws JsonParseException, StreamConstraintsException
-
findName
private final java.lang.String findName(int q1, int q2, int lastQuadBytes) throws JsonParseException, StreamConstraintsException
-
findName
private final java.lang.String findName(int q1, int q2, int q3, int lastQuadBytes) throws JsonParseException, StreamConstraintsException
-
findName
private final java.lang.String findName(int[] quads, int qlen, int lastQuad, int lastQuadBytes) throws JsonParseException, StreamConstraintsException
-
addName
private final java.lang.String addName(int[] quads, int qlen, int lastQuadBytes) throws JsonParseException, StreamConstraintsExceptionThis is the main workhorse method used when we take a symbol table miss. It needs to demultiplex individual bytes, decode multi-byte chars (if any), and then construct Name instance and add it to the symbol table.
-
_finishString
protected void _finishString() throws java.io.IOException- Overrides:
_finishStringin classParserBase- Throws:
java.io.IOException
-
_finishAndReturnString
private java.lang.String _finishAndReturnString() throws java.io.IOException- Throws:
java.io.IOException
-
_finishString2
private final void _finishString2(char[] outBuf, int outPtr, int c) throws java.io.IOException- Throws:
java.io.IOException
-
_skipString
protected 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
-
_handleUnexpectedValue
protected JsonToken _handleUnexpectedValue(int c) 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:
c- First undecoded character of unexpected (but possibly ultimate accepted) value- Returns:
- Token that was successfully decoded (if successful)
- Throws:
java.io.IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
_handleApos
protected JsonToken _handleApos() throws java.io.IOException
- Throws:
java.io.IOException
-
_handleInvalidNumberStart
protected JsonToken _handleInvalidNumberStart(int ch, boolean neg) throws java.io.IOException
- Throws:
java.io.IOException
-
_handleInvalidNumberStart
protected JsonToken _handleInvalidNumberStart(int ch, boolean neg, boolean hasSign) 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
-
_checkMatchEnd
private final void _checkMatchEnd(java.lang.String matchStr, int i, int ch) throws java.io.IOException- Throws:
java.io.IOException
-
_skipWS
private final int _skipWS() throws java.io.IOException- Throws:
java.io.IOException
-
_skipWSOrEnd
private final int _skipWSOrEnd() throws java.io.IOExceptionAlternative to_skipWS()that handles possibleEOFExceptioncaused by trying to read past the end of theDataInput.- Throws:
java.io.IOException- Since:
- 2.9
-
_skipWSComment
private final int _skipWSComment(int i) 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(int i, boolean gotColon) throws java.io.IOException- Throws:
java.io.IOException
-
_skipComment
private final void _skipComment() throws java.io.IOException- Throws:
java.io.IOException
-
_skipCComment
private final void _skipCComment() throws java.io.IOException- Throws:
java.io.IOException
-
_skipYAMLComment
private final boolean _skipYAMLComment() throws java.io.IOException- Throws:
java.io.IOException
-
_skipLine
private final void _skipLine() throws java.io.IOExceptionMethod for skipping contents of an input line; usually for CPP and YAML style comments.- 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
-
_decodeCharForError
protected int _decodeCharForError(int firstByte) throws java.io.IOException- Throws:
java.io.IOException
-
_decodeUtf8_2
private final int _decodeUtf8_2(int c) throws java.io.IOException- Throws:
java.io.IOException
-
_decodeUtf8_3
private final int _decodeUtf8_3(int c1) throws java.io.IOException- Throws:
java.io.IOException
-
_decodeUtf8_4
private final int _decodeUtf8_4(int c) throws java.io.IOException- Returns:
- Character value minus 0x10000; this so that caller can readily expand it to actual surrogates
- Throws:
java.io.IOException
-
_skipUtf8_2
private final void _skipUtf8_2() throws java.io.IOException- Throws:
java.io.IOException
-
_skipUtf8_3
private final void _skipUtf8_3() throws java.io.IOException- Throws:
java.io.IOException
-
_skipUtf8_4
private final void _skipUtf8_4() throws java.io.IOException- Throws:
java.io.IOException
-
_reportInvalidToken
protected void _reportInvalidToken(int ch, java.lang.String matchedPart) throws java.io.IOException- Throws:
java.io.IOException
-
_reportInvalidToken
protected void _reportInvalidToken(int ch, java.lang.String matchedPart, java.lang.String msg) throws java.io.IOException- Throws:
java.io.IOException
-
_reportInvalidChar
protected void _reportInvalidChar(int c) throws JsonParseException- Throws:
JsonParseException
-
_reportInvalidInitial
protected void _reportInvalidInitial(int mask) throws JsonParseException- Throws:
JsonParseException
-
_reportInvalidOther
private void _reportInvalidOther(int mask) throws JsonParseException- Throws:
JsonParseException
-
_decodeBase64
protected final 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
-
_closeScope
private void _closeScope(int i) throws java.io.IOException- Throws:
java.io.IOException
-
pad
private static final int pad(int q, int bytes)Helper method needed to fix [core#148], masking of 0x00 character
-
-