org.codehaus.jackson.smile
Class SmileParser

java.lang.Object
  extended by org.codehaus.jackson.JsonParser
      extended by org.codehaus.jackson.impl.JsonParserMinimalBase
          extended by org.codehaus.jackson.impl.JsonParserBase
              extended by org.codehaus.jackson.impl.JsonNumericParserBase
                  extended by org.codehaus.jackson.impl.StreamBasedParserBase
                      extended by org.codehaus.jackson.smile.SmileParser
All Implemented Interfaces:
Closeable, Versioned

public class SmileParser
extends StreamBasedParserBase


Nested Class Summary
static class SmileParser.Feature
          Enumeration that defines all togglable features for Smile generators.
 
Nested classes/interfaces inherited from class org.codehaus.jackson.JsonParser
JsonParser.NumberType
 
Field Summary
protected  boolean _got32BitFloat
          Specific 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  boolean _mayContainRawBinary
          Flag that indicates whether content can legally have raw (unquoted) binary data.
protected  ObjectCodec _objectCodec
          Codec used for data binding when (if) requested.
protected  int _quad1
          Quads used for hash calculation
protected  int _quad2
          Quads used for hash calculation
protected  int[] _quadBuffer
          Temporary buffer used for name parsing.
protected  int _seenNameCount
           
protected  String[] _seenNames
          Array of recently seen field names, which may be back referenced by later fields.
protected  int _seenStringValueCount
           
protected  String[] _seenStringValues
          Array of recently seen field names, which may be back referenced by later fields Defaults set to disable handling if no header found.
protected  SmileBufferRecycler<String> _smileBufferRecycler
          Helper object used for low-level recycling of Smile-generator specific buffers.
protected static ThreadLocal<SoftReference<SmileBufferRecycler<String>>> _smileRecyclerRef
          ThreadLocal contains a SoftRerefence to a buffer recycler used to provide a low-cost buffer recycling for Smile-specific buffers.
protected  BytesToNameCanonicalizer _symbols
          Symbol table that contains field names encountered so far
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)
protected  int _typeByte
          Type byte of the current token
 
Fields inherited from class org.codehaus.jackson.impl.StreamBasedParserBase
_bufferRecyclable, _inputBuffer, _inputStream
 
Fields inherited from class org.codehaus.jackson.impl.JsonNumericParserBase
_expLength, _fractLength, _intLength, _numberBigDecimal, _numberBigInt, _numberDouble, _numberInt, _numberLong, _numberNegative, _numTypesValid, 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.JsonParserBase
_binaryValue, _byteArrayBuilder, _closed, _currInputProcessed, _currInputRow, _currInputRowStart, _inputEnd, _inputPtr, _ioContext, _nameCopied, _nameCopyBuffer, _nextToken, _parsingContext, _textBuffer, _tokenInputCol, _tokenInputRow, _tokenInputTotal
 
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
SmileParser(IOContext ctxt, int parserFeatures, int smileFeatures, ObjectCodec codec, BytesToNameCanonicalizer sym, InputStream in, byte[] inputBuffer, int start, int end, boolean bufferRecyclable)
           
 
Method Summary
protected  byte[] _decodeBase64(Base64Variant b64variant)
           
protected  void _decodeShortAsciiValue(int len)
           
protected  void _decodeShortUnicodeValue(int len)
           
protected  void _finishNumberToken(int tb)
           
protected  void _finishString()
           
protected  void _finishToken()
          Method called to finish parsing of a token so that token contents are retriable
protected  JsonToken _handleFieldName()
          Method that handles initial token type recognition for token that has to be either FIELD_NAME or END_OBJECT.
protected  void _parseNumericValue(int expType)
          Method that will parse actual numeric value out of a syntactically valid number value.
protected  void _releaseBuffers()
          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 _reportInvalidSharedName(int index)
           
protected  void _reportInvalidSharedStringValue(int index)
           
