org.codehaus.jackson.impl
Class JsonParserBase

java.lang.Object
  extended by org.codehaus.jackson.JsonParser
      extended by org.codehaus.jackson.impl.JsonParserBase
All Implemented Interfaces:
Closeable
Direct Known Subclasses:
JsonNumericParserBase

public abstract class JsonParserBase
extends JsonParser

Intermediate base class used by all Jackson JsonParser implementations. Contains most common things that are independent of actual underlying input source

Author:
Tatu Saloranta

Nested Class Summary
 
Nested classes/interfaces inherited from class org.codehaus.jackson.JsonParser
JsonParser.Feature, JsonParser.NumberType
 
Field Summary
protected  byte[] _binaryValue
          We will hold on to decoded binary data, for duration of current event, so that multiple calls to getBinaryValue(org.codehaus.jackson.Base64Variant) will not need to decode data more than once.
protected  boolean _closed
          Flag that indicates whether parser is closed or not.
protected  long _currInputProcessed
          Number of characters that were contained in previous blocks (blocks that were already processed prior to the current buffer).
protected  int _currInputRow
          Current row location of current point in input buffer, starting from 1
protected  int _currInputRowStart
          Current index of the first character of the current row in input buffer.
protected  int _inputEnd
          Index of character after last available one in the buffer.
protected  int _inputPtr
          Pointer to next available character in buffer
protected  IOContext _ioContext
          I/O context for this reader.
protected  boolean _nameCopied
          Flag set to indicate whether the field name is available from the name copy buffer or not (in addition to its String representation being available via read context)
protected  char[] _nameCopyBuffer
          Temporary buffer that is needed if field name is accessed using getTextCharacters() method (instead of String returning alternatives)
protected  JsonToken _nextToken
          Secondary token related to the current token: used when the current token is FIELD_NAME but the actual value token is also known.
protected  JsonReadContext _parsingContext
          Information about parser context, context in which the next token is to be parsed (root, array, object).
