Class SmileParser
- All Implemented Interfaces:
Closeable,AutoCloseable,Versioned
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumEnumeration that defines all togglable features for Smile generators.Nested classes/interfaces inherited from class org.codehaus.jackson.JsonParser
JsonParser.NumberType -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanFlag that indicates whether the input buffer is recycable (and needs to be returned to recycler once we are done) or not.protected booleanSpecific flag that is set when we encountered a 32-bit floating point value; needed since numeric super classes do not track distinction between float and double, but Smile format does, and we want to retain that separation.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 InputStreamInput stream that can be used for reading more content, if one in use.protected booleanFlag that indicates whether content can legally have raw (unquoted) binary data.protected ObjectCodecCodec used for data binding when (if) requested.protected intQuads used for hash calculationprotected intQuads used for hash calculationprotected int[]Temporary buffer used for name parsing.protected intprotected String[]Array of recently seen field names, which may be back referenced by later fields.protected intprotected String[]Array of recently seen field names, which may be back referenced by later fields Defaults set to disable handling if no header found.protected final SmileBufferRecycler<String> Helper object used for low-level recycling of Smile-generator specific buffers.protected static final ThreadLocal<SoftReference<SmileBufferRecycler<String>>> ThreadLocalcontains aSoftReferenceto a buffer recycler used to provide a low-cost buffer recycling for Smile-specific buffers.protected final BytesToNameCanonicalizerSymbol table that contains field names encountered so farprotected booleanFlag 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)protected intType byte of the current tokenFields 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_UNKNOWNFields 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_uFields inherited from class org.codehaus.jackson.JsonParser
_currToken, _features, _lastClearedToken -
Constructor Summary
ConstructorsConstructorDescriptionSmileParser(IOContext ctxt, int parserFeatures, int smileFeatures, ObjectCodec codec, BytesToNameCanonicalizer sym, InputStream in, byte[] inputBuffer, int start, int end, boolean bufferRecyclable) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidprotected byte[]_decodeBase64(Base64Variant b64variant) protected final void_decodeShortAsciiValue(int len) protected final void_decodeShortUnicodeValue(int len) protected final void_finishNumberToken(int tb) protected voidprotected voidMethod called to finish parsing of a token so that token contents are retriableprotected final JsonTokenMethod that handles initial token type recognition for token that has to be either FIELD_NAME or END_OBJECT.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 void_parseNumericValue(int expType) Method that will parse actual numeric value out of a syntactically valid number value.protected voidMethod 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_reportInvalidSharedName(int index) protected void_reportInvalidSharedStringValue(int index) protected voidHelper method for skipping length-prefixed binary data sectionprotected void_skipBytes(int len) protected voidMethod called to skip remainders of an incomplete token, when contents themselves will not be needed any moreprotected static final SmileBufferRecycler<String> voidclose()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_SOURCEis 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 forObjectCodecassociated with this parser, if any.Overridden since we do not really have character-based locations, but we do have byte offset to specify.Method that can be called to get the name associated with the current event.Accessor that can be called if (and only if) the current token isJsonToken.VALUE_EMBEDDED_OBJECT.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.If current token is of typeJsonToken.VALUE_NUMBER_INTorJsonToken.VALUE_NUMBER_FLOAT, returns one ofJsonParser.NumberTypeconstants; otherwise returns null.getText()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.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.intAccessor used withJsonParser.getTextCharacters(), to know length of String stored in returned buffer.intAccessor used withJsonParser.getTextCharacters(), to know offset of the first text content character within buffer.Overridden since we do not really have character-based locations, but we do have byte offset to specify.protected booleanhandleSignature(boolean consumeFirstByte, boolean throwException) Helper method called when it looks like input might contain the signature; and it is necessary to detect and handle signature to get configuration information it might have.booleanMethod that can be used to determine whether calling ofJsonParser.getTextCharacters()would be the most efficient way to access textual content for the event parser currently points to.protected final booleanloadMore()booleanMethod that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_TRUEorJsonToken.VALUE_FALSEreturns matching Boolean value; otherwise return null.booleanMethod 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:Method that fetches next token (as if callingJsonParser.nextToken()) and if it isJsonToken.VALUE_STRINGreturns contained String value; otherwise returns null.Main iteration method, which will advance stream enough to determine type of the next token, if any.intMethod that can be called to push back any content that has been read but not consumed by the parser.voidSetter that allows definingObjectCodecassociated with this parser, if any.Methods inherited from class org.codehaus.jackson.impl.JsonParserBase
_decodeBase64Escape, _decodeBase64Escape, _decodeEscaped, _getByteArrayBuilder, _handleEOF, _reportMismatchedEndMarker, convertNumberToBigDecimal, convertNumberToBigInteger, convertNumberToDouble, convertNumberToInt, convertNumberToLong, getBigIntegerValue, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberValue, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, isClosed, loadMoreGuaranteed, reportInvalidBase64Char, reportInvalidBase64Char, reportInvalidNumber, reportOverflowInt, reportOverflowLong, reportUnexpectedNumberChar, reset, resetAsNaN, resetFloat, resetInt, versionMethods 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, skipChildrenMethods inherited from class org.codehaus.jackson.JsonParser
_constructError, canUseSchema, clearCurrentToken, configure, disable, disableFeature, enable, enableFeature, getBinaryValue, getBooleanValue, getByteValue, getCurrentToken, 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. -
_mayContainRawBinary
protected boolean _mayContainRawBinaryFlag that indicates whether content can legally have raw (unquoted) binary data. Since this information is included both in header and in actual binary data blocks there is redundancy, and we want to ensure settings are compliant. Using application may also want to know this setting in case it does some direct (random) access. -
_smileBufferRecycler
Helper object used for low-level recycling of Smile-generator specific buffers.- Since:
- 1.7
-
_inputStream
Input stream that can be used for reading more content, if one in use. May be null, if input comes just as a full buffer, or if the stream has been closed. -
_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.
-
_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) -
_typeByte
protected int _typeByteType byte of the current token -
_got32BitFloat
protected boolean _got32BitFloatSpecific flag that is set when we encountered a 32-bit floating point value; needed since numeric super classes do not track distinction between float and double, but Smile format does, and we want to retain that separation. -
_symbols
Symbol table that contains field names encountered so far -
_quadBuffer
protected int[] _quadBufferTemporary buffer used for name parsing. -
_quad1
protected int _quad1Quads used for hash calculation -
_quad2
protected int _quad2Quads used for hash calculation -
_seenNames
Array of recently seen field names, which may be back referenced by later fields. Defaults set to enable handling even if no header found. -
_seenNameCount
protected int _seenNameCount -
_seenStringValues
Array of recently seen field names, which may be back referenced by later fields Defaults set to disable handling if no header found. -
_seenStringValueCount
protected int _seenStringValueCount -
_smileRecyclerRef
ThreadLocalcontains aSoftReferenceto a buffer recycler used to provide a low-cost buffer recycling for Smile-specific buffers.
-
-
Constructor Details
-
SmileParser
public SmileParser(IOContext ctxt, int parserFeatures, int smileFeatures, ObjectCodec codec, BytesToNameCanonicalizer sym, InputStream in, byte[] inputBuffer, int start, int end, boolean bufferRecyclable)
-
-
Method Details
-
getCodec
Description copied from class:JsonParserAccessor forObjectCodecassociated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)method (and its variants).- Specified by:
getCodecin classJsonParser
-
setCodec
Description copied from class:JsonParserSetter that allows definingObjectCodecassociated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)method (and its variants).- Specified by:
setCodecin classJsonParser
-
handleSignature
protected boolean handleSignature(boolean consumeFirstByte, boolean throwException) throws IOException, JsonParseException Helper method called when it looks like input might contain the signature; and it is necessary to detect and handle signature to get configuration information it might have.- Returns:
- True if valid signature was found and handled; false if not
- Throws:
IOExceptionJsonParseException
-
_smileBufferRecycler
- Since:
- 1.7
-
releaseBuffered
Description 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 can not.- Overrides:
releaseBufferedin 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: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
-
getTokenLocation
Overridden since we do not really have character-based locations, but we do have byte offset to specify.- Overrides:
getTokenLocationin classJsonParserBase
-
getCurrentLocation
Overridden since we do not really have character-based locations, but we do have byte offset to specify.- Overrides:
getCurrentLocationin classJsonParserBase
-
loadMore
- Specified by:
loadMorein 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:
_closeInputin classJsonParserBase- Throws:
IOException
-
_finishString
- Specified by:
_finishStringin classJsonParserBase- Throws:
IOExceptionJsonParseException
-
close
Description copied from class:JsonParserCloses 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_SOURCEis enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so checkJsonFactoryfor details, but the general idea is that if caller passes in closable resource (such asInputStreamorReader) parser does NOT own the source; but if it passes a reference (such asFileorURLand creates stream or reader it does own them.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classJsonParserBase- Throws:
IOException
-
hasTextCharacters
public boolean hasTextCharacters()Description copied from class:JsonParserMethod that can be used to determine whether calling ofJsonParser.getTextCharacters()would be the most efficient way to access textual content for the event parser currently points to.Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.
- Overrides:
hasTextCharactersin classJsonParserBase- Returns:
- True if parser currently has character array that can
be efficiently returned via
JsonParser.getTextCharacters(); false means that it may or may not exist
-
_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:
_releaseBuffersin classJsonParserBase- Throws:
IOException
-
mayContainRawBinary
public boolean mayContainRawBinary() -
nextToken
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 classJsonParserMinimalBase- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
IOExceptionJsonParseException
-
getCurrentName
Description copied from class:JsonParserBaseMethod that can be called to get the name associated with the current event.- Overrides:
getCurrentNamein classJsonParserBase- Throws:
IOExceptionJsonParseException
-
getNumberType
Description copied from class:JsonParserIf current token is of typeJsonToken.VALUE_NUMBER_INTorJsonToken.VALUE_NUMBER_FLOAT, returns one ofJsonParser.NumberTypeconstants; otherwise returns null.- Overrides:
getNumberTypein classJsonParserBase- Throws:
IOExceptionJsonParseException
-
nextFieldName
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) 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:
nextFieldNamein classJsonParser- Parameters:
str- Property name to compare next token to (if next token isJsonToken.FIELD_NAME)- Throws:
IOExceptionJsonParseException
-
nextTextValue
Description 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- Throws:
IOExceptionJsonParseException
-
nextIntValue
Description 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 a String value next from input.- Overrides:
nextIntValuein classJsonParser- Throws:
IOExceptionJsonParseException
-
nextLongValue
Description 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 String value next from input.- Overrides:
nextLongValuein classJsonParser- Throws:
IOExceptionJsonParseException
-
nextBooleanValue
Description 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 String value next from input.- Overrides:
nextBooleanValuein classJsonParser- Throws:
IOExceptionJsonParseException
-
getText
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. Method can be called for any event.- Specified by:
getTextin classJsonParserMinimalBase- Throws:
IOExceptionJsonParseException
-
getTextCharacters
Description 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 classJsonParserMinimalBase- Throws:
IOExceptionJsonParseException
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
getTextLength
Description copied from class:JsonParserAccessor used withJsonParser.getTextCharacters(), to know length of String stored in returned buffer.- Specified by:
getTextLengthin classJsonParserMinimalBase- Returns:
- Number of characters within buffer returned
by
JsonParser.getTextCharacters()that are part of textual content of the current token. - Throws:
IOExceptionJsonParseException
-
getTextOffset
Description copied from class:JsonParserAccessor used withJsonParser.getTextCharacters(), to know offset of the first text content character within buffer.- Specified by:
getTextOffsetin classJsonParserMinimalBase- Returns:
- Offset of the first character within buffer returned
by
JsonParser.getTextCharacters()that is part of textual content of the current token. - Throws:
IOExceptionJsonParseException
-
getBinaryValue
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.
- Specified by:
getBinaryValuein classJsonParserMinimalBase- Parameters:
b64variant- Expected variant of base64 encoded content (seeBase64Variantsfor definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
IOExceptionJsonParseException
-
getEmbeddedObject
Description copied from class:JsonParserAccessor that can be called if (and only if) the current token isJsonToken.VALUE_EMBEDDED_OBJECT. For other token types, null is returned.Note: only some specialized parser implementations support embedding of objects (usually ones that are facades on top of non-streaming sources, such as object trees).
- Overrides:
getEmbeddedObjectin classJsonParser- Throws:
IOExceptionJsonParseException
-
_decodeBase64
- Throws:
IOExceptionJsonParseException
-
_handleFieldName
Method that handles initial token type recognition for token that has to be either FIELD_NAME or END_OBJECT.- Throws:
IOExceptionJsonParseException
-
_parseNumericValue
Description copied from class:JsonParserBaseMethod that will parse actual numeric value out of a syntactically valid number value. Type it will parse into depends on whether it is a floating point number, as well as its magnitude: smallest legal type (of ones available) is used for efficiency.- Overrides:
_parseNumericValuein classJsonParserBase- Parameters:
expType- Numeric type that we will immediately need, if any; mostly necessary to optimize handling of floating point numbers- Throws:
IOExceptionJsonParseException
-
_finishToken
Method called to finish parsing of a token so that token contents are retriable- Throws:
IOExceptionJsonParseException
-
_finishNumberToken
- Throws:
IOExceptionJsonParseException
-
_decodeShortAsciiValue
- Throws:
IOExceptionJsonParseException
-
_decodeShortUnicodeValue
- Throws:
IOExceptionJsonParseException
-
_skipIncomplete
Method called to skip remainders of an incomplete token, when contents themselves will not be needed any more- Throws:
IOExceptionJsonParseException
-
_skipBytes
- Throws:
IOExceptionJsonParseException
-
_skip7BitBinary
Helper method for skipping length-prefixed binary data section- Throws:
IOExceptionJsonParseException
-
_reportInvalidChar
- Throws:
JsonParseException
-
_reportInvalidInitial
- Throws:
JsonParseException
-
_reportInvalidOther
- Throws:
JsonParseException
-
_reportInvalidOther
- Throws:
JsonParseException
-