Class Utf8StreamParser
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Versioned
JsonParser
, which is
based on a InputStream
as the input source.-
Nested Class Summary
Nested classes/interfaces inherited from class org.codehaus.jackson.JsonParser
JsonParser.Feature, JsonParser.NumberType
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Flag that indicates whether the input buffer is recycable (and needs to be returned to recycler once we are done) or not.protected byte[]
Current buffer from which data is read; generally data is read into buffer from input source, but in some cases pre-loaded buffer is handed to the parser.protected InputStream
protected ObjectCodec
Codec used for data binding when (if) requested; typically fullObjectMapper
, but that abstract is not part of core package.protected int[]
Temporary buffer used for name parsing.protected final BytesToNameCanonicalizer
Symbol table that contains field names encountered so farprotected boolean
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)Fields inherited from class org.codehaus.jackson.impl.JsonParserBase
_binaryValue, _byteArrayBuilder, _closed, _currInputProcessed, _currInputRow, _currInputRowStart, _expLength, _fractLength, _inputEnd, _inputPtr, _intLength, _ioContext, _nameCopied, _nameCopyBuffer, _nextToken, _numberBigDecimal, _numberBigInt, _numberDouble, _numberInt, _numberLong, _numberNegative, _numTypesValid, _parsingContext, _textBuffer, _tokenInputCol, _tokenInputRow, _tokenInputTotal, CHAR_NULL, INT_0, INT_1, INT_2, INT_3, INT_4, INT_5, INT_6, INT_7, INT_8, INT_9, INT_DECIMAL_POINT, INT_e, INT_E, INT_MINUS, INT_PLUS, NR_BIGDECIMAL, NR_BIGINT, NR_DOUBLE, NR_INT, NR_LONG, NR_UNKNOWN
Fields inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase
INT_APOSTROPHE, INT_ASTERISK, INT_b, INT_BACKSLASH, INT_COLON, INT_COMMA, INT_CR, INT_f, INT_LBRACKET, INT_LCURLY, INT_LF, INT_n, INT_QUOTE, INT_r, INT_RBRACKET, INT_RCURLY, INT_SLASH, INT_SPACE, INT_t, INT_TAB, INT_u
Fields inherited from class org.codehaus.jackson.JsonParser
_currToken, _features, _lastClearedToken
-
Constructor Summary
ConstructorsConstructorDescriptionUtf8StreamParser
(IOContext ctxt, int features, InputStream in, ObjectCodec codec, BytesToNameCanonicalizer sym, byte[] inputBuffer, int start, int end, boolean bufferRecyclable) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
protected byte[]
_decodeBase64
(Base64Variant b64variant) Efficient handling for incremental parsing of base64-encoded textual content.protected int
_decodeCharForError
(int firstByte) protected final char
Method that sub-classes must implement to support escaped sequences in base64-encoded sections.protected void
protected final String
protected JsonToken
protected JsonToken
_handleInvalidNumberStart
(int ch, boolean negative) Method called if expected numeric value (due to leading sign) does not look like a numberprotected 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 final Name
_handleUnusualFieldName
(int ch) Method called when we see non-white space character other than double quote, when expecting a field name.protected final boolean
_loadToHaveAtLeast
(int minAvailable) Helper method that will try to load at least specified number bytes in input buffer, possible moving existing data around if necessaryprotected final void
_matchToken
(String matchStr, int i) protected final Name
protected final Name
_parseFieldName
(int i) protected void
Method called to release internal buffers owned by the base reader.protected void
_reportInvalidChar
(int c) protected void
_reportInvalidInitial
(int mask) protected void
_reportInvalidOther
(int mask) protected void
_reportInvalidOther
(int mask, int ptr) protected void
_reportInvalidToken
(String matchedPart, String msg) protected final void
_skipCR()
We actually need to check the character value here (to see if we have \n following \r).protected final void
_skipLF()
protected void
Method called to skim through rest of unparsed String value, if it is not needed.void
close()
Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled.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.getCodec()
Accessor forObjectCodec
associated with this parser, if any.Method that can be used to get access to object that is used to access input being parsed; this is usually eitherInputStream
orReader
, depending on what parser was constructed with.getText()
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.char[]
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.int
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.int
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.static int[]
growArrayBy
(int[] arr, int more) protected final boolean
loadMore()
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null.boolean
Method that fetches next token (as if callingJsonParser.nextToken()
) and verifies whether it isJsonToken.FIELD_NAME
with specified name and returns result of that comparison.int
nextIntValue
(int defaultValue) Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 32-bit int value; otherwise returns specified default value It is functionally equivalent to:long
nextLongValue
(long defaultValue) Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_STRING
returns contained String value; otherwise returns null.Main iteration method, which will advance stream enough to determine type of the next token, if any.protected Name
parseEscapedFieldName
(int[] quads, int qlen, int currQuad, int ch, int currQuadBytes) Slower parsing method which is generally branched to when an escape sequence is detected (or alternatively for long names, or ones crossing input buffer boundary).protected Name
parseLongFieldName
(int q) protected final Name
parseMediumFieldName
(int q2, int[] codes) protected final JsonToken
parseNumberText
(int c) Initial parsing method for number values.int
Method that can be called to push back any content that has been read but not consumed by the parser.void
Setter that allows definingObjectCodec
associated with this parser, if any.protected Name
Method called when not even first 8 bytes are guaranteed to come consequtively.Methods inherited from class org.codehaus.jackson.impl.JsonParserBase
_decodeBase64Escape, _decodeBase64Escape, _getByteArrayBuilder, _handleEOF, _parseNumericValue, _reportMismatchedEndMarker, convertNumberToBigDecimal, convertNumberToBigInteger, convertNumberToDouble, convertNumberToInt, convertNumberToLong, getBigIntegerValue, getCurrentLocation, getCurrentName, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberType, getNumberValue, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, getTokenLocation, hasTextCharacters, isClosed, loadMoreGuaranteed, reportInvalidBase64Char, reportInvalidBase64Char, reportInvalidNumber, reportOverflowInt, reportOverflowLong, reportUnexpectedNumberChar, reset, resetAsNaN, resetFloat, resetInt, version
Methods inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase
_constructError, _decodeBase64, _getCharDesc, _handleUnrecognizedCharacterEscape, _reportBase64EOF, _reportError, _reportInvalidBase64, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportUnexpectedChar, _throwInternal, _throwInvalidSpace, _throwUnquotedSpace, _wrapError, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, skipChildren
Methods inherited from class org.codehaus.jackson.JsonParser
_constructError, canUseSchema, clearCurrentToken, configure, disable, disableFeature, enable, enableFeature, getBinaryValue, getBooleanValue, getByteValue, getCurrentToken, getEmbeddedObject, getLastClearedToken, getShortValue, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, hasCurrentToken, isEnabled, isExpectedStartArrayToken, isFeatureEnabled, nextValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, setFeature, setSchema
-
Field Details
-
_objectCodec
Codec used for data binding when (if) requested; typically fullObjectMapper
, but that abstract is not part of core package. -
_symbols
Symbol table that contains field names encountered so far -
_quadBuffer
protected int[] _quadBufferTemporary buffer used for name parsing. -
_tokenIncomplete
protected 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) -
_inputStream
-
_inputBuffer
protected byte[] _inputBufferCurrent buffer from which data is read; generally data is read into buffer from input source, but in some cases pre-loaded buffer is handed to the parser. -
_bufferRecyclable
protected boolean _bufferRecyclableFlag 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.
-
-
Constructor Details
-
Utf8StreamParser
public Utf8StreamParser(IOContext ctxt, int features, InputStream in, ObjectCodec codec, BytesToNameCanonicalizer sym, byte[] inputBuffer, int start, int end, boolean bufferRecyclable)
-
-
Method Details
-
getCodec
Description copied from class:JsonParser
Accessor forObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
getCodec
in classJsonParser
-
setCodec
Description copied from class:JsonParser
Setter that allows definingObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
setCodec
in classJsonParser
-
releaseBuffered
Description copied from class:JsonParser
Method 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 can not.- Overrides:
releaseBuffered
in classJsonParser
- Returns:
- -1 if the underlying content source is not byte based
(that is, input can not be sent to
OutputStream
; otherwise number of bytes released (0 if there was nothing to release) - Throws:
IOException
- if write to stream threw exception
-
getInputSource
Description copied from class:JsonParser
Method that can be used to get access to object that is used to access input being parsed; this is usually eitherInputStream
orReader
, 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:
getInputSource
in classJsonParser
-
loadMore
- Specified by:
loadMore
in classJsonParserBase
- Throws:
IOException
-
_loadToHaveAtLeast
Helper method that will try to load at least specified number bytes in input buffer, possible moving existing data around if necessary- Throws:
IOException
- Since:
- 1.6
-
_closeInput
- Specified by:
_closeInput
in classJsonParserBase
- Throws:
IOException
-
_releaseBuffers
Method called to release internal buffers owned by the base reader. This may be called along with_closeInput()
(for example, when explicitly closing this reader instance), or separately (if need be).- Overrides:
_releaseBuffers
in classJsonParserBase
- Throws:
IOException
-
getText
Description copied from class:JsonParser
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. Method can be called for any token type.- Specified by:
getText
in classJsonParserMinimalBase
- Throws:
IOException
JsonParseException
-
_getText2
-
getTextCharacters
Description copied from class:JsonParser
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. 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:
getTextCharacters
in classJsonParserMinimalBase
- Throws:
IOException
JsonParseException
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
getTextLength
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.- Specified by:
getTextLength
in classJsonParserMinimalBase
- Returns:
- Number of characters within buffer returned
by
JsonParser.getTextCharacters()
that are part of textual content of the current token. - Throws:
IOException
JsonParseException
-
getTextOffset
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.- Specified by:
getTextOffset
in classJsonParserMinimalBase
- Returns:
- Offset of the first character within buffer returned
by
JsonParser.getTextCharacters()
that is part of textual content of the current token. - Throws:
IOException
JsonParseException
-
getBinaryValue
Description copied from class:JsonParser
Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value. It works similar to getting String value 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.
- Specified by:
getBinaryValue
in classJsonParserMinimalBase
- Parameters:
b64variant
- Expected variant of base64 encoded content (seeBase64Variants
for definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
IOException
JsonParseException
-
nextToken
Description copied from class:JsonParser
Main 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:
nextToken
in classJsonParserMinimalBase
- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
IOException
JsonParseException
-
close
Description copied from class:JsonParser
Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so checkJsonFactory
for details, but the general idea is that if caller passes in closable resource (such asInputStream
orReader
) parser does NOT own the source; but if it passes a reference (such asFile
orURL
and creates stream or reader it does own them.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classJsonParserBase
- Throws:
IOException
-
nextFieldName
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and verifies whether it isJsonToken.FIELD_NAME
with specified name and returns result of that comparison. It is functionally equivalent to:return (nextToken() == JsonToken.FIELD_NAME) invalid input: '&'invalid input: '&' str.getValue().equals(getCurrentName());
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:
nextFieldName
in classJsonParser
- Parameters:
str
- Property name to compare next token to (if next token isJsonToken.FIELD_NAME
)
- Throws:
IOException
JsonParseException
-
nextTextValue
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_STRING
returns 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:
nextTextValue
in classJsonParser
- Throws:
IOException
JsonParseException
-
nextIntValue
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 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 a String value next from input.- Overrides:
nextIntValue
in classJsonParser
- Throws:
IOException
JsonParseException
-
nextLongValue
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 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 String value next from input.- Overrides:
nextLongValue
in classJsonParser
- Throws:
IOException
JsonParseException
-
nextBooleanValue
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
returns 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 String value next from input.- Overrides:
nextBooleanValue
in classJsonParser
- Throws:
IOException
JsonParseException
-
parseNumberText
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.
- Throws:
IOException
JsonParseException
-
_parseFieldName
- Throws:
IOException
JsonParseException
-
parseMediumFieldName
protected final Name parseMediumFieldName(int q2, int[] codes) throws IOException, JsonParseException - Throws:
IOException
JsonParseException
-
parseLongFieldName
- Throws:
IOException
JsonParseException
-
slowParseFieldName
Method called when not even first 8 bytes are guaranteed to come consequtively. Happens rarely, so this is offlined; plus we'll also do full checks for escaping etc.- Throws:
IOException
JsonParseException
-
parseEscapedFieldName
protected Name parseEscapedFieldName(int[] quads, int qlen, int currQuad, int ch, int currQuadBytes) throws IOException, JsonParseException Slower parsing method which is generally branched to when an escape sequence is detected (or alternatively for long names, or ones crossing input buffer boundary). In any case, needs to be able to handle more exceptional cases, gets slower, and hance is offlined to a separate method.- Throws:
IOException
JsonParseException
-
_handleUnusualFieldName
Method 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.- Throws:
IOException
JsonParseException
-
_parseApostropheFieldName
- Throws:
IOException
JsonParseException
-
_finishString
- Specified by:
_finishString
in classJsonParserBase
- Throws:
IOException
JsonParseException
-
_skipString
Method 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:
IOException
JsonParseException
-
_handleUnexpectedValue
Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content.- Throws:
IOException
JsonParseException
- Since:
- 1.3
-
_handleApostropheValue
- Throws:
IOException
JsonParseException
-
_handleInvalidNumberStart
protected JsonToken _handleInvalidNumberStart(int ch, boolean negative) throws IOException, JsonParseException Method called if expected numeric value (due to leading sign) does not look like a number- Throws:
IOException
JsonParseException
-
_matchToken
- Throws:
IOException
JsonParseException
-
_reportInvalidToken
protected void _reportInvalidToken(String matchedPart, String msg) throws IOException, JsonParseException - Throws:
IOException
JsonParseException
-
_decodeEscaped
Description copied from class:JsonParserBase
Method that sub-classes must implement to support escaped sequences in base64-encoded sections. Sub-classes that do not need base64 support can leave this as is- Overrides:
_decodeEscaped
in classJsonParserBase
- Throws:
IOException
JsonParseException
-
_decodeCharForError
- Throws:
IOException
JsonParseException
-
_skipCR
We actually need to check the character value here (to see if we have \n following \r).- Throws:
IOException
-
_skipLF
- Throws:
IOException
-
_reportInvalidChar
- Throws:
JsonParseException
-
_reportInvalidInitial
- Throws:
JsonParseException
-
_reportInvalidOther
- Throws:
JsonParseException
-
_reportInvalidOther
- Throws:
JsonParseException
-
growArrayBy
public static int[] growArrayBy(int[] arr, int more) -
_decodeBase64
Efficient handling for incremental parsing of base64-encoded textual content.- Throws:
IOException
JsonParseException
-