protected  TextBuffer _textBuffer
          Buffer that contains contents of String values, including field names if necessary (name split across boundary, contains escape sequence, or access needed to char array)
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 _tokenInputCol
          Column on input row that current token starts; 0-based (although in the end it'll be converted to 1-based)
protected  int _tokenInputRow
          Input row on which current token starts, 1-based
protected  long _tokenInputTotal
          Total number of characters read before start of current token.
 
Fields inherited from class org.codehaus.jackson.JsonParser
_currToken, _features, _lastClearedToken
 
Constructor Summary
protected JsonParserBase(IOContext ctxt, int features)
           
 
Method Summary
protected abstract  void _closeInput()
           
protected  JsonParseException _constructError(String msg, Throwable t)
           
protected abstract  byte[] _decodeBase64(Base64Variant b64variant)
           
protected abstract  void _finishString()
           
 ByteArrayBuilder _getByteArrayBuilder()
           
protected static String _getCharDesc(int ch)
           
protected  void _handleEOF()
          Method called when an EOF is encountered between tokens.
protected  void _releaseBuffers()
          Method called to release internal buffers owned by the base reader.
protected  void _reportError(String msg)
           
protected  void _reportInvalidEOF()
           
protected  void _reportInvalidEOF(String msg)
           
protected  void _reportMismatchedEndMarker(int actCh, char expCh)
           
protected  void _reportUnexpectedChar(int ch, String comment)
           
protected  void _throwInternal()
           
protected  void _throwInvalidSpace(int i)
           
protected  void _throwUnquotedSpace(int i, String ctxtDesc)
          Method called to report a problem with unquoted control character.
protected  void _wrapError(String msg, Throwable t)
           
 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.
 JsonLocation getCurrentLocation()
          Method that returns location of the last processed character; usually for error reporting purposes
 String getCurrentName()
          Method that can be called to get the name associated with the current event.
 JsonReadContext getParsingContext()
          Method that can be used to access current parsing context reader is in.
 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.
 long getTokenCharacterOffset()
           
 int getTokenColumnNr()
           
 int getTokenLineNr()
           
 JsonLocation getTokenLocation()
          Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.
 boolean isClosed()
          Method that can be called to determine whether this parser is closed or not.
protected abstract  boolean loadMore()
           
protected  void loadMoreGuaranteed()
           
abstract  JsonToken nextToken()
          Main iteration method, which will advance stream enough to determine type of the next token, if any.
 JsonParser skipChildren()
          Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to JsonToken.START_OBJECT or JsonToken.START_ARRAY.
 
Methods inherited from class org.codehaus.jackson.JsonParser
_constructError, clearCurrentToken, configure, disable, disableFeature, enable, enableFeature, getBigIntegerValue, getBinaryValue, getBooleanValue, getByteValue, getCodec, getCurrentToken, getDecimalValue, getDoubleValue, getEmbeddedObject, getFloatValue, getIntValue, getLastClearedToken, getLongValue, getNumberType, getNumberValue, getShortValue, hasCurrentToken, isEnabled, isFeatureEnabled, nextValue, readValueAs, readValueAs, readValueAsTree, setCodec, setFeature
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_ioContext

protected final IOContext _ioContext
I/O context for this reader. It handles buffer allocation for the reader.


_closed

protected boolean _closed
Flag that indicates whether parser is closed or not. Gets set when parser is either closed by explicit call (close()) or when end-of-input is reached.


_inputPtr

protected int _inputPtr
Pointer to next available character in buffer


_inputEnd

protected int _inputEnd
Index of character after last available one in the buffer.


_currInputProcessed

protected long _currInputProcessed
Number of characters that were contained in previous blocks (blocks that were already processed prior to the current buffer).


_currInputRow

protected int _currInputRow
Current row location of current point in input buffer, starting from 1


_currInputRowStart

protected int _currInputRowStart
Current index of the first character of the current row in input buffer. Needed to calculate column position, if necessary; benefit of not having column itself is that this only has to be updated once per line.


_tokenInputTotal

protected long _tokenInputTotal
Total number of characters read before start of current token. For big (gigabyte-sized) sizes are possible, needs to be long, unlike pointers and sizes related to in-memory buffers.


_tokenInputRow

protected int _tokenInputRow
Input row on which current token starts, 1-based


_tokenInputCol

protected int _tokenInputCol
Column on input row that current token starts; 0-based (although in the end it'll be converted to 1-based)


_parsingContext

protected JsonReadContext _parsingContext
Information about parser context, context in which the next token is to be parsed (root, array, object).


_nextToken

protected JsonToken _nextToken
Secondary token related to the current token: used when the current token is FIELD_NAME but the actual value token is also known.


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


_textBuffer

protected final TextBuffer _textBuffer
Buffer that contains contents of String values, including field names if necessary (name split across boundary, contains escape sequence, or access needed to char array)


_nameCopyBuffer

protected char[] _nameCopyBuffer
Temporary buffer that is needed if field name is accessed using getTextCharacters() method (instead of String returning alternatives)


_nameCopied

protected boolean _nameCopied
Flag set to indicate whether the field name is available from the name copy buffer or not (in addition to its String representation being available via read context)


_binaryValue

protected byte[] _binaryValue
We will hold on to decoded binary data, for duration of current event, so that multiple calls to getBinaryValue(org.codehaus.jackson.Base64Variant) will not need to decode data more than once.

Constructor Detail

JsonParserBase

protected JsonParserBase(IOContext ctxt,
                         int features)
Method Detail

_finishString

protected abstract void _finishString()
                               throws IOException,
                                      JsonParseException
Throws:
IOException
JsonParseException

nextToken

public abstract 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 JsonParser
Returns:
Next token from the stream, if any found, or null to indicate end-of-input
Throws:
IOException
JsonParseException

skipChildren

public JsonParser skipChildren()
                        throws IOException,
                               JsonParseException
Description copied from class: JsonParser
Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to JsonToken.START_OBJECT or JsonToken.START_ARRAY. If not, it will do nothing. After skipping, stream will point to matching JsonToken.END_OBJECT or JsonToken.END_ARRAY (possibly skipping nested pairs of START/END OBJECT/ARRAY tokens as well as value tokens). The idea is that after calling this method, application will call JsonParser.nextToken() to point to the next available token, if any.

Specified by:
skipChildren in class JsonParser
Throws:
IOException
JsonParseException

getCurrentName

public String getCurrentName()
                      throws IOException,
                             JsonParseException
Method that can be called to get the name associated with the current event.

Specified by:
getCurrentName 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 Closeable
Specified by:
close in class JsonParser
Throws:
IOException

isClosed

public boolean isClosed()
Description copied from class: JsonParser
Method that can be called to determine whether this parser is closed or not. If it is closed, no new tokens can be retrieved by calling JsonParser.nextToken() (and the underlying stream may be closed). Closing may be due to an explicit call to JsonParser.close() or because parser has encountered end of input.

Specified by:
isClosed in class JsonParser

getParsingContext

public JsonReadContext getParsingContext()
Description copied from class: JsonParser
Method that can be used to access current parsing context reader is in. There are 3 different types: root, array and object contexts, with slightly different available information. Contexts are hierarchically nested, and can be used for example for figuring out part of the input document that correspond to specific array or object (for highlighting purposes, or error reporting). Contexts can also be used for simple xpath-like matching of input, if so desired.

Specified by:
getParsingContext in class JsonParser

getTokenLocation

public JsonLocation getTokenLocation()
Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.

Specified by:
getTokenLocation in class JsonParser

getCurrentLocation

public JsonLocation getCurrentLocation()
Method that returns location of the last processed character; usually for error reporting purposes

Specified by:
getCurrentLocation in class JsonParser

getText

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

Specified by:
getText in class JsonParser
Throws:
IOException
JsonParseException

getTextCharacters

public char[] getTextCharacters()
                         throws IOException,
                                JsonParseException
Description copied from class: JsonParser
Method similar to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:

Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.

The only reason to call this method (over JsonParser.getText()) is to avoid construction of a String object (which will make a copy of contents).

Specified by:
getTextCharacters in class JsonParser
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 JsonParser
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 JsonParser
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 final 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 JsonParser
Parameters:
b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).
Returns:
Decoded binary data
Throws:
IOException
JsonParseException

_decodeBase64

protected abstract byte[] _decodeBase64(Base64Variant b64variant)
                                 throws IOException,
                                        JsonParseException
Throws:
IOException
JsonParseException

getTokenCharacterOffset

public final long getTokenCharacterOffset()

getTokenLineNr

public final int getTokenLineNr()

getTokenColumnNr

public final int getTokenColumnNr()

loadMore

protected abstract boolean loadMore()
                             throws IOException
Throws:
IOException

loadMoreGuaranteed

protected final void loadMoreGuaranteed()
                                 throws IOException
Throws:
IOException

_closeInput

protected abstract void _closeInput()
                             throws IOException
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).

