Class ParserMinimalBase
- All Implemented Interfaces:
Versioned
,Closeable
,AutoCloseable
- Direct Known Subclasses:
ParserBase
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser
JsonParser.Feature, JsonParser.NumberType
-
Field Summary
Modifier and TypeFieldDescriptionprotected JsonToken
Last token retrieved vianextToken()
, if any.protected JsonToken
Last cleared token, if any: that is, value that was in effect whenclearCurrentToken()
was called.protected static final BigDecimal
protected static final BigDecimal
protected static final BigDecimal
protected static final BigDecimal
protected static final BigInteger
protected static final BigInteger
protected static final BigInteger
protected static final BigInteger
protected static final char
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
protected static final int
Deprecated.Since 2.16.protected static final double
protected static final long
protected static final double
protected static final double
protected static final long
protected static final double
protected static final byte[]
protected static final int[]
protected static final int
protected static final int
protected static final int
protected static final int
NOTE! Not used by JSON implementation but used by many of binary codecsprotected static final int
protected static final int
protected static final int
Fields inherited from class com.fasterxml.jackson.core.JsonParser
_features, _requestPayload, DEFAULT_READ_CAPABILITIES
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected static String
_ascii
(byte[] b) Deprecated.protected static byte[]
_asciiBytes
(String str) Deprecated.protected final 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 final String
_getCharDesc
(int ch) protected abstract void
Method sub-classes need to implement for verifying that end-of-content is acceptable at current input position.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 String
_longIntegerDesc
(String rawNum) protected String
_longNumberDesc
(String rawNum) protected final void
_reportError
(String msg) protected final void
_reportError
(String msg, Object arg) protected final void
_reportError
(String msg, Object arg1, Object arg2) protected void
_reportInputCoercion
(String msg, JsonToken inputType, Class<?> targetType) protected void
protected void
_reportInvalidEOF
(String msg) Deprecated.Since 2.8 use_reportInvalidEOF(String, JsonToken)
insteadprotected void
_reportInvalidEOF
(String msg, JsonToken currToken) protected void
Deprecated.Since 2.8 use_reportInvalidEOF(String, JsonToken)
insteadprotected void
protected void
_reportMissingRootWS
(int ch) protected void
_reportUnexpectedChar
(int ch, String comment) protected <T> T
_reportUnexpectedNumberChar
(int ch, String comment) protected final void
protected void
_throwInvalidSpace
(int i) protected final void
_wrapError
(String msg, Throwable t) void
Method called to "consume" the current token by effectively removing it so thatJsonParser.hasCurrentToken()
returns false, andJsonParser.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 featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled.Accessor to find which token parser currently points to, if any; null will be returned if none.int
Method similar toJsonParser.getCurrentToken()
but that returns anint
instead ofJsonToken
(enum value).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
Alias ofJsonParser.currentName()
.Alias forJsonParser.currentToken()
, may be deprecated sometime after Jackson 2.13 (will be removed from 3.0).int
Deprecated.Method that can be called to get the last token that was cleared usingJsonParser.clearCurrentToken()
.abstract JsonStreamContext
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 toJsonParser.nextToken()
, or after encountering end-of-input), returns null.abstract char[]
Method similar toJsonParser.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
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.abstract int
Accessor used withJsonParser.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
Method that will try to convert value of current token to a Javaint
value.int
getValueAsInt
(int defaultValue) Method that will try to convert value of current token to a int.long
Method that will try to convert value of current token to a long.long
getValueAsLong
(long defaultValue) Method that will try to convert value of current token to a long.Method that will try to convert value of current token to aString
.getValueAsString
(String defaultValue) Method that will try to convert value of current token to aString
.boolean
Method for checking whether parser currently points to a token (and data for that token is available).abstract boolean
Method that can be used to determine whether calling ofJsonParser.getTextCharacters()
would be the most efficient way to access textual content for the event parser currently points to.boolean
Method that is functionally equivalent to:return currentToken() == t
but may be more efficiently implemented.boolean
hasTokenId
(int id) Method that is functionally equivalent to:return currentTokenId() == id
but may be more efficiently implemented.abstract boolean
isClosed()
Method that can be called to determine whether this parser is closed or not.boolean
Similar toJsonParser.isExpectedStartArrayToken()
, but checks whether stream currently points toJsonToken.VALUE_NUMBER_INT
.boolean
Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token isJsonToken.START_ARRAY
) when start array is expected.boolean
Similar toJsonParser.isExpectedStartArrayToken()
, but checks whether stream currently points toJsonToken.START_OBJECT
.abstract JsonToken
Main iteration method, which will advance stream enough to determine type of the next token, if any.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.protected void
Method called to throw an exception for input token that looks like a number based on first character(s), but is not valid according to rules of format.protected void
Method called to throw an exception for integral (not floating point) input token with value outside of Java signed 32-bit range when requested asint
.protected void
reportOverflowInt
(String numDesc) protected void
reportOverflowInt
(String numDesc, JsonToken inputType) protected void
Method called to throw an exception for integral (not floating point) input token with value outside of Java signed 64-bit range when requested aslong
.protected void
reportOverflowLong
(String numDesc) protected void
reportOverflowLong
(String numDesc, JsonToken inputType) protected void
reportUnexpectedNumberChar
(int ch, String comment) Deprecated.Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points toJsonToken.START_OBJECT
orJsonToken.START_ARRAY
.Methods inherited from class com.fasterxml.jackson.core.JsonParser
_codec, _constructError, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _reportUnsupportedOperation, assignCurrentValue, canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentLocation, currentName, currentTokenLocation, currentValue, disable, enable, finishToken, getBigIntegerValue, getBinaryValue, getBooleanValue, getByteValue, getCodec, getCurrentLocation, getCurrentValue, getDecimalValue, getDoubleValue, getEmbeddedObject, getFeatureMask, getFloatValue, getFormatFeatures, getInputSource, getIntValue, getLongValue, getNonBlockingInputFeeder, getNumberType, getNumberValue, getNumberValueDeferred, getNumberValueExact, getObjectId, getReadCapabilities, getSchema, getShortValue, getText, getTokenLocation, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, isNaN, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, overrideFormatFeatures, overrideStdFeatures, readBinaryValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, requiresCustomCodec, setCodec, setCurrentValue, setFeatureMask, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema, streamReadConstraints, version
-
Field Details
-
INT_TAB
protected static final int INT_TAB- See Also:
-
INT_LF
protected static final int INT_LF- See Also:
-
INT_CR
protected static final int INT_CR- See Also:
-
INT_SPACE
protected static final int INT_SPACE- See Also:
-
INT_LBRACKET
protected static final int INT_LBRACKET- See Also:
-
INT_RBRACKET
protected static final int INT_RBRACKET- See Also:
-
INT_LCURLY
protected static final int INT_LCURLY- See Also:
-
INT_RCURLY
protected static final int INT_RCURLY- See Also:
-
INT_QUOTE
protected static final int INT_QUOTE- See Also:
-
INT_APOS
protected static final int INT_APOS- See Also:
-
INT_BACKSLASH
protected static final int INT_BACKSLASH- See Also:
-
INT_SLASH
protected static final int INT_SLASH- See Also:
-
INT_ASTERISK
protected static final int INT_ASTERISK- See Also:
-
INT_COLON
protected static final int INT_COLON- See Also:
-
INT_COMMA
protected static final int INT_COMMA- See Also:
-
INT_HASH
protected static final int INT_HASH- See Also:
-
INT_0
protected static final int INT_0- See Also:
-
INT_9
protected static final int INT_9- See Also:
-
INT_MINUS
protected static final int INT_MINUS- See Also:
-
INT_PLUS
protected static final int INT_PLUS- See Also:
-
INT_PERIOD
protected static final int INT_PERIOD- See Also:
-
INT_e
protected static final int INT_e- See Also:
-
INT_E
protected static final int INT_E- See Also:
-
CHAR_NULL
protected static final char CHAR_NULL- See Also:
-
NO_BYTES
protected static final byte[] NO_BYTES- Since:
- 2.9
-
NO_INTS
protected static final int[] NO_INTS- Since:
- 2.9
-
NR_UNKNOWN
protected static final int NR_UNKNOWN- See Also:
-
NR_INT
protected static final int NR_INT- See Also:
-
NR_LONG
protected static final int NR_LONG- See Also:
-
NR_BIGINT
protected static final int NR_BIGINT- See Also:
-
NR_DOUBLE
protected static final int NR_DOUBLE- See Also:
-
NR_BIGDECIMAL
protected static final int NR_BIGDECIMAL- See Also:
-
NR_FLOAT
protected static final int NR_FLOATNOTE! Not used by JSON implementation but used by many of binary codecs- Since:
- 2.9
- See Also:
-
BI_MIN_INT
-
BI_MAX_INT
-
BI_MIN_LONG
-
BI_MAX_LONG
-
BD_MIN_LONG
-
BD_MAX_LONG
-
BD_MIN_INT
-
BD_MAX_INT
-
MIN_INT_L
protected static final long MIN_INT_L- See Also:
-
MAX_INT_L
protected static final long MAX_INT_L- See Also:
-
MIN_LONG_D
protected static final double MIN_LONG_D- See Also:
-
MAX_LONG_D
protected static final double MAX_LONG_D- See Also:
-
MIN_INT_D
protected static final double MIN_INT_D- See Also:
-
MAX_INT_D
protected static final double MAX_INT_D- See Also:
-
MAX_ERROR_TOKEN_LENGTH
Deprecated.Since 2.16.ErrorReportConfiguration.getMaxErrorTokenLength()
will be used instead.Maximum number of characters to include in token reported as part of error messages.- Since:
- 2.9
- See Also:
-
_currToken
Last token retrieved vianextToken()
, if any. Null before the first call tonextToken()
, as well as if token has been explicitly cleared -
_lastClearedToken
Last cleared token, if any: that is, value that was in effect whenclearCurrentToken()
was called.
-
-
Constructor Details
-
ParserMinimalBase
protected ParserMinimalBase() -
ParserMinimalBase
protected ParserMinimalBase(int features)
-
-
Method Details
-
nextToken
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 classJsonParser
- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
currentToken
Description copied from class:JsonParser
Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.- Overrides:
currentToken
in classJsonParser
- Returns:
- Type of the token this parser currently points to, if any: null before any tokens have been read, and after end-of-input has been encountered, as well as if the current token has been explicitly cleared.
-
currentTokenId
public int currentTokenId()Description copied from class:JsonParser
Method similar toJsonParser.getCurrentToken()
but that returns anint
instead ofJsonToken
(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.
- Overrides:
currentTokenId
in classJsonParser
- Returns:
int
matching one of constants fromJsonTokenId
.
-
getCurrentToken
Description copied from class:JsonParser
Alias forJsonParser.currentToken()
, may be deprecated sometime after Jackson 2.13 (will be removed from 3.0).- Specified by:
getCurrentToken
in classJsonParser
- Returns:
- Type of the token this parser currently points to, if any: null before any tokens have been read, and
-
getCurrentTokenId
Deprecated.Description copied from class:JsonParser
Deprecated alias forJsonParser.currentTokenId()
.- Specified by:
getCurrentTokenId
in classJsonParser
- Returns:
int
matching one of constants fromJsonTokenId
.
-
hasCurrentToken
public boolean hasCurrentToken()Description copied from class:JsonParser
Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check forparser.getCurrentToken() != null
.- Specified by:
hasCurrentToken
in classJsonParser
- Returns:
- True if the parser just returned a valid
token via
JsonParser.nextToken()
; false otherwise (parser was just constructed, encountered end-of-input and returned null fromJsonParser.nextToken()
, or the token has been consumed)
-
hasTokenId
public boolean hasTokenId(int id) Description copied from class:JsonParser
Method that is functionally equivalent to:return currentTokenId() == 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.- Specified by:
hasTokenId
in classJsonParser
- Parameters:
id
- Token id to match (from (@link JsonTokenId})- Returns:
True
if the parser current points to specified token
-
hasToken
Description copied from class:JsonParser
Method that is functionally equivalent to:return currentToken() == t
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.- Specified by:
hasToken
in classJsonParser
- Parameters:
t
- Token to match- Returns:
True
if the parser current points to specified token
-
isExpectedStartArrayToken
public boolean isExpectedStartArrayToken()Description copied from class:JsonParser
Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token isJsonToken.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:
currentToken() == JsonToken.START_ARRAY
but may be overridden by custom parser implementations.- Overrides:
isExpectedStartArrayToken
in classJsonParser
- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_ARRAY
);false
if not
-
isExpectedStartObjectToken
public boolean isExpectedStartObjectToken()Description copied from class:JsonParser
Similar toJsonParser.isExpectedStartArrayToken()
, but checks whether stream currently points toJsonToken.START_OBJECT
.- Overrides:
isExpectedStartObjectToken
in classJsonParser
- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_OBJECT
);false
if not
-
isExpectedNumberIntToken
public boolean isExpectedNumberIntToken()Description copied from class:JsonParser
Similar toJsonParser.isExpectedStartArrayToken()
, but checks whether stream currently points toJsonToken.VALUE_NUMBER_INT
.The initial use case is for XML backend to efficiently (attempt to) coerce textual content into numbers.
- Overrides:
isExpectedNumberIntToken
in classJsonParser
- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.VALUE_NUMBER_INT
);false
if not
-
nextValue
Description copied from class:JsonParser
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). Or put another way, nextToken() will be called once, and ifJsonToken.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 callingJsonParser.getCurrentName()
when parser points to the value.- Specified by:
nextValue
in classJsonParser
- Returns:
- Next non-field-name token from the stream, if any found,
or null to indicate end-of-input (or, for non-blocking
parsers,
JsonToken.NOT_AVAILABLE
if no tokens were available yet) - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
skipChildren
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 toJsonToken.START_OBJECT
orJsonToken.START_ARRAY
. If not, it will do nothing. After skipping, stream will point to matchingJsonToken.END_OBJECT
orJsonToken.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 callJsonParser.nextToken()
to point to the next available token, if any.- Specified by:
skipChildren
in classJsonParser
- Returns:
- This parser, to allow call chaining
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
_handleEOF
Method sub-classes need to implement for verifying that end-of-content is acceptable at current input position.- Throws:
JsonParseException
- If end-of-content is not acceptable (for example, missing end-object or end-array tokens)
-
getCurrentName
Description copied from class:JsonParser
Alias ofJsonParser.currentName()
.- Specified by:
getCurrentName
in classJsonParser
- Returns:
- Name of the current field in the parsing context
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
close
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 featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so checkJsonFactory
for details, but the general idea is that if caller passes in closable resource (such asInputStream
orReader
) parser does NOT own the source; but if it passes a reference (such asFile
orURL
and creates stream or reader it does own them.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classJsonParser
- Throws:
IOException
- if there is either an underlying I/O problem
-
isClosed
public abstract 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 callingJsonParser.nextToken()
(and the underlying stream may be closed). Closing may be due to an explicit call toJsonParser.close()
or because parser has encountered end of input.- Specified by:
isClosed
in classJsonParser
- Returns:
True
if this parser instance has been closed
-
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 classJsonParser
- Returns:
- Stream input context (
JsonStreamContext
) associated with this parser
-
clearCurrentToken
public void clearCurrentToken()Description copied from class:JsonParser
Method called to "consume" the current token by effectively removing it so thatJsonParser.hasCurrentToken()
returns false, andJsonParser.getCurrentToken()
null). Cleared token value can still be accessed by callingJsonParser.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).
- Specified by:
clearCurrentToken
in classJsonParser
-
getLastClearedToken
Description copied from class:JsonParser
Method that can be called to get the last token that was cleared usingJsonParser.clearCurrentToken()
. This is not necessarily the latest token read. Will return null if no tokens have been cleared, or if parser has been closed.- Specified by:
getLastClearedToken
in classJsonParser
- Returns:
- Last cleared token, if any;
null
otherwise
-
overrideCurrentName
Description copied from class:JsonParser
Method that can be used to change what is considered to be the current (field) name. May be needed to support non-JSON data formats or unusual binding conventions; not needed for typical processing.Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
- Specified by:
overrideCurrentName
in classJsonParser
- Parameters:
name
- Name to use as the current name; may be null.
-
getText
Description copied from class:JsonParser
Method for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken()
, or after encountering end-of-input), returns null. Method can be called for any token type.- Specified by:
getText
in classJsonParser
- Returns:
- Textual value associated with the current token (one returned
by
JsonParser.nextToken()
or other iteration methods) - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems, including if the text is too large, seeStreamReadConstraints.Builder.maxStringLength(int)
-
getTextCharacters
Description copied from class:JsonParser
Method similar toJsonParser.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:- Textual contents are not guaranteed to start at
index 0 (rather, call
JsonParser.getTextOffset()
) to know the actual offset - Length of textual contents may be less than the
length of returned buffer: call
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).- Specified by:
getTextCharacters
in classJsonParser
- Returns:
- Buffer that contains the current textual value (but not necessarily at offset 0, and not necessarily until the end of buffer)
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems, including if the text is too large, seeStreamReadConstraints.Builder.maxStringLength(int)
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
hasTextCharacters
public abstract boolean hasTextCharacters()Description copied from class:JsonParser
Method that can be used to determine whether calling ofJsonParser.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 classJsonParser
- 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
-
getTextLength
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.- Specified by:
getTextLength
in classJsonParser
- Returns:
- Number of characters within buffer returned
by
JsonParser.getTextCharacters()
that are part of textual content of the current token. - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getTextOffset
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.- Specified by:
getTextOffset
in classJsonParser
- Returns:
- Offset of the first character within buffer returned
by
JsonParser.getTextCharacters()
that is part of textual content of the current token. - Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getBinaryValue
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 viaJsonParser.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 classJsonParser
- Parameters:
b64variant
- Expected variant of base64 encoded content (seeBase64Variants
for definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsBoolean
Description copied from class:JsonParser
Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.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.
- Overrides:
getValueAsBoolean
in classJsonParser
- Parameters:
defaultValue
- Default value to return if conversion toboolean
is not possible- Returns:
boolean
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsInt
Description copied from class:JsonParser
Method that will try to convert value of current token to a Javaint
value. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation can not be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.
- Overrides:
getValueAsInt
in classJsonParser
- Returns:
int
value current token is converted to, if possible; exception thrown otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsInt
Description copied from class:JsonParser
Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.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.
- Overrides:
getValueAsInt
in classJsonParser
- Parameters:
defaultValue
- Default value to return if conversion toint
is not possible- Returns:
int
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsLong
Description copied from class:JsonParser
Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation can not be converted to a long (including structured type markers like start/end Object/Array) default value of 0L will be returned; no exceptions are thrown.
- Overrides:
getValueAsLong
in classJsonParser
- Returns:
long
value current token is converted to, if possible; exception thrown otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsLong
Description copied from class:JsonParser
Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation can not be converted to a long (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsLong
in classJsonParser
- Parameters:
defaultValue
- Default value to return if conversion tolong
is not possible- Returns:
long
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsDouble
Description copied from class:JsonParser
Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language floating point parsing rules.If representation can not be converted to a double (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsDouble
in classJsonParser
- Parameters:
defaultValue
- Default value to return if conversion todouble
is not possible- Returns:
double
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsString
Description copied from class:JsonParser
Method that will try to convert value of current token to aString
. 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 andnull
token), default value of null will be returned; no exceptions are thrown.- Overrides:
getValueAsString
in classJsonParser
- Returns:
String
value current token is converted to, if possible;null
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getValueAsString
Description copied from class:JsonParser
Method that will try to convert value of current token to aString
. 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 andnull
token), specified default value will be returned; no exceptions are thrown.- Specified by:
getValueAsString
in classJsonParser
- Parameters:
defaultValue
- Default value to return if conversion toString
is not possible- Returns:
String
value current token is converted to, if possible;def
otherwise- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
_decodeBase64
protected void _decodeBase64(String str, ByteArrayBuilder builder, Base64Variant b64variant) throws IOException Helper method that can be used for base64 decoding in cases where encoded content has already been read as a String.- Parameters:
str
- String to decodebuilder
- Builder used to buffer binary content decodedb64variant
- Base64 variant expected in content- Throws:
IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
_hasTextualNull
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.Default implementation accepts exact string
"null"
and nothing else- Parameters:
value
- String value to check- Returns:
- True if given value contains "null equivalent" String value (for content this parser handles).
- Since:
- 2.3
-
_reportUnexpectedNumberChar
- Parameters:
ch
- Character that was unexpectedcomment
- Additional failure comment to add, if any- Throws:
JsonParseException
- Since:
- 2.14
-
reportUnexpectedNumberChar
@Deprecated protected void reportUnexpectedNumberChar(int ch, String comment) throws JsonParseException Deprecated.- Throws:
JsonParseException
-
reportInvalidNumber
Method called to throw an exception for input token that looks like a number based on first character(s), but is not valid according to rules of format. In case of JSON this also includes invalid forms like positive sign and leading zeroes.- Parameters:
msg
- Base exception message to use- Throws:
JsonParseException
- Exception that describes problem with number validity
-
reportOverflowInt
Method called to throw an exception for integral (not floating point) input token with value outside of Java signed 32-bit range when requested asint
. Result will beInputCoercionException
being thrown.- Throws:
JsonParseException
- Exception that describes problem with number range validityIOException
-
reportOverflowInt
- Throws:
IOException
-
reportOverflowInt
- Throws:
IOException
-
reportOverflowLong
Method called to throw an exception for integral (not floating point) input token with value outside of Java signed 64-bit range when requested aslong
. Result will beInputCoercionException
being thrown.- Throws:
JsonParseException
- Exception that describes problem with number range validityIOException
-
reportOverflowLong
- Throws:
IOException
-
reportOverflowLong
- Throws:
IOException
-
_reportInputCoercion
protected void _reportInputCoercion(String msg, JsonToken inputType, Class<?> targetType) throws InputCoercionException - Throws:
InputCoercionException
-
_longIntegerDesc
-
_longNumberDesc
-
_reportUnexpectedChar
- Throws:
JsonParseException
-
_reportInvalidEOF
- Throws:
JsonParseException
-
_reportInvalidEOFInValue
- Throws:
JsonParseException
-
_reportInvalidEOF
- Throws:
JsonParseException
-
_reportInvalidEOFInValue
Deprecated.Since 2.8 use_reportInvalidEOF(String, JsonToken)
instead- Throws:
JsonParseException
- Exception that describes problem with end-of-content within value
-
_reportInvalidEOF
Deprecated.Since 2.8 use_reportInvalidEOF(String, JsonToken)
instead- Parameters:
msg
- Addition message snippet to append to base exception message- Throws:
JsonParseException
- Exception that describes problem with end-of-content within value
-
_reportMissingRootWS
- Throws:
JsonParseException
-
_throwInvalidSpace
- Throws:
JsonParseException
-
_getCharDesc
-
_reportError
- Throws:
JsonParseException
-
_reportError
- Throws:
JsonParseException
-
_reportError
- Throws:
JsonParseException
-
_wrapError
- Throws:
JsonParseException
-
_throwInternal
protected final void _throwInternal() -
_constructError
-
_asciiBytes
Deprecated. -
_ascii
Deprecated.
-