protected  void _skip7BitBinary()
          Helper method for skipping length-prefixed binary data section
protected  void _skipBytes(int len)
           
protected  void _skipIncomplete()
          Method called to skip remainders of an incomplete token, when contents themselves will not be needed any more
protected static SmileBufferRecycler<String> _smileBufferRecycler()
           
 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 feature JsonParser.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.
 ObjectCodec getCodec()
          Accessor for ObjectCodec associated with this parser, if any.
 String getCurrentName()
          Method that can be called to get the name associated with the current event.
 Object getEmbeddedObject()
          Accessor that can be called if (and only if) the current token is JsonToken.VALUE_EMBEDDED_OBJECT.
 JsonParser.NumberType getNumberType()
          If current token is of type JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberType constants; otherwise returns null.
 String getText()
          Method for accessing textual representation of the current event; if no current event (before first call to nextToken(), or after encountering end-of-input), returns null.
 char[] getTextCharacters()
          Method similar to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.
 int getTextLength()
          Accessor used with JsonParser.getTextCharacters(), to know length of String stored in returned buffer.
 int getTextOffset()
          Accessor used with JsonParser.getTextCharacters(), to know offset of the first text content character within buffer.
protected  boolean handleSignature(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.
 boolean mayContainRawBinary()
           
 JsonToken nextToken()
          Main iteration method, which will advance stream enough to determine type of the next token, if any.
 void setCodec(ObjectCodec c)
          Setter that allows defining ObjectCodec associated with this parser, if any.
 
Methods inherited from class org.codehaus.jackson.impl.StreamBasedParserBase
_closeInput, _loadToHaveAtLeast, getInputSource, loadMore, releaseBuffered
 
Methods inherited from class org.codehaus.jackson.impl.JsonNumericParserBase
convertNumberToBigDecimal, convertNumberToBigInteger, convertNumberToDouble, convertNumberToInt, convertNumberToLong, getBigIntegerValue, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberValue, reportInvalidNumber, reportOverflowInt, reportOverflowLong, reportUnexpectedNumberChar, reset, resetAsNaN, resetFloat, resetInt
 
Methods inherited from class org.codehaus.jackson.impl.JsonParserBase
_getByteArrayBuilder, _handleEOF, _reportMismatchedEndMarker, getCurrentLocation, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, getTokenLocation, hasTextCharacters, isClosed, loadMoreGuaranteed, version
 
Methods inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase
_constructError, _getCharDesc, _handleUnrecognizedCharacterEscape, _reportError, _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, getLastClearedToken, getShortValue, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, hasCurrentToken, isEnabled, isExpectedStartArrayToken, isFeatureEnabled, nextValue, readValueAs, readValueAs, readValueAsTree, releaseBuffered, setFeature, setSchema
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_objectCodec

protected ObjectCodec _objectCodec
Codec used for data binding when (if) requested.


_mayContainRawBinary

protected boolean _mayContainRawBinary
Flag 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

protected final SmileBufferRecycler<String> _smileBufferRecycler
Helper object used for low-level recycling of Smile-generator specific buffers.

Since:
1.7

_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)


_typeByte

protected int _typeByte
Type byte of the current token


_got32BitFloat

protected boolean _got32BitFloat
Specific 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

protected final BytesToNameCanonicalizer _symbols
Symbol table that contains field names encountered so far


_quadBuffer

protected int[] _quadBuffer
Temporary buffer used for name parsing.


_quad1

protected int _quad1
Quads used for hash calculation


_quad2

protected int _quad2
Quads used for hash calculation


_seenNames

protected String[] _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

protected String[] _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

protected static final ThreadLocal<SoftReference<SmileBufferRecycler<String>>> _smileRecyclerRef
ThreadLocal contains a SoftRerefence to a buffer recycler used to provide a low-cost buffer recycling for Smile-specific buffers.

Constructor Detail

