|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.fasterxml.jackson.core.JsonParser com.fasterxml.jackson.core.base.ParserMinimalBase com.fasterxml.jackson.core.base.ParserBase com.fasterxml.jackson.core.json.UTF8StreamJsonParser
public final class UTF8StreamJsonParser
This is a concrete implementation of JsonParser
, which is
based on a InputStream
as the input source.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser |
---|
JsonParser.Feature, JsonParser.NumberType |
Field Summary | |
---|---|
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 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
|
protected ObjectCodec |
_objectCodec
Codec used for data binding when (if) requested; typically full ObjectMapper , but that abstract is not part of core
package. |
protected int[] |
_quadBuffer
Temporary buffer used for name parsing. |
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) |
Fields inherited from class com.fasterxml.jackson.core.base.ParserBase |
---|
_binaryValue, _byteArrayBuilder, _closed, _currInputProcessed, _currInputRow, _currInputRowStart, _expLength, _fractLength, _inputEnd, _inputPtr, _intLength, _ioContext, _nameCopied, _nameCopyBuffer, _nextToken, _numberBigDecimal, _numberBigInt, _numberDouble, _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 com.fasterxml.jackson.core.base.ParserMinimalBase |
---|
_currToken, _lastClearedToken, 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 com.fasterxml.jackson.core.JsonParser |
---|
_features |
Constructor Summary | |
---|---|
UTF8StreamJsonParser(IOContext ctxt,
int features,
InputStream in,
ObjectCodec codec,
BytesToNameCanonicalizer sym,
byte[] inputBuffer,
int start,
int end,
boolean bufferRecyclable)
|
Method Summary | |
---|---|
protected void |
_closeInput()
|
protected byte[] |
_decodeBase64(Base64Variant b64variant)
Efficient handling for incremental parsing of base64-encoded textual content. |
protected int |
_decodeCharForError(int firstByte)
|
protected char |
_decodeEscaped()
Method that sub-classes must implement to support escaped sequences in base64-encoded sections. |
protected void |
_finishString()
|
protected String |
_getText2(JsonToken t)
|
protected JsonToken |
_handleApostropheValue()
|
protected JsonToken |
_handleInvalidNumberStart(int ch,
boolean negative)
Method called if expected numeric value (due to leading sign) does not look like a number |
protected JsonToken |
_handleUnexpectedValue(int c)
Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content. |
protected Name |
_handleUnusualFieldName(int ch)
Method called when we see non-white space character other than double quote, when expecting a field name. |
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 |
_matchToken(String matchStr,
int i)
|
protected Name |
_parseApostropheFieldName()
|
protected Name |
_parseFieldName(int i)
|
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 |
_reportInvalidToken(String matchedPart,
String msg)
|
protected void |
_skipCR()
We actually need to check the character value here (to see if we have \n following \r). |
protected void |
_skipLF()
|
protected void |
_skipString()
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 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. |
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. |
String |
getText()
Method for accessing textual representation of the current token; if no current token (before first call to JsonParser.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. |
static int[] |
growArrayBy(int[] arr,
int more)
|
protected boolean |
loadMore()
|
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. |
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 Name |
parseMediumFieldName(int q2,
int[] codes)
|
protected JsonToken |
parseNumberText(int c)
Initial parsing method for number values. |
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. |
protected Name |
slowParseFieldName()
Method called when not even first 8 bytes are guaranteed to come consequtively. |
Version |
version()
Accessor for getting version of the core package, given a parser instance. |
Methods inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase |
---|
_constructError, _decodeBase64, _getCharDesc, _handleUnrecognizedCharacterEscape, _reportBase64EOF, _reportError, _reportInvalidBase64, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportUnexpectedChar, _throwInternal, _throwInvalidSpace, _throwUnquotedSpace, _wrapError, clearCurrentToken, getCurrentToken, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, hasCurrentToken, nextValue, skipChildren |
Methods inherited from class com.fasterxml.jackson.core.JsonParser |
---|
_constructError, canUseSchema, configure, disable, enable, getBinaryValue, getBooleanValue, getByteValue, getShortValue, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, isEnabled, isExpectedStartArrayToken, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, setSchema |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected ObjectCodec _objectCodec
ObjectMapper
, but that abstract is not part of core
package.
protected final BytesToNameCanonicalizer _symbols
protected int[] _quadBuffer
protected boolean _tokenIncomplete
protected InputStream _inputStream
protected byte[] _inputBuffer
protected boolean _bufferRecyclable
If it is not, it also means that parser can NOT modify underlying buffer.
Constructor Detail |
---|
public UTF8StreamJsonParser(IOContext ctxt, int features, InputStream in, ObjectCodec codec, BytesToNameCanonicalizer sym, byte[] inputBuffer, int start, int end, boolean bufferRecyclable)
Method Detail |
---|
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
public Version version()
JsonParser
version
in interface Versioned
version
in class ParserMinimalBase
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
protected final boolean loadMore() throws IOException
loadMore
in class ParserBase
IOException
protected final boolean _loadToHaveAtLeast(int minAvailable) throws IOException
IOException
protected void _closeInput() throws IOException
_closeInput
in class ParserBase
IOException
protected void _releaseBuffers() throws IOException
_closeInput()
(for
example, when explicitly closing this reader instance), or
separately (if need be).
_releaseBuffers
in class ParserBase
IOException
public String getText() throws IOException, JsonParseException
JsonParser
JsonParser.nextToken()
, or
after encountering end-of-input), returns null.
Method can be called for any token type.
getText
in class ParserMinimalBase
IOException
JsonParseException
protected final String _getText2(JsonToken t)
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 ParserMinimalBase
IOException
JsonParseException
public int getTextLength() throws IOException, JsonParseException
JsonParser
JsonParser.getTextCharacters()
, to know length
of String stored in returned buffer.
getTextLength
in class ParserMinimalBase
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 ParserMinimalBase
JsonParser.getTextCharacters()
that is part of
textual content of the current token.
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
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 ParserMinimalBase
b64variant
- Expected variant of base64 encoded
content (see Base64Variants
for definitions
of "standard" variants).
IOException
JsonParseException
public JsonToken nextToken() throws IOException, JsonParseException
JsonParser
nextToken
in class ParserMinimalBase
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 class ParserBase
IOException
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)
- Throws:
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
protected final JsonToken parseNumberText(int c) throws IOException, JsonParseException
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.
IOException
JsonParseException
protected final Name _parseFieldName(int i) throws IOException, JsonParseException
IOException
JsonParseException
protected final Name parseMediumFieldName(int q2, int[] codes) throws IOException, JsonParseException
IOException
JsonParseException
protected Name parseLongFieldName(int q) throws IOException, JsonParseException
IOException
JsonParseException
protected Name slowParseFieldName() throws IOException, JsonParseException
IOException
JsonParseException
protected Name parseEscapedFieldName(int[] quads, int qlen, int currQuad, int ch, int currQuadBytes) throws IOException, JsonParseException
IOException
JsonParseException
protected final Name _handleUnusualFieldName(int ch) throws IOException, JsonParseException
IOException
JsonParseException
protected final Name _parseApostropheFieldName() throws IOException, JsonParseException
IOException
JsonParseException
protected void _finishString() throws IOException, JsonParseException
_finishString
in class ParserBase
IOException
JsonParseException
protected void _skipString() throws IOException, JsonParseException
IOException
JsonParseException
protected JsonToken _handleUnexpectedValue(int c) throws IOException, JsonParseException
IOException
JsonParseException
protected JsonToken _handleApostropheValue() throws IOException, JsonParseException
IOException
JsonParseException
protected JsonToken _handleInvalidNumberStart(int ch, boolean negative) throws IOException, JsonParseException
IOException
JsonParseException
protected final void _matchToken(String matchStr, int i) throws IOException, JsonParseException
IOException
JsonParseException
protected void _reportInvalidToken(String matchedPart, String msg) throws IOException, JsonParseException
IOException
JsonParseException
protected final char _decodeEscaped() throws IOException, JsonParseException
ParserBase
_decodeEscaped
in class ParserBase
IOException
JsonParseException
protected int _decodeCharForError(int firstByte) throws IOException, JsonParseException
IOException
JsonParseException
protected final void _skipCR() throws IOException
IOException
protected final void _skipLF() 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
public static int[] growArrayBy(int[] arr, int more)
protected byte[] _decodeBase64(Base64Variant b64variant) throws IOException, JsonParseException
IOException
JsonParseException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |