public abstract class ParserMinimalBase 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 JsonToken |
_currToken
Last token retrieved via
nextToken() , if any. |
protected JsonToken |
_lastClearedToken
Last cleared token, if any: that is, value that was in
effect when
clearCurrentToken() was called. |
protected static int |
INT_BACKSLASH |
protected static int |
INT_COLON |
protected static int |
INT_COMMA |
protected static int |
INT_CR |
protected static int |
INT_e |
protected static int |
INT_E |
protected static int |
INT_HASH |
protected static int |
INT_LBRACKET |
protected static int |
INT_LCURLY |
protected static int |
INT_LF |
protected static int |
INT_PERIOD |
protected static int |
INT_QUOTE |
protected static int |
INT_RBRACKET |
protected static int |
INT_RCURLY |
protected static int |
INT_SLASH |
protected static int |
INT_SPACE |
protected static int |
INT_TAB |
_features
Modifier | Constructor and Description |
---|---|
protected |
ParserMinimalBase() |
protected |
ParserMinimalBase(int features) |
Modifier and Type | Method and Description |
---|---|
protected static String |
_ascii(byte[] b) |
protected static byte[] |
_asciiBytes(String str) |
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 boolean |
_hasTextualNull(String value)
Helper method used to determine whether we are currently pointing to
a String value of "null" (NOT a null token); and, if so, that parser
is to recognize and return it similar to if it was real null token.
|
protected void |
_reportBase64EOF()
Deprecated.
in 2.2.3; should migrate away
|
protected void |
_reportError(String msg) |
protected void |
_reportInvalidBase64(Base64Variant b64variant,
char ch,
int bindex,
String msg)
Deprecated.
in 2.2.3; should migrate away
|
protected void |
_reportInvalidEOF() |
protected void |
_reportInvalidEOF(String msg) |
protected void |
_reportInvalidEOFInValue() |
protected void |
_reportMissingRootWS(int ch) |
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 |
clearCurrentToken()
Method called to "consume" the current token by effectively
removing it so that
JsonParser.hasCurrentToken() returns false, and
JsonParser.getCurrentToken() null). |
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_NAME s 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. |
JsonToken |
getCurrentToken()
Accessor to find which token parser currently points to, if any;
null will be returned if none.
|
int |
getCurrentTokenId()
Method similar to
JsonParser.getCurrentToken() but that returns an
int instead of JsonToken (enum value). |
JsonToken |
getLastClearedToken()
Method that can be called to get the last token that was
cleared using
JsonParser.clearCurrentToken() . |
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.
|
String |
getValueAsString(String defaultValue)
Method that will try to convert value of current token to a
String . |
boolean |
hasCurrentToken()
Method for checking whether parser currently points to
a token (and data for that token is available).
|
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. |
boolean |
hasTokenId(int id)
Method that is functionally equivalent to:
return getCurrentTokenId() == id
|
abstract boolean |
isClosed()
Method that can be called to determine whether this parser
is closed or not.
|
boolean |
isExpectedStartArrayToken()
Specialized accessor that can be used to verify that the current
token indicates start array (usually meaning that current token
is
JsonToken.START_ARRAY ) when start array is expected. |
boolean |
isExpectedStartObjectToken()
Similar to
JsonParser.isExpectedStartArrayToken() , but checks whether stream
currently points to JsonToken.START_OBJECT . |
abstract JsonToken |
nextToken()
Main iteration method, which will advance stream enough
to determine type of the next token, if any.
|
JsonToken |
nextValue()
Iteration method that will advance stream enough
to determine type of the next token that is a value type
(including JSON Array and Object start/end markers).
|
abstract void |
overrideCurrentName(String name)
Method that can be used to change what is considered to be
the current (field) name.
|
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 . |
_codec, _constructError, _reportUnsupportedOperation, canReadObjectId, canReadTypeId, canUseSchema, configure, disable, enable, getBigIntegerValue, getBinaryValue, getBooleanValue, getByteValue, getCodec, getCurrentLocation, getCurrentValue, getDecimalValue, getDoubleValue, getEmbeddedObject, getFeatureMask, getFloatValue, getInputSource, getIntValue, getLongValue, getNumberType, getNumberValue, getObjectId, getSchema, getShortValue, getTokenLocation, getTypeId, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, getValueAsString, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readBinaryValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, requiresCustomCodec, setCodec, setCurrentValue, setFeatureMask, setSchema, version
protected 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_HASH
protected static final int INT_PERIOD
protected static final int INT_e
protected static final int INT_E
protected JsonToken _currToken
nextToken()
, if any.
Null before the first call to nextToken()
,
as well as if token has been explicitly clearedprotected JsonToken _lastClearedToken
clearCurrentToken()
was called.protected ParserMinimalBase()
protected ParserMinimalBase(int features)
public abstract JsonToken nextToken() throws IOException
JsonParser
nextToken
in class JsonParser
IOException
public JsonToken getCurrentToken()
JsonParser
getCurrentToken
in class JsonParser
public final int getCurrentTokenId()
JsonParser
JsonParser.getCurrentToken()
but that returns an
int
instead of JsonToken
(enum value).
Use of int directly is typically more efficient on switch statements, so this method may be useful when building low-overhead codecs. Note, however, that effect may not be big enough to matter: make sure to profile performance before deciding to use this method.
getCurrentTokenId
in class JsonParser
int
matching one of constants from JsonTokenId
.public boolean hasCurrentToken()
JsonParser
parser.getCurrentToken() != null
.hasCurrentToken
in class JsonParser
JsonParser.nextToken()
; false otherwise (parser
was just constructed, encountered end-of-input
and returned null from JsonParser.nextToken()
, or the token
has been consumed)public boolean hasTokenId(int id)
JsonParser
return getCurrentTokenId() == id
but may be more efficiently implemented.
Note that no traversal or conversion is performed; so in some
cases calling method like JsonParser.isExpectedStartArrayToken()
is necessary instead.
hasTokenId
in class JsonParser
public boolean isExpectedStartArrayToken()
JsonParser
JsonToken.START_ARRAY
) when start array is expected.
For some specialized parsers this can return true for other cases
as well; this is usually done to emulate arrays in cases underlying
format is ambiguous (XML, for example, has no format-level difference
between Objects and Arrays; it just has elements).
Default implementation is equivalent to:
getCurrentToken() == JsonToken.START_ARRAYbut may be overridden by custom parser implementations.
isExpectedStartArrayToken
in class JsonParser
JsonToken.START_ARRAY
);
false if not.public boolean isExpectedStartObjectToken()
JsonParser
JsonParser.isExpectedStartArrayToken()
, but checks whether stream
currently points to JsonToken.START_OBJECT
.isExpectedStartObjectToken
in class JsonParser
public JsonToken nextValue() throws IOException
JsonParser
JsonToken.FIELD_NAME
is returned, another
time to get the value for the field.
Method is most useful for iterating over value entries
of JSON objects; field name will still be available
by calling JsonParser.getCurrentName()
when parser points to
the value.nextValue
in class JsonParser
JsonToken.NOT_AVAILABLE
if no tokens were
available yet)IOException
public JsonParser skipChildren() throws IOException
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
protected abstract void _handleEOF() throws JsonParseException
JsonParseException
public abstract String getCurrentName() throws IOException
JsonParser
JsonToken.FIELD_NAME
s 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 JsonParser
IOException
public abstract 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 interface AutoCloseable
close
in class JsonParser
IOException
public abstract 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 abstract JsonStreamContext getParsingContext()
JsonParser
getParsingContext
in class JsonParser
public void clearCurrentToken()
JsonParser
JsonParser.hasCurrentToken()
returns false, and
JsonParser.getCurrentToken()
null).
Cleared token value can still be accessed by calling
JsonParser.getLastClearedToken()
(if absolutely needed), but
usually isn't.
Method was added to be used by the optional data binder, since it has to be able to consume last token used for binding (so that it will not be used again).
clearCurrentToken
in class JsonParser
public JsonToken getLastClearedToken()
JsonParser
JsonParser.clearCurrentToken()
. This is not necessarily
the latest token read.
Will return null if no tokens have been cleared,
or if parser has been closed.getLastClearedToken
in class JsonParser
public abstract void overrideCurrentName(String name)
JsonParser
Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
overrideCurrentName
in class JsonParser
name
- Name to use as the current name; may be null.public abstract String getText() throws IOException
JsonParser
JsonParser.nextToken()
, or
after encountering end-of-input), returns null.
Method can be called for any token type.getText
in class JsonParser
IOException
public abstract char[] getTextCharacters() throws IOException
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
public abstract boolean hasTextCharacters()
JsonParser
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.
hasTextCharacters
in class JsonParser
JsonParser.getTextCharacters()
; false
means that it may or may not existpublic abstract int getTextLength() throws IOException
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
public abstract int getTextOffset() throws IOException
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
public abstract byte[] getBinaryValue(Base64Variant b64variant) throws IOException
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
public boolean getValueAsBoolean(boolean defaultValue) throws IOException
JsonParser
If representation can not be converted to a boolean value (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
getValueAsBoolean
in class JsonParser
IOException
public int getValueAsInt(int defaultValue) throws IOException
JsonParser
If representation can not be converted to an int (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
getValueAsInt
in class JsonParser
IOException
public long getValueAsLong(long defaultValue) throws IOException
JsonParser
If representation can not be converted to an int (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
getValueAsLong
in class JsonParser
IOException
public double getValueAsDouble(double defaultValue) throws IOException
JsonParser
If representation can not be converted to an int (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
getValueAsDouble
in class JsonParser
IOException
public String getValueAsString(String defaultValue) throws IOException
JsonParser
String
.
JSON Strings map naturally; scalar values get converted to
their textual representation.
If representation can not be converted to a String value (including structured types
like Objects and Arrays and null token), specified default value
will be returned; no exceptions are thrown.getValueAsString
in class JsonParser
IOException
protected void _decodeBase64(String str, ByteArrayBuilder builder, Base64Variant b64variant) throws IOException
IOException
@Deprecated protected 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)JsonParseException
@Deprecated protected void _reportBase64EOF() throws JsonParseException
JsonParseException
protected boolean _hasTextualNull(String value)
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 _reportInvalidEOFInValue() throws JsonParseException
JsonParseException
protected void _reportMissingRootWS(int ch) throws JsonParseException
JsonParseException
protected void _throwInvalidSpace(int i) throws JsonParseException
JsonParseException
protected void _throwUnquotedSpace(int i, String ctxtDesc) throws JsonParseException
JsonParser.Feature.ALLOW_UNQUOTED_CONTROL_CHARS
.JsonParseException
protected char _handleUnrecognizedCharacterEscape(char ch) throws JsonProcessingException
JsonProcessingException
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)
protected static byte[] _asciiBytes(String str)
protected static String _ascii(byte[] b)
Copyright © 2014 FasterXML. All Rights Reserved.