SmileParser

public SmileParser(IOContext ctxt,
                   int parserFeatures,
                   int smileFeatures,
                   ObjectCodec codec,
                   BytesToNameCanonicalizer sym,
                   InputStream in,
                   byte[] inputBuffer,
                   int start,
                   int end,
                   boolean bufferRecyclable)
Method Detail

getCodec

public ObjectCodec getCodec()
Description copied from class: JsonParser
Accessor for ObjectCodec associated with this parser, if any. Codec is used by JsonParser.readValueAs(Class) method (and its variants).

Specified by:
getCodec in class JsonParser

setCodec

public void setCodec(ObjectCodec c)
Description copied from class: JsonParser
Setter that allows defining ObjectCodec associated with this parser, if any. Codec is used by JsonParser.readValueAs(Class) method (and its variants).

Specified by:
setCodec in class JsonParser

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:
IOException
JsonParseException

_smileBufferRecycler

protected static final SmileBufferRecycler<String> _smileBufferRecycler()
Since:
1.7

_finishString

protected void _finishString()
                      throws IOException,
                             JsonParseException
Specified by:
_finishString in class JsonParserBase
Throws:
IOException
JsonParseException

close

public void close()
           throws IOException
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 feature JsonParser.Feature.AUTO_CLOSE_SOURCE is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so check JsonFactory for details, but the general idea is that if caller passes in closable resource (such as InputStream or Reader) parser does NOT own the source; but if it passes a reference (such as File or URL and creates stream or reader it does own them.

Specified by:
close in interface Closeable
Overrides:
close in class JsonParserBase
Throws:
IOException

_releaseBuffers

protected void _releaseBuffers()
                        throws IOException
Description copied from class: StreamBasedParserBase
Method called to release internal buffers owned by the base reader. This may be called along with StreamBasedParserBase._closeInput() (for example, when explicitly closing this reader instance), or separately (if need be).

Overrides:
_releaseBuffers in class StreamBasedParserBase
Throws:
IOException

mayContainRawBinary

public boolean mayContainRawBinary()

nextToken

public JsonToken nextToken()
                    throws IOException,
                           JsonParseException
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 class JsonParserMinimalBase
Returns:
Next token from the stream, if any found, or null to indicate end-of-input
Throws:
IOException
JsonParseException

getCurrentName

public String getCurrentName()
                      throws IOException,
                             JsonParseException
Description copied from class: JsonParserBase
Method that can be called to get the name associated with the current event.

Overrides:
getCurrentName in class JsonParserBase
Throws:
IOException
JsonParseException

getNumberType

public JsonParser.NumberType getNumberType()
                                    throws IOException,
                                           JsonParseException
Description copied from class: JsonParser
If current token is of type JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberType constants; otherwise returns null.

Overrides:
getNumberType in class JsonNumericParserBase
Throws:
IOException
JsonParseException

getText

public String getText()
               throws IOException,
                      JsonParseException
Method for accessing textual representation of the current event; if no current event (before first call to nextToken(), or after encountering end-of-input), returns null. Method can be called for any event.

Specified by:
getText in class JsonParserMinimalBase
Throws:
IOException
JsonParseException

getTextCharacters

public char[] getTextCharacters()
                         throws IOException,
                                JsonParseException
Description copied from class: JsonParser
Method similar to JsonParser.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:

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 class JsonParserMinimalBase
Throws:
IOException
JsonParseException

getTextLength

public int getTextLength()
                  throws IOException,
                         JsonParseException
Description copied from class: JsonParser
Accessor used with JsonParser.getTextCharacters(), to know length of String stored in returned buffer.

Specified by:
getTextLength in class JsonParserMinimalBase
Returns:
Number of characters within buffer returned by JsonParser.getTextCharacters() that are part of textual content of the current token.
Throws:
IOException
JsonParseException

getTextOffset

public int getTextOffset()
                  throws IOException,
                         JsonParseException
Description copied from class: JsonParser
Accessor used with JsonParser.getTextCharacters(), to know offset of the first text content character within buffer.

Specified by:
getTextOffset in class JsonParserMinimalBase
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

public byte[] getBinaryValue(Base64Variant b64variant)
                      throws IOException,
                             JsonParseException
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 via JsonParser.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 class JsonParserMinimalBase
Parameters:
b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).
Returns:
Decoded binary data
Throws:
IOException
JsonParseException

