public abstract class JsonParserMinimalBase extends JsonParser
JsonParser
implementations, but does not add any additional fields that depend
on particular method of obtaining input.
Note that 'minimal' here mostly refers to minimal number of fields (size) and functionality that is specific to certain types of parser implementations; but not necessarily to number of methods.
JsonParser.Feature, JsonParser.NumberType| Modifier and Type | Field and Description |
|---|---|
protected static int |
INT_APOSTROPHE |
protected static int |
INT_ASTERISK |
protected static int |
INT_b |
protected static int |
INT_BACKSLASH |
protected static int |
INT_COLON |
protected static int |
INT_COMMA |
protected static int |
INT_CR |
protected static int |
INT_f |
protected static int |
INT_LBRACKET |
protected static int |
INT_LCURLY |
protected static int |
INT_LF |
protected static int |
INT_n |
protected static int |
INT_QUOTE |
protected static int |
INT_r |
protected static int |
INT_RBRACKET |
protected static int |
INT_RCURLY |
protected static int |
INT_SLASH |
protected static int |
INT_SPACE |
protected static int |
INT_t |
protected static int |
INT_TAB |
protected static int |
INT_u |
_currToken, _features, _lastClearedToken| Modifier | Constructor and Description |
|---|---|
protected |
JsonParserMinimalBase() |
protected |
JsonParserMinimalBase(int features) |
| Modifier and Type | Method and Description |
|---|---|
protected JsonParseException |
_constructError(String msg,
Throwable t) |
protected void |
_decodeBase64(String str,
ByteArrayBuilder builder,
Base64Variant b64variant)
Helper method that can be used for base64 decoding in cases where
encoded content has already been read as a String.
|
protected static String |
_getCharDesc(int ch) |
protected abstract void |
_handleEOF()
Method sub-classes need to implement
|
protected char |
_handleUnrecognizedCharacterEscape(char ch) |
protected void |
_reportBase64EOF() |
protected void |
_reportError(String msg) |
protected void |
_reportInvalidBase64(Base64Variant b64variant,
char ch,
int bindex,
String msg) |
protected void |
_reportInvalidEOF() |
protected void |
_reportInvalidEOF(String msg) |
protected void |
_reportInvalidEOFInValue() |
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) |
abstract 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. |
abstract 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.
|
abstract String |
getCurrentName()
Method that can be called to get the name associated with
the current token: for
JsonToken.FIELD_NAMEs it will
be the same as what JsonParser.getText() returns;
for field values it will be preceding field name;
and for others (array values, root-level values) null. |
abstract JsonStreamContext |
getParsingContext()
Method that can be used to access current parsing context reader
is in.
|
abstract 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. |
abstract 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. |
abstract int |
getTextLength()
Accessor used with
JsonParser.getTextCharacters(), to know length
of String stored in returned buffer. |
abstract int |
getTextOffset()
Accessor used with
JsonParser.getTextCharacters(), to know offset
of the first text content character within buffer. |
boolean |
getValueAsBoolean(boolean defaultValue)
Method that will try to convert value of current token to a
boolean.
|
double |
getValueAsDouble(double defaultValue)
Method that will try to convert value of current token to a
Java double.
|
int |
getValueAsInt(int defaultValue)
Method that will try to convert value of current token to a
int.
|
long |
getValueAsLong(long defaultValue)
Method that will try to convert value of current token to a
long.
|
abstract 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. |
abstract boolean |
isClosed()
Method that can be called to determine whether this parser
is closed or not.
|
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. |
_constructError, canUseSchema, clearCurrentToken, configure, disable, disableFeature, enable, enableFeature, getBigIntegerValue, getBinaryValue, getBooleanValue, getByteValue, getCodec, getCurrentLocation, getCurrentToken, getDecimalValue, getDoubleValue, getEmbeddedObject, getFloatValue, getInputSource, getIntValue, getLastClearedToken, getLongValue, getNumberType, getNumberValue, getShortValue, getTokenLocation, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, hasCurrentToken, isEnabled, isExpectedStartArrayToken, isFeatureEnabled, nextBooleanValue, nextFieldName, nextIntValue, nextLongValue, nextTextValue, nextValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setCodec, setFeature, setSchema, versionprotected static final int INT_TAB
protected static final int INT_LF
protected static final int INT_CR
protected static final int INT_SPACE
protected static final int INT_LBRACKET
protected static final int INT_RBRACKET
protected static final int INT_LCURLY
protected static final int INT_RCURLY
protected static final int INT_QUOTE
protected static final int INT_BACKSLASH
protected static final int INT_SLASH
protected static final int INT_COLON
protected static final int INT_COMMA
protected static final int INT_ASTERISK
protected static final int INT_APOSTROPHE
protected static final int INT_b
protected static final int INT_f
protected static final int INT_n
protected static final int INT_r
protected static final int INT_t
protected static final int INT_u
protected JsonParserMinimalBase()
protected JsonParserMinimalBase(int features)
public abstract JsonToken nextToken() throws IOException, JsonParseException
JsonParsernextToken in class JsonParserIOExceptionJsonParseExceptionpublic JsonParser skipChildren() throws IOException, JsonParseException
JsonParserJsonToken.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 JsonParserIOExceptionJsonParseExceptionprotected abstract void _handleEOF()
throws JsonParseException
JsonParseExceptionpublic abstract String getCurrentName() throws IOException, JsonParseException
JsonParserJsonToken.FIELD_NAMEs it will
be the same as what JsonParser.getText() returns;
for field values it will be preceding field name;
and for others (array values, root-level values) null.getCurrentName in class JsonParserIOExceptionJsonParseExceptionpublic abstract void close()
throws IOException
JsonParserJsonParser.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 Closeableclose in interface AutoCloseableclose in class JsonParserIOExceptionpublic abstract boolean isClosed()
JsonParserJsonParser.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 JsonParserpublic abstract JsonStreamContext getParsingContext()
JsonParsergetParsingContext in class JsonParserpublic abstract String getText() throws IOException, JsonParseException
JsonParserJsonParser.nextToken(), or
after encountering end-of-input), returns null.
Method can be called for any token type.getText in class JsonParserIOExceptionJsonParseExceptionpublic abstract char[] getTextCharacters()
throws IOException,
JsonParseException
JsonParserJsonParser.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 JsonParserIOExceptionJsonParseExceptionpublic abstract boolean hasTextCharacters()
JsonParserJsonParser.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.
hasTextCharacters in class JsonParserJsonParser.getTextCharacters(); false
means that it may or may not existpublic abstract int getTextLength()
throws IOException,
JsonParseException
JsonParserJsonParser.getTextCharacters(), to know length
of String stored in returned buffer.getTextLength in class JsonParserJsonParser.getTextCharacters() that are part of
textual content of the current token.IOExceptionJsonParseExceptionpublic abstract int getTextOffset()
throws IOException,
JsonParseException
JsonParserJsonParser.getTextCharacters(), to know offset
of the first text content character within buffer.getTextOffset in class JsonParserJsonParser.getTextCharacters() that is part of
textual content of the current token.IOExceptionJsonParseExceptionpublic abstract byte[] getBinaryValue(Base64Variant b64variant) throws IOException, JsonParseException
JsonParserJsonParser.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 JsonParserb64variant - Expected variant of base64 encoded
content (see Base64Variants for definitions
of "standard" variants).IOExceptionJsonParseExceptionpublic boolean getValueAsBoolean(boolean defaultValue)
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to a boolean value (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.
getValueAsBoolean in class JsonParserIOExceptionJsonParseExceptionpublic int getValueAsInt(int defaultValue)
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured type markers like start/end Object/Array) specified defaultValue will be returned; no exceptions are thrown.
getValueAsInt in class JsonParserIOExceptionJsonParseExceptionpublic long getValueAsLong(long defaultValue)
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured type markers like start/end Object/Array) specified defaultValue will be returned; no exceptions are thrown.
getValueAsLong in class JsonParserIOExceptionJsonParseExceptionpublic double getValueAsDouble(double defaultValue)
throws IOException,
JsonParseException
JsonParserIf representation can not be converted to an int (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.
getValueAsDouble in class JsonParserIOExceptionJsonParseExceptionprotected void _decodeBase64(String str, ByteArrayBuilder builder, Base64Variant b64variant) throws IOException, JsonParseException
IOExceptionJsonParseExceptionprotected void _reportInvalidBase64(Base64Variant b64variant, char ch, int bindex, String msg) throws JsonParseException
bindex - Relative index within base64 character unit; between 0
and 3 (as unit has exactly 4 characters)JsonParseExceptionprotected void _reportBase64EOF()
throws JsonParseException
JsonParseExceptionprotected void _reportUnexpectedChar(int ch,
String comment)
throws JsonParseException
JsonParseExceptionprotected void _reportInvalidEOF()
throws JsonParseException
JsonParseExceptionprotected void _reportInvalidEOF(String msg) throws JsonParseException
JsonParseExceptionprotected void _reportInvalidEOFInValue()
throws JsonParseException
JsonParseExceptionprotected void _throwInvalidSpace(int i)
throws JsonParseException
JsonParseExceptionprotected void _throwUnquotedSpace(int i,
String ctxtDesc)
throws JsonParseException
JsonParser.Feature.ALLOW_UNQUOTED_CONTROL_CHARS.JsonParseExceptionprotected char _handleUnrecognizedCharacterEscape(char ch)
throws JsonProcessingException
JsonProcessingExceptionprotected static final String _getCharDesc(int ch)
protected final void _reportError(String msg) throws JsonParseException
JsonParseExceptionprotected final void _wrapError(String msg, Throwable t) throws JsonParseException
JsonParseExceptionprotected final void _throwInternal()
protected final JsonParseException _constructError(String msg, Throwable t)