public class SmileParser extends JsonParserBase
Modifier and Type | Class and Description |
---|---|
static class |
SmileParser.Feature
Enumeration that defines all togglable features for Smile generators.
|
JsonParser.NumberType
Modifier and Type | Field and Description |
---|---|
protected boolean |
_bufferRecyclable
Flag that indicates whether the input buffer is recycable (and
needs to be returned to recycler once we are done) or not.
|
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 byte[] |
_inputBuffer
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 |
_inputStream
Input stream that can be used for reading more content, if one
in use.
|
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 SoftReference
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
|
_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
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
_currToken, _features, _lastClearedToken
Constructor and Description |
---|
SmileParser(IOContext ctxt,
int parserFeatures,
int smileFeatures,
ObjectCodec codec,
BytesToNameCanonicalizer sym,
InputStream in,
byte[] inputBuffer,
int start,
int end,
boolean bufferRecyclable) |
Modifier and Type | Method and Description |
---|---|
protected void |
_closeInput() |
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 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 necessary
|
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. |
JsonLocation |
getCurrentLocation()
Overridden since we do not really have character-based locations,
but we do have byte offset to specify.
|
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 . |
Object |
getInputSource()
Method that can be used to get access to object that is used
to access input being parsed; this is usually either
InputStream or Reader , depending on what
parser was constructed with. |
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. |
JsonLocation |
getTokenLocation()
Overridden since we do not really have character-based locations,
but we do have byte offset to specify.
|
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 |
hasTextCharacters()
Method that can be used to determine whether calling of
JsonParser.getTextCharacters() would be the most efficient
way to access textual content for the event parser currently
points to. |
protected boolean |
loadMore() |
boolean |
mayContainRawBinary() |
Boolean |
nextBooleanValue()
Method that fetches next token (as if calling
JsonParser.nextToken() ) and
if it is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null. |
boolean |
nextFieldName(SerializableString str)
Method that fetches next token (as if calling
JsonParser.nextToken() ) and
verifies whether it is JsonToken.FIELD_NAME with specified name
and returns result of that comparison. |
int |
nextIntValue(int defaultValue)
Method that fetches next token (as if calling
JsonParser.nextToken() ) and
if it is JsonToken.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 calling
JsonParser.nextToken() ) and
if it is JsonToken.VALUE_NUMBER_INT returns 64-bit long value;
otherwise returns specified default value
It is functionally equivalent to: |
String |
nextTextValue()
Method that fetches next token (as if calling
JsonParser.nextToken() ) and
if it is JsonToken.VALUE_STRING returns contained String value;
otherwise returns null. |
JsonToken |
nextToken()
Main iteration method, which will advance stream enough
to determine type of the next token, if any.
|
int |
releaseBuffered(OutputStream out)
Method that can be called to push back any content that
has been read but not consumed by the parser.
|
void |
setCodec(ObjectCodec c)
Setter that allows defining
ObjectCodec associated with this
parser, if any. |
_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, version
_constructError, _decodeBase64, _getCharDesc, _handleUnrecognizedCharacterEscape, _reportBase64EOF, _reportError, _reportInvalidBase64, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportUnexpectedChar, _throwInternal, _throwInvalidSpace, _throwUnquotedSpace, _wrapError, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, skipChildren
_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
protected ObjectCodec _objectCodec
protected boolean _mayContainRawBinary
protected final SmileBufferRecycler<String> _smileBufferRecycler
protected InputStream _inputStream
protected byte[] _inputBuffer
protected boolean _bufferRecyclable
If it is not, it also means that parser can NOT modify underlying buffer.
protected boolean _tokenIncomplete
protected int _typeByte
protected boolean _got32BitFloat
protected final BytesToNameCanonicalizer _symbols
protected int[] _quadBuffer
protected int _quad1
protected int _quad2
protected String[] _seenNames
protected int _seenNameCount
protected String[] _seenStringValues
protected int _seenStringValueCount
protected static final ThreadLocal<SoftReference<SmileBufferRecycler<String>>> _smileRecyclerRef
ThreadLocal
contains a SoftReference
to a buffer recycler used to provide a low-cost
buffer recycling for Smile-specific buffers.public SmileParser(IOContext ctxt, int parserFeatures, int smileFeatures, ObjectCodec codec, BytesToNameCanonicalizer sym, InputStream in, byte[] inputBuffer, int start, int end, boolean bufferRecyclable)
public ObjectCodec getCodec()
JsonParser
ObjectCodec
associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).getCodec
in class JsonParser
public void setCodec(ObjectCodec c)
JsonParser
ObjectCodec
associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).setCodec
in class JsonParser
protected boolean handleSignature(boolean consumeFirstByte, boolean throwException) throws IOException, JsonParseException
IOException
JsonParseException
protected static final SmileBufferRecycler<String> _smileBufferRecycler()
public int releaseBuffered(OutputStream out) throws IOException
JsonParser
releaseBuffered
in class JsonParser
OutputStream
;
otherwise number of bytes released (0 if there was nothing to release)IOException
- if write to stream threw exceptionpublic Object getInputSource()
JsonParser
InputStream
or Reader
, 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.
getInputSource
in class JsonParser
public JsonLocation getTokenLocation()
getTokenLocation
in class JsonParserBase
public JsonLocation getCurrentLocation()
getCurrentLocation
in class JsonParserBase
protected final boolean loadMore() throws IOException
loadMore
in class JsonParserBase
IOException
protected final boolean _loadToHaveAtLeast(int minAvailable) throws IOException
IOException
protected void _closeInput() throws IOException
_closeInput
in class JsonParserBase
IOException
protected void _finishString() throws IOException, JsonParseException
_finishString
in class JsonParserBase
IOException
JsonParseException
public void close() throws IOException
JsonParser
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.close
in interface Closeable
close
in interface AutoCloseable
close
in class JsonParserBase
IOException
public boolean hasTextCharacters()
JsonParser
JsonParser.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.
hasTextCharacters
in class JsonParserBase
JsonParser.getTextCharacters()
; false
means that it may or may not existprotected void _releaseBuffers() throws IOException
_closeInput()
(for
example, when explicitly closing this reader instance), or
separately (if need be)._releaseBuffers
in class JsonParserBase
IOException
public boolean mayContainRawBinary()
public JsonToken nextToken() throws IOException, JsonParseException
JsonParser
nextToken
in class JsonParserMinimalBase
IOException
JsonParseException
public String getCurrentName() throws IOException, JsonParseException
JsonParserBase
getCurrentName
in class JsonParserBase
IOException
JsonParseException
public JsonParser.NumberType getNumberType() throws IOException, JsonParseException
JsonParser
JsonToken.VALUE_NUMBER_INT
or
JsonToken.VALUE_NUMBER_FLOAT
, returns
one of JsonParser.NumberType
constants; otherwise returns null.getNumberType
in class JsonParserBase
IOException
JsonParseException
public boolean nextFieldName(SerializableString str) throws IOException, JsonParseException
JsonParser
JsonParser.nextToken()
) and
verifies whether it is JsonToken.FIELD_NAME
with specified name
and returns result of that comparison.
It is functionally equivalent to:
return (nextToken() == JsonToken.FIELD_NAME) && 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.
nextFieldName
in class JsonParser
str
- Property name to compare next token to (if next token is JsonToken.FIELD_NAME)
IOException
JsonParseException
public String nextTextValue() throws IOException, JsonParseException
JsonParser
JsonParser.nextToken()
) and
if it is JsonToken.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.
nextTextValue
in class JsonParser
IOException
JsonParseException
public int nextIntValue(int defaultValue) throws IOException, JsonParseException
JsonParser
JsonParser.nextToken()
) and
if it is JsonToken.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.
nextIntValue
in class JsonParser
IOException
JsonParseException
public long nextLongValue(long defaultValue) throws IOException, JsonParseException
JsonParser
JsonParser.nextToken()
) and
if it is JsonToken.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.
nextLongValue
in class JsonParser
IOException
JsonParseException
public Boolean nextBooleanValue() throws IOException, JsonParseException
JsonParser
JsonParser.nextToken()
) and
if it is JsonToken.VALUE_TRUE
or JsonToken.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.
nextBooleanValue
in class JsonParser
IOException
JsonParseException
public String getText() throws IOException, JsonParseException
nextToken()
, or
after encountering end-of-input), returns null.
Method can be called for any event.getText
in class JsonParserMinimalBase
IOException
JsonParseException
public char[] getTextCharacters() throws IOException, JsonParseException
JsonParser
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:
JsonParser.getTextOffset()
) to
know the actual offset
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).
getTextCharacters
in class JsonParserMinimalBase
IOException
JsonParseException
public int getTextLength() throws IOException, JsonParseException
JsonParser
JsonParser.getTextCharacters()
, to know length
of String stored in returned buffer.getTextLength
in class JsonParserMinimalBase
JsonParser.getTextCharacters()
that are part of
textual content of the current token.IOException
JsonParseException
public int getTextOffset() throws IOException, JsonParseException
JsonParser
JsonParser.getTextCharacters()
, to know offset
of the first text content character within buffer.getTextOffset
in class JsonParserMinimalBase
JsonParser.getTextCharacters()
that is part of
textual content of the current token.IOException
JsonParseException
public byte[] getBinaryValue(Base64Variant b64variant) throws IOException, JsonParseException
JsonParser
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.
getBinaryValue
in class JsonParserMinimalBase
b64variant
- Expected variant of base64 encoded
content (see Base64Variants
for definitions
of "standard" variants).IOException
JsonParseException
public Object getEmbeddedObject() throws IOException, JsonParseException
JsonParser
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).
getEmbeddedObject
in class JsonParser
IOException
JsonParseException
protected byte[] _decodeBase64(Base64Variant b64variant) throws IOException, JsonParseException
IOException
JsonParseException
protected final JsonToken _handleFieldName() throws IOException, JsonParseException
IOException
JsonParseException
protected void _parseNumericValue(int expType) throws IOException, JsonParseException
JsonParserBase
_parseNumericValue
in class JsonParserBase
expType
- Numeric type that we will immediately need, if any;
mostly necessary to optimize handling of floating point numbersIOException
JsonParseException
protected void _finishToken() throws IOException, JsonParseException
IOException
JsonParseException
protected final void _finishNumberToken(int tb) throws IOException, JsonParseException
IOException
JsonParseException
protected final void _decodeShortAsciiValue(int len) throws IOException, JsonParseException
IOException
JsonParseException
protected final void _decodeShortUnicodeValue(int len) throws IOException, JsonParseException
IOException
JsonParseException
protected void _skipIncomplete() throws IOException, JsonParseException
IOException
JsonParseException
protected void _skipBytes(int len) throws IOException, JsonParseException
IOException
JsonParseException
protected void _skip7BitBinary() throws IOException, JsonParseException
IOException
JsonParseException
protected void _reportInvalidSharedName(int index) throws IOException
IOException
protected void _reportInvalidSharedStringValue(int index) throws IOException
IOException
protected void _reportInvalidChar(int c) throws JsonParseException
JsonParseException
protected void _reportInvalidInitial(int mask) throws JsonParseException
JsonParseException
protected void _reportInvalidOther(int mask) throws JsonParseException
JsonParseException
protected void _reportInvalidOther(int mask, int ptr) throws JsonParseException
JsonParseException