|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.JsonParser
org.codehaus.jackson.impl.JsonParserBase
public abstract class JsonParserBase
Intermediate base class used by all Jackson JsonParser
implementations. Contains most common things that are independent
of actual underlying input source
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 |
---|
protected final IOContext _ioContext
protected boolean _closed
close()
) or when end-of-input is reached.
protected int _inputPtr
protected int _inputEnd
protected long _currInputProcessed
protected int _currInputRow
protected int _currInputRowStart
protected long _tokenInputTotal
protected int _tokenInputRow
protected int _tokenInputCol
protected JsonReadContext _parsingContext
protected JsonToken _nextToken
FIELD_NAME
but the
actual value token is also known.
protected boolean _tokenIncomplete
protected final TextBuffer _textBuffer
protected char[] _nameCopyBuffer
getTextCharacters()
method (instead of String
returning alternatives)
protected boolean _nameCopied
protected byte[] _binaryValue
getBinaryValue(org.codehaus.jackson.Base64Variant)
will not need to decode data more
than once.
Constructor Detail |
---|
protected JsonParserBase(IOContext ctxt, int features)
Method Detail |
---|
protected abstract void _finishString() throws IOException, JsonParseException
IOException
JsonParseException
public abstract JsonToken nextToken() throws IOException, JsonParseException
JsonParser
nextToken
in class JsonParser
IOException
JsonParseException
public JsonParser skipChildren() throws IOException, JsonParseException
JsonParser
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.
skipChildren
in class JsonParser
IOException
JsonParseException
public String getCurrentName() throws IOException, JsonParseException
getCurrentName
in class JsonParser
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 JsonParser
IOException
public boolean isClosed()
JsonParser
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.
isClosed
in class JsonParser
public JsonReadContext getParsingContext()
JsonParser
getParsingContext
in class JsonParser
public JsonLocation getTokenLocation()
getTokenLocation
in class JsonParser
public JsonLocation getCurrentLocation()
getCurrentLocation
in class JsonParser
public String getText() throws IOException, JsonParseException
nextToken()
, or
after encountering end-of-input), returns null.
Method can be called for any event.
getText
in class JsonParser
IOException
JsonParseException
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 JsonParser
IOException
JsonParseException
public int getTextLength() throws IOException, JsonParseException
JsonParser
JsonParser.getTextCharacters()
, to know length
of String stored in returned buffer.
getTextLength
in class JsonParser
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 JsonParser
JsonParser.getTextCharacters()
that is part of
textual content of the current token.
IOException
JsonParseException
public final 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 JsonParser
b64variant
- Expected variant of base64 encoded
content (see Base64Variants
for definitions
of "standard" variants).
IOException
JsonParseException
protected abstract byte[] _decodeBase64(Base64Variant b64variant) throws IOException, JsonParseException
IOException
JsonParseException
public final long getTokenCharacterOffset()
public final int getTokenLineNr()
public final int getTokenColumnNr()
protected abstract boolean loadMore() throws IOException
IOException
protected final void loadMoreGuaranteed() throws IOException
IOException
protected abstract void _closeInput() throws IOException
IOException
protected void _releaseBuffers() throws IOException
_closeInput()
(for
example, when explicitly closing this reader instance), or
separately (if need be).
IOException
protected void _handleEOF() throws JsonParseException
JsonParseException
protected void _reportUnexpectedChar(int ch, String comment) throws JsonParseException
JsonParseException
protected void _reportInvalidEOF() throws JsonParseException
JsonParseException
protected void _reportInvalidEOF(String msg) throws JsonParseException
JsonParseException
protected void _throwInvalidSpace(int i) throws JsonParseException
JsonParseException
protected void _throwUnquotedSpace(int i, String ctxtDesc) throws JsonParseException
Feature.ALLOW_UNQUOTED_CONTROL_CHARS
.
JsonParseException
protected void _reportMismatchedEndMarker(int actCh, char expCh) throws JsonParseException
JsonParseException
protected static final String _getCharDesc(int ch)
protected final void _reportError(String msg) throws JsonParseException
JsonParseException
protected final void _wrapError(String msg, Throwable t) throws JsonParseException
JsonParseException
protected final void _throwInternal()
protected final JsonParseException _constructError(String msg, Throwable t)
public ByteArrayBuilder _getByteArrayBuilder()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |