java.lang.Object
- org.codehaus.jackson.JsonParser
- - org.codehaus.jackson.impl.JsonParserMinimalBase
  - - org.codehaus.jackson.impl.JsonParserBase
    - - org.codehaus.jackson.impl.ReaderBasedParser

All Implemented Interfaces:

Closeable, AutoCloseable, Versioned
```
public final class ReaderBasedParser
extends JsonParserBase
```
This is a concrete implementation of JsonParser, which is based on a Reader to handle low-level character conversion tasks.

Nested Class Summary
- Nested classes/interfaces inherited from class org.codehaus.jackson.JsonParser
  JsonParser.Feature, JsonParser.NumberType

Field Summary

Fields
Modifier and Type	Field	Description
`protected char[]`	`_inputBuffer`	Current buffer from which data is read; generally data is read into buffer from input source.
`protected ObjectCodec`	`_objectCodec`
`protected Reader`	`_reader`	Reader that can be used for reading more content, if one buffer from input source, but in some cases pre-loaded buffer is handed to the parser.
`protected CharsToNameCanonicalizer`	`_symbols`
`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.JsonParserBase
_binaryValue, _byteArrayBuilder, _closed, _currInputProcessed, _currInputRow, _currInputRowStart, _expLength, _fractLength, _inputEnd, _inputPtr, _intLength, _ioContext, _nameCopied, _nameCopyBuffer, _nextToken, _numberBigDecimal, _numberBigInt, _numberDouble, _numberInt, _numberLong, _numberNegative, _numTypesValid, _parsingContext, _textBuffer, _tokenInputCol, _tokenInputRow, _tokenInputTotal, CHAR_NULL, INT_0, INT_1, INT_2, INT_3, INT_4, INT_5, INT_6, INT_7, INT_8, INT_9, INT_DECIMAL_POINT, INT_e, INT_E, INT_MINUS, INT_PLUS, NR_BIGDECIMAL, NR_BIGINT, NR_DOUBLE, NR_INT, NR_LONG, NR_UNKNOWN

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

Constructors
Constructor	Description
`ReaderBasedParser(IOContext ctxt, int features, Reader r, ObjectCodec codec, CharsToNameCanonicalizer st)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`_closeInput()`
`protected byte[]`	`_decodeBase64(Base64Variant b64variant)`	Efficient handling for incremental parsing of base64-encoded textual content.
`protected char`	`_decodeEscaped()`	Method that sub-classes must implement to support escaped sequences in base64-encoded sections.
`protected void`	`_finishString()`
`protected void`	`_finishString2()`
`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 i)`	Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content.
`protected String`	`_handleUnusualFieldName(int i)`	Method called when we see non-white space character other than double quote, when expecting a field name.
`protected void`	`_matchToken(String matchStr, int i)`	Helper method for checking whether input matches expected token
`protected String`	`_parseApostropheFieldName()`
`protected String`	`_parseFieldName(int i)`
`protected void`	`_releaseBuffers()`	Method called to release internal buffers owned by the base reader.
`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`	`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.
`protected char`	`getNextChar(String eofMsg)`
`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`	`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.
`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 JsonToken`	`parseNumberText(int ch)`	Initial parsing method for number values.
`int`	`releaseBuffered(Writer w)`	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.

Methods inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase
_constructError, _decodeBase64, _getCharDesc, _handleUnrecognizedCharacterEscape, _reportBase64EOF, _reportError, _reportInvalidBase64, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportUnexpectedChar, _throwInternal, _throwInvalidSpace, _throwUnquotedSpace, _wrapError, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, 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, nextFieldName, nextValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, setFeature, setSchema

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _reader
```
protected Reader _reader
```
    Reader that can be used for reading more content, if one buffer from input source, but in some cases pre-loaded buffer is handed to the parser.
  - _inputBuffer
```
protected char[] _inputBuffer
```
    Current buffer from which data is read; generally data is read into buffer from input source.
  - _objectCodec
