org.codehaus.jackson.impl
Class Utf8StreamParser

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.impl.Utf8StreamParser
All Implemented Interfaces:
Closeable, Versioned

public final class Utf8StreamParser
extends StreamBasedParserBase

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 org.codehaus.jackson.JsonParser
JsonParser.Feature, JsonParser.NumberType
 
Field Summary
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 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
Utf8StreamParser(IOContext ctxt, int features, InputStream in, ObjectCodec codec, BytesToNameCanonicalizer sym, byte[] inputBuffer, int start, int end, boolean bufferRecyclable)
           
 
Method Summary
protected  byte[] _decodeBase64(Base64Variant b64variant)
           
protected  int _decodeCharForError(int firstByte)
           
protected  char _decodeEscaped()
           
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  void _matchToken(JsonToken token)
           
protected  boolean _matchToken(String matchStr, int i)
           
protected  Name _parseApostropheFieldName()
           
protected  Name _parseFieldName(int i)
           
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.
 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)
           
 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.
protected  IllegalArgumentException reportInvalidChar(Base64Variant b64variant, int ch, int bindex)
           
protected  IllegalArgumentException reportInvalidChar(Base64Variant b64variant, int ch, int bindex, String msg)
           
 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.
 
Methods inherited from class org.codehaus.jackson.impl.StreamBasedParserBase
_closeInput, _loadToHaveAtLeast, _releaseBuffers, getInputSource, loadMore, releaseBuffered
 
Methods inherited from class org.codehaus.jackson.impl.JsonNumericParserBase
_parseNumericValue, convertNumberToBigDecimal, convertNumberToBigInteger, convertNumberToDouble, convertNumberToInt, convertNumberToLong, getBigIntegerValue, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberType, getNumberValue, reportInvalidNumber, reportOverflowInt, reportOverflowLong, reportUnexpectedNumberChar, reset, resetAsNaN, resetFloat, resetInt
 
Methods inherited from class org.codehaus.jackson.impl.JsonParserBase
_getByteArrayBuilder, _handleEOF, _reportMismatchedEndMarker, getCurrentLocation, getCurrentName, 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, getEmbeddedObject, 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; typically full ObjectMapper, but that abstract is not part of core package.


_symbols

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


_quadBuffer

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


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

Constructor Detail

Utf8StreamParser