getEmbeddedObject

public Object getEmbeddedObject()
                         throws IOException,
                                JsonParseException
Description copied from class: JsonParser
Accessor that can be called if (and only if) the current token is JsonToken.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:
getEmbeddedObject in class JsonParser
Throws:
IOException
JsonParseException

_decodeBase64

protected byte[] _decodeBase64(Base64Variant b64variant)
                        throws IOException,
                               JsonParseException
Specified by:
_decodeBase64 in class JsonParserBase
Throws:
IOException
JsonParseException

_handleFieldName

protected final JsonToken _handleFieldName()
                                    throws IOException,
                                           JsonParseException
Method that handles initial token type recognition for token that has to be either FIELD_NAME or END_OBJECT.

Throws:
IOException
JsonParseException

_parseNumericValue

protected void _parseNumericValue(int expType)
                           throws IOException,
                                  JsonParseException
Description copied from class: JsonNumericParserBase
Method that will parse actual numeric value out of a syntactically valid number value. Type it will parse into depends on whether it is a floating point number, as well as its magnitude: smallest legal type (of ones available) is used for efficiency.

Overrides:
_parseNumericValue in class JsonNumericParserBase
Parameters:
expType - Numeric type that we will immediately need, if any; mostly necessary to optimize handling of floating point numbers
Throws:
IOException
JsonParseException

_finishToken

protected void _finishToken()
                     throws IOException,
                            JsonParseException
Method called to finish parsing of a token so that token contents are retriable

Throws:
IOException
JsonParseException

_finishNumberToken

protected final void _finishNumberToken(int tb)
                                 throws IOException,
                                        JsonParseException
Throws:
IOException
JsonParseException

_decodeShortAsciiValue

protected final void _decodeShortAsciiValue(int len)
                                     throws IOException,
                                            JsonParseException
Throws:
IOException
JsonParseException

_decodeShortUnicodeValue

protected final void _decodeShortUnicodeValue(int len)
                                       throws IOException,
                                              JsonParseException
Throws:
IOException
JsonParseException

_skipIncomplete

protected void _skipIncomplete()
                        throws IOException,
                               JsonParseException
Method called to skip remainders of an incomplete token, when contents themselves will not be needed any more

Throws:
IOException
JsonParseException

_skipBytes

protected void _skipBytes(int len)
                   throws IOException,
                          JsonParseException
Throws:
IOException
JsonParseException

_skip7BitBinary

protected void _skip7BitBinary()
                        throws IOException,
                               JsonParseException
Helper method for skipping length-prefixed binary data section

Throws:
IOException
JsonParseException

_reportInvalidSharedName

protected void _reportInvalidSharedName(int index)
                                 throws IOException
Throws:
IOException

_reportInvalidSharedStringValue

protected void _reportInvalidSharedStringValue(int index)
                                        throws IOException
Throws:
IOException

_reportInvalidChar

protected void _reportInvalidChar(int c)
                           throws JsonParseException
Throws:
JsonParseException

_reportInvalidInitial

protected void _reportInvalidInitial(int mask)
                              throws JsonParseException
Throws:
JsonParseException

_reportInvalidOther

protected void _reportInvalidOther(int mask)
                            throws JsonParseException
Throws:
JsonParseException

_reportInvalidOther

protected void _reportInvalidOther(int mask,
                                   int ptr)
                            throws JsonParseException
Throws:
JsonParseException