org.codehaus.jackson.impl
Class JsonParserBase

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

public abstract class JsonParserBase
extends JsonParserMinimalBase

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 JsonParserMinimalBase.getBinaryValue(org.codehaus.jackson.Base64Variant) will not need to decode data more than once.
protected  ByteArrayBuilder _byteArrayBuilder
          ByteArrayBuilder is needed if 'getBinaryValue' is called.
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 JsonParserMinimalBase.getTextCharacters() method (instead of String returning alternatives)
protected  JsonToken _nextToken
          Secondary token related to the next token after current one; used if its type is 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  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.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
protected JsonParserBase(IOContext ctxt, int features)
           
 
Method Summary
protected abstract  void _closeInput()
           
protected abstract  byte[] _decodeBase64(Base64Variant b64variant)
           
protected abstract  void _finishString()
           
 ByteArrayBuilder _getByteArrayBuilder()
           
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 _reportMismatchedEndMarker(int actCh, char expCh)
           
 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.
 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.
 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 hasTextCharacters()
          Method that can be used to determine whether calling of JsonParser.getTextCharacters() would be the most efficient way to access textual content for the event parser currently points to.
 boolean isClosed()
          Method that can be called to determine whether this parser is closed or not.
protected abstract  boolean loadMore()
           
protected  void loadMoreGuaranteed()
           
 Version version()
          Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).
 
Methods inherited from class org.codehaus.jackson.impl.JsonParserMinimalBase
_constructError, _getCharDesc, _handleUnrecognizedCharacterEscape, _reportError, _reportInvalidEOF, _reportInvalidEOF, _reportUnexpectedChar, _throwInternal, _throwInvalidSpace, _throwUnquotedSpace, _wrapError, getBinaryValue, getText, getTextCharacters, getTextLength, getTextOffset, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, nextToken, skipChildren
 
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, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, hasCurrentToken, isEnabled, isExpectedStartArrayToken, isFeatureEnabled, nextValue, readValueAs, readValueAs, readValueAsTree, releaseBuffered, releaseBuffered, 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 next token after current one; used if its type is known. This may be value token that follows FIELD_NAME, for example.


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


_byteArrayBuilder

protected ByteArrayBuilder _byteArrayBuilder
ByteArrayBuilder is needed if 'getBinaryValue' is called. If so, we better reuse it for remainder of content.


_binaryValue

protected byte[] _binaryValue
We will hold on to decoded binary data, for duration of current event, so that multiple calls to JsonParserMinimalBase.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

version

public Version version()
Description copied from interface: Versioned
Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).

Specified by:
version in interface Versioned
Overrides:
version in class JsonParser

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 JsonParserMinimalBase
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 JsonParserMinimalBase
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 JsonParserMinimalBase

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 JsonParserMinimalBase

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

hasTextCharacters

public boolean hasTextCharacters()
Description copied from class: JsonParser
Method that can be used to determine whether calling of JsonParser.getTextCharacters() would be the most efficient way to access textual content for the event parser currently points to.

Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.

Specified by:
hasTextCharacters in class JsonParserMinimalBase
Returns:
True if parser currently has character array that can be efficiently returned via JsonParser.getTextCharacters(); false means that it may or may not exist

getTokenCharacterOffset

public final long getTokenCharacterOffset()

getTokenLineNr

public final int getTokenLineNr()

getTokenColumnNr

public final int getTokenColumnNr()

loadMoreGuaranteed

protected final void loadMoreGuaranteed()
                                 throws IOException
Throws:
IOException

loadMore

protected abstract boolean loadMore()
                             throws IOException
Throws:
IOException

_finishString

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

_closeInput

protected abstract void _closeInput()
                             throws IOException
Throws:
IOException

_decodeBase64

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

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

Specified by:
_handleEOF in class JsonParserMinimalBase
Throws:
JsonParseException

_reportMismatchedEndMarker

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

_getByteArrayBuilder

public ByteArrayBuilder _getByteArrayBuilder()