public Utf8StreamParser(IOContext ctxt,
                        int features,
                        InputStream in,
                        ObjectCodec codec,
                        BytesToNameCanonicalizer sym,
                        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

getText

public String getText()
               throws IOException,
                      JsonParseException
Description copied from class: JsonParser
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. Method can be called for any token type.

Specified by:
getText in class JsonParserMinimalBase
Throws:
IOException
JsonParseException

_getText2

protected final String _getText2(JsonToken t)

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

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

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

parseNumberText

protected final JsonToken parseNumberText(int c)
                                   throws IOException,
                                          JsonParseException
Initial parsing method for number values. It needs to be able to parse enough input to be able to determine whether the value is to be considered a simple integer value, or a more generic decimal value: latter of which needs to be expressed as a floating point number. The basic rule is that if the number has no fractional or exponential part, it is an integer; otherwise a floating point number.

Because much of input has to be processed in any case, no partial parsing is done: all input text will be stored for further processing. However, actual numeric value conversion will be deferred, since it is usually the most complicated and costliest part of processing.

Throws:
IOException
JsonParseException

_parseFieldName

protected final Name _parseFieldName(int i)
                              throws IOException,
                                     JsonParseException
Throws:
IOException
JsonParseException

parseMediumFieldName

protected final Name parseMediumFieldName(int q2,
                                          int[] codes)
                                   throws IOException,
                                          JsonParseException
Throws:
IOException
JsonParseException

parseLongFieldName

protected Name parseLongFieldName(int q)
                           throws IOException,
                                  JsonParseException
Throws:
IOException
JsonParseException

slowParseFieldName

protected Name slowParseFieldName()
                           throws IOException,
                                  JsonParseException
Method called when not even first 8 bytes are guaranteed to come consequtively. Happens rarely, so this is offlined; plus we'll also do full checks for escaping etc.

Throws:
IOException
JsonParseException

parseEscapedFieldName

protected Name parseEscapedFieldName(int[] quads,
                                     int qlen,
                                     int currQuad,
                                     int ch,
                                     int currQuadBytes)
                              throws IOException,
                                     JsonParseException
Slower parsing method which is generally branched to when an escape sequence is detected (or alternatively for long names, or ones crossing input buffer boundary). In any case, needs to be able to handle more exceptional cases, gets slower, and hance is offlined to a separate method.

Throws:
IOException
JsonParseException

_handleUnusualFieldName

protected final Name _handleUnusualFieldName(int ch)
                                      throws IOException,
                                             JsonParseException
Method called when we see non-white space character other than double quote, when expecting a field name. In standard mode will just throw an expection; but in non-standard modes may be able to parse name.

Throws:
IOException
JsonParseException

_parseApostropheFieldName

protected final Name _parseApostropheFieldName()
                                        throws IOException,
                                               JsonParseException
Throws:
IOException
JsonParseException

_finishString

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

_skipString

protected void _skipString()
                    throws IOException,
                           JsonParseException
Method called to skim through rest of unparsed String value, if it is not needed. This can be done bit faster if contents need not be stored for future access.

Throws:
IOException
JsonParseException

_handleUnexpectedValue

protected JsonToken _handleUnexpectedValue(int c)
                                    throws IOException,
                                           JsonParseException
Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content.

Throws:
IOException
JsonParseException
Since:
1.3

_handleApostropheValue

protected JsonToken _handleApostropheValue()
                                    throws IOException,
                                           JsonParseException
Throws:
IOException
JsonParseException

_handleInvalidNumberStart

protected JsonToken _handleInvalidNumberStart(int ch,
                                              boolean negative)
                                       throws IOException,
                                              JsonParseException
Method called if expected numeric value (due to leading sign) does not look like a number

Throws:
IOException
JsonParseException

_matchToken

protected void _matchToken(JsonToken token)
                    throws IOException,
                           JsonParseException
Throws:
IOException
JsonParseException

_matchToken

protected final boolean _matchToken(String matchStr,
                                    int i)
                             throws IOException,
                                    JsonParseException
Throws:
IOException
JsonParseException

_reportInvalidToken

protected void _reportInvalidToken(String matchedPart,
                                   String msg)
                            throws IOException,
                                   JsonParseException
Throws:
IOException
JsonParseException

_decodeEscaped

protected final char _decodeEscaped()
                             throws IOException,
                                    JsonParseException
Throws:
IOException
JsonParseException

_decodeCharForError

protected int _decodeCharForError(int firstByte)
                           throws IOException,
                                  JsonParseException
Throws:
IOException
JsonParseException

_skipCR

protected final void _skipCR()
                      throws IOException
We actually need to check the character value here (to see if we have \n following \r).

Throws:
IOException

_skipLF

protected final void _skipLF()
                      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

growArrayBy

public static int[] growArrayBy(int[] arr,
                                int more)

_decodeBase64

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

reportInvalidChar

protected IllegalArgumentException reportInvalidChar(Base64Variant b64variant,
                                                     int ch,
                                                     int bindex)
                                              throws IllegalArgumentException
Throws:
IllegalArgumentException

reportInvalidChar

protected IllegalArgumentException reportInvalidChar(Base64Variant b64variant,
                                                     int ch,
                                                     int bindex,
                                                     String msg)
                                              throws IllegalArgumentException
Parameters:
bindex - Relative index within base64 character unit; between 0 and 3 (as unit has exactly 4 characters)
Throws:
IllegalArgumentException