Throws:
IOException

_handleEOF

protected void _handleEOF()
                   throws JsonParseException
Method called when an EOF is encountered between tokens. If so, it may be a legitimate EOF, but only iff there is no open non-root context.

Throws:
JsonParseException

_reportUnexpectedChar

protected void _reportUnexpectedChar(int ch,
                                     String comment)
                              throws JsonParseException
Throws:
JsonParseException

_reportInvalidEOF

protected void _reportInvalidEOF()
                          throws JsonParseException
Throws:
JsonParseException

_reportInvalidEOF

protected void _reportInvalidEOF(String msg)
                          throws JsonParseException
Throws:
JsonParseException

_throwInvalidSpace

protected void _throwInvalidSpace(int i)
                           throws JsonParseException
Throws:
JsonParseException

_throwUnquotedSpace

protected void _throwUnquotedSpace(int i,
                                   String ctxtDesc)
                            throws JsonParseException
Method called to report a problem with unquoted control character. Note: starting with version 1.4, it is possible to suppress exception by enabling Feature.ALLOW_UNQUOTED_CONTROL_CHARS.

Throws:
JsonParseException

_reportMismatchedEndMarker

protected void _reportMismatchedEndMarker(int actCh,
                                          char expCh)
                                   throws JsonParseException
Throws:
JsonParseException

_getCharDesc

protected static final String _getCharDesc(int ch)

_reportError

protected final void _reportError(String msg)
                           throws JsonParseException
Throws:
JsonParseException

_wrapError

protected final void _wrapError(String msg,
                                Throwable t)
                         throws JsonParseException
Throws:
JsonParseException

_throwInternal

protected final void _throwInternal()

_constructError

protected final JsonParseException _constructError(String msg,
                                                   Throwable t)

_getByteArrayBuilder

public ByteArrayBuilder _getByteArrayBuilder()