```
protected ObjectCodec _objectCodec
```
  - _symbols
```
protected final CharsToNameCanonicalizer _symbols
```
  - _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
  - ReaderBasedParser
```
public ReaderBasedParser(IOContext ctxt,
                         int features,
                         Reader r,
                         ObjectCodec codec,
                         CharsToNameCanonicalizer st)
```
- 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
  - releaseBuffered
```
public int releaseBuffered(Writer w)
                    throws IOException
```
    Description copied from class: JsonParser
    
    Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given writer if possible; if underlying input is char-based it can released, if not (byte-based) it can not.
    
    Overrides:
    
    releaseBuffered in class JsonParser
    
    Returns:
    
    -1 if the underlying content source is not char-based (that is, input can not be sent to Writer; otherwise number of chars released (0 if there was nothing to release)
    
    Throws:
    
    IOException - if write using Writer threw exception
  - getInputSource
```
public Object getInputSource()
```
    Description copied from class: JsonParser
    
    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. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser and decorator object.
    In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.
    
    Overrides:
    
    getInputSource in class JsonParser
  - loadMore
```
protected final boolean loadMore()
                          throws IOException
```
    Specified by:
    
    loadMore in class JsonParserBase
    
    Throws:
    
    IOException
  - getNextChar
```
protected char getNextChar(String eofMsg)
                    throws IOException,
                           JsonParseException
```
    Throws:
    
    IOException
    
    JsonParseException
  - _closeInput
```
protected void _closeInput()
                    throws IOException
```
    Specified by:
    
    _closeInput in class JsonParserBase
    
    Throws:
    
    IOException
  - _releaseBuffers
```
protected void _releaseBuffers()
                        throws IOException
```
    Method called to release internal buffers owned by the base reader. This may be called along with _closeInput() (for example, when explicitly closing this reader instance), or separately (if need be).
    
    Overrides:
    
    _releaseBuffers in class JsonParserBase
    
    Throws:
    
    IOException
  - getText
```
public final 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
  - _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:
    
    Textual contents are not guaranteed to start at index 0 (rather, call JsonParser.getTextOffset()) to know the actual offset
    
    Length of textual contents may be less than the length of returned buffer: call JsonParser.getTextLength() for actual length of returned content.
    
    Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.
    The only reason to call this method (over JsonParser.getText()) is to avoid construction of a String object (which will make a copy of contents).
    Specified by:
    
    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
  - nextTextValue
```
public String nextTextValue()
                     throws IOException,
                            JsonParseException
```
    Description copied from class: JsonParser
    Method that fetches next token (as if calling 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.
    Overrides:
    
    nextTextValue in class JsonParser
    
    Throws:
    
    IOException
    
    JsonParseException
  - nextIntValue
```
public int nextIntValue(int defaultValue)
                 throws IOException,
                        JsonParseException
```
    Description copied from class: JsonParser
    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:
    return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getIntValue() : defaultValue;
    but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.
    Overrides:
    
    nextIntValue in class JsonParser
    
    Throws:
    
    IOException
    
    JsonParseException
  - nextLongValue
```
public long nextLongValue(long defaultValue)
                   throws IOException,
                          JsonParseException
```
    Description copied from class: JsonParser
    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:
    return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getLongValue() : defaultValue;
    but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.
    Overrides:
    
    nextLongValue in class JsonParser
    
    Throws:
    
    IOException
    
    JsonParseException
  - nextBooleanValue
```
public Boolean nextBooleanValue()
                         throws IOException,
                                JsonParseException
```
    Description copied from class: JsonParser
    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. It is functionally equivalent to:
    JsonToken t = nextToken(); if (t == JsonToken.VALUE_TRUE) return Boolean.TRUE; if (t == JsonToken.VALUE_FALSE) return Boolean.FALSE; return null;
    but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.
    Overrides:
    
    nextBooleanValue in class JsonParser
    
    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 AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Overrides:
    
    close in class JsonParserBase
    
    Throws:
    
    IOException
  - parseNumberText
```
protected final JsonToken parseNumberText(int ch)
                                   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
  - _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
  - _parseFieldName
```
protected final String _parseFieldName(int i)
                                throws IOException,
                                       JsonParseException
```
    Throws:
    
    IOException
    
    JsonParseException
  - _handleUnusualFieldName
```
protected final String _handleUnusualFieldName(int i)
                                        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
    
    Since:
    
    1.2
  - _parseApostropheFieldName
```
protected final String _parseApostropheFieldName()
                                          throws IOException,
                                                 JsonParseException
```
    Throws:
    
    IOException
    
    JsonParseException
  - _handleUnexpectedValue
```
protected final JsonToken _handleUnexpectedValue(int i)
                                          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 final JsonToken _handleApostropheValue()
                                          throws IOException,
                                                 JsonParseException
```
    Throws:
    
    IOException
    
    JsonParseException
    
    Since:
    
    1.8
  - _finishString
```
protected void _finishString()
                      throws IOException,
                             JsonParseException
```
    Specified by:
    
    _finishString in class JsonParserBase
    
    Throws:
    
    IOException
    
    JsonParseException
  - _finishString2
```
protected void _finishString2()
                       throws IOException,
                              JsonParseException
```
    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
  - _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
  - _decodeEscaped
```
protected final char _decodeEscaped()
                             throws IOException,
                                    JsonParseException
```
    Description copied from class: JsonParserBase
    
    Method that sub-classes must implement to support escaped sequences in base64-encoded sections. Sub-classes that do not need base64 support can leave this as is
    
    Overrides:
    
    _decodeEscaped in class JsonParserBase
    
    Throws:
    
    IOException
    
    JsonParseException
  - _matchToken
```
protected final void _matchToken(String matchStr,
                                 int i)
                          throws IOException,
                                 JsonParseException
```
    Helper method for checking whether input matches expected token
    
    Throws:
    
    IOException
    
    JsonParseException
    
    Since:
    
    1.8
  - _decodeBase64
```
protected byte[] _decodeBase64(Base64Variant b64variant)
                        throws IOException,
                               JsonParseException
```
    Efficient handling for incremental parsing of base64-encoded textual content.
    
    Throws:
    
    IOException
    
    JsonParseException
  - _reportInvalidToken
```
protected void _reportInvalidToken(String matchedPart,
                                   String msg)
                            throws IOException,
                                   JsonParseException
```
    Throws:
    
    IOException
    
    JsonParseException

Class ReaderBasedParser

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.jackson.JsonParser

Field Summary

Fields inherited from class org.codehaus.jackson.impl.JsonParserBase

Fields inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase

Fields inherited from class org.codehaus.jackson.JsonParser

Constructor Summary

Method Summary

Methods inherited from class org.codehaus.jackson.impl.JsonParserBase

Methods inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase

Methods inherited from class org.codehaus.jackson.JsonParser

Methods inherited from class java.lang.Object

Field Detail

_reader

_inputBuffer

_objectCodec

_symbols

_tokenIncomplete

Constructor Detail

ReaderBasedParser

Method Detail

getCodec

setCodec

releaseBuffered

getInputSource

loadMore

getNextChar

_closeInput

_releaseBuffers

getText

_getText2

getTextCharacters

getTextLength

getTextOffset

getBinaryValue

nextToken

nextTextValue

nextIntValue

nextLongValue

nextBooleanValue

close

parseNumberText

_handleInvalidNumberStart

_parseFieldName

_handleUnusualFieldName

_parseApostropheFieldName

_handleUnexpectedValue

_handleApostropheValue

_finishString

_finishString2

_skipString

_skipCR

_skipLF

_decodeEscaped

_matchToken

_decodeBase64

_reportInvalidToken