Class ParserMinimalBase
- All Implemented Interfaces:
Versioned,Closeable,AutoCloseable
- Direct Known Subclasses:
ParserBase,TokenBuffer.Parser,TreeTraversingParser
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, JsonParser.NumberTypeFP -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected JsonTokenLast token retrieved vianextToken(), if any.protected JsonTokenLast cleared token, if any: that is, value that was in effect whenclearCurrentToken()was called.protected final StreamReadConstraintsprotected longCurrent count of tokens, if tracked (see_trackMaxTokenCount)protected final booleanWhether or not to track the token count due aStreamReadConstraintsmaxTokenCount > 0.protected static final BigDecimalprotected static final BigDecimalprotected static final BigDecimalprotected static final BigDecimalprotected static final BigIntegerprotected static final BigIntegerprotected static final BigIntegerprotected static final BigIntegerprotected static final charprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intDeprecated.Since 2.16.protected static final doubleprotected static final longprotected static final doubleprotected static final doubleprotected static final longprotected static final doubleprotected static final byte[]protected static final int[]protected static final intprotected static final intprotected static final intprotected static final intNOTE!protected static final intprotected static final intprotected static final intFields inherited from class com.fasterxml.jackson.core.JsonParser
_features, _requestPayload, DEFAULT_READ_CAPABILITIES -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDeprecated.protectedParserMinimalBase(int features) Deprecated.protectedParserMinimalBase(int features, StreamReadConstraints src) protected -
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 JsonLocationFactory method used to provide location for cases where we must read and consume a single "wrong" character (to possibly allow error recovery), but need to report accurate location for that character: if so, the current location is past location we want, and location we want will be "one location earlier".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 voidMethod 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 JsonToken_nullSafeUpdateToken(JsonToken token) 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 voidprotected void_reportInvalidEOF(String msg, JsonToken currToken) protected voidprotected void_reportMissingRootWS(int ch) protected void_reportUnexpectedChar(int ch, String comment) protected <T> T_reportUnexpectedNumberChar(int ch, String comment) protected final voidprotected final <T> Tprotected void_throwInvalidSpace(int i) protected final JsonToken_updateToken(JsonToken token) protected final JsonTokenprotected final JsonTokenprotected final void_wrapError(String msg, Throwable t) voidMethod called to "consume" the current token by effectively removing it so thatJsonParser.hasCurrentToken()returns false, andJsonParser.getCurrentToken()null).abstract voidclose()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_SOURCEis enabled.Accessor to find which token parser currently points to, if any; null will be returned if none.longGet an approximate count of the number of tokens that have been read.intMethod similar toJsonParser.getCurrentToken()but that returns anintinstead 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 StringDeprecated.Alias forJsonParser.currentToken(), may be deprecated sometime after Jackson 2.13 (will be removed from 3.0).intDeprecated.Method that can be called to get the last token that was cleared usingJsonParser.clearCurrentToken().abstract JsonStreamContextMethod that can be used to access current parsing context reader is in.abstract StringgetText()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 intAccessor used withJsonParser.getTextCharacters(), to know length of String stored in returned buffer.abstract intAccessor used withJsonParser.getTextCharacters(), to know offset of the first text content character within buffer.booleangetValueAsBoolean(boolean defaultValue) Method that will try to convert value of current token to a boolean.doublegetValueAsDouble(double defaultValue) Method that will try to convert value of current token to a Java double.intMethod that will try to convert value of current token to a Javaintvalue.intgetValueAsInt(int defaultValue) Method that will try to convert value of current token to a int.longMethod that will try to convert value of current token to a long.longgetValueAsLong(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.booleanMethod for checking whether parser currently points to a token (and data for that token is available).abstract booleanMethod 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.booleanMethod that is functionally equivalent to:return currentToken() == tbut may be more efficiently implemented.booleanhasTokenId(int id) Method that is functionally equivalent to:return currentTokenId() == idbut may be more efficiently implemented.abstract booleanisClosed()Method that can be called to determine whether this parser is closed or not.booleanSimilar toJsonParser.isExpectedStartArrayToken(), but checks whether stream currently points toJsonToken.VALUE_NUMBER_INT.booleanSpecialized 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.booleanSimilar toJsonParser.isExpectedStartArrayToken(), but checks whether stream currently points toJsonToken.START_OBJECT.abstract JsonTokenMain 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 voidoverrideCurrentName(String name) Method that can be used to change what is considered to be the current (field) name.protected voidMethod 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 voidMethod 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 voidreportOverflowInt(String numDesc) protected voidreportOverflowInt(String numDesc, JsonToken inputType) protected voidMethod 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 voidreportOverflowLong(String numDesc) protected voidreportOverflowLong(String numDesc, JsonToken inputType) protected voidreportUnexpectedNumberChar(int ch, String comment) Deprecated.Method that will skip all child tokens of an array or object token that the parser currently points to, if (and only if) stream points toJsonToken.START_OBJECTorJsonToken.START_ARRAY.Get the constraints to apply when performing streaming reads.Methods inherited from class com.fasterxml.jackson.core.JsonParser
_codec, _constructError, _constructReadException, _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, getNumberTypeFP, 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, 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:
-
_streamReadConstraints
- Since:
- 2.18 (was higher up in
ParserBasebefore)
-
_currToken
Last token retrieved vianextToken(), if any. Null before the first call tonextToken(), as well as if token has been explicitly cleared -
_tokenCount
protected long _tokenCountCurrent count of tokens, if tracked (see_trackMaxTokenCount)- Since:
- 2.18
-
_trackMaxTokenCount
protected final boolean _trackMaxTokenCountWhether or not to track the token count due aStreamReadConstraintsmaxTokenCount > 0.- Since:
- 2.18
-
_lastClearedToken
Last cleared token, if any: that is, value that was in effect whenclearCurrentToken()was called.
-
-
Constructor Details
-
ParserMinimalBase
Deprecated. -
ParserMinimalBase
Deprecated. -
ParserMinimalBase
-
ParserMinimalBase
-
-
Method Details
-
streamReadConstraints
Description copied from class:JsonParserGet the constraints to apply when performing streaming reads.- Overrides:
streamReadConstraintsin classJsonParser- Returns:
- Read constraints used by this parser
-
nextToken
Description copied from class:JsonParserMain 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:
nextTokenin classJsonParser- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
currentToken
Description copied from class:JsonParserAccessor 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:
currentTokenin 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:JsonParserMethod similar toJsonParser.getCurrentToken()but that returns anintinstead 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:
currentTokenIdin classJsonParser- Returns:
intmatching one of constants fromJsonTokenId.
-
getCurrentToken
Description copied from class:JsonParserAlias forJsonParser.currentToken(), may be deprecated sometime after Jackson 2.13 (will be removed from 3.0).- Specified by:
getCurrentTokenin 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:JsonParserDeprecated alias forJsonParser.currentTokenId().- Specified by:
getCurrentTokenIdin classJsonParser- Returns:
intmatching one of constants fromJsonTokenId.
-
hasCurrentToken
public boolean hasCurrentToken()Description copied from class:JsonParserMethod for checking whether parser currently points to a token (and data for that token is available). Equivalent to check forparser.getCurrentToken() != null.- Specified by:
hasCurrentTokenin 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:JsonParserMethod that is functionally equivalent to:return currentTokenId() == idbut 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:
hasTokenIdin classJsonParser- Parameters:
id- Token id to match (from (@link JsonTokenId})- Returns:
Trueif the parser current points to specified token
-
hasToken
Description copied from class:JsonParserMethod that is functionally equivalent to:return currentToken() == tbut 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:
hasTokenin classJsonParser- Parameters:
t- Token to match- Returns:
Trueif the parser current points to specified token
-
isExpectedStartArrayToken
public boolean isExpectedStartArrayToken()Description copied from class:JsonParserSpecialized 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:
isExpectedStartArrayTokenin classJsonParser- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_ARRAY);falseif not
-
isExpectedStartObjectToken
public boolean isExpectedStartObjectToken()Description copied from class:JsonParserSimilar toJsonParser.isExpectedStartArrayToken(), but checks whether stream currently points toJsonToken.START_OBJECT.- Overrides:
isExpectedStartObjectTokenin classJsonParser- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_OBJECT);falseif not
-
isExpectedNumberIntToken
public boolean isExpectedNumberIntToken()Description copied from class:JsonParserSimilar 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:
isExpectedNumberIntTokenin classJsonParser- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.VALUE_NUMBER_INT);falseif not
-
nextValue
Description copied from class:JsonParserIteration 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_NAMEis 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.currentName()when parser points to the value.- Specified by:
nextValuein 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_AVAILABLEif no tokens were available yet) - Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
skipChildren
Description copied from class:JsonParserMethod that will skip all child tokens of an array or object token that the parser currently points to, if (and only if) stream points toJsonToken.START_OBJECTorJsonToken.START_ARRAY. If not, it will do nothing. After skipping, stream will point to matchingJsonToken.END_OBJECTorJsonToken.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:
skipChildrenin classJsonParser- Returns:
- This parser, to allow call chaining
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor 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
Deprecated.Description copied from class:JsonParserDeprecated alias ofJsonParser.currentName().- Specified by:
getCurrentNamein classJsonParser- Returns:
- Name of the current field in the parsing context
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
close
Description copied from class:JsonParserCloses 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_SOURCEis enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so checkJsonFactoryfor details, but the general idea is that if caller passes in closable resource (such asInputStreamorReader) parser does NOT own the source; but if it passes a reference (such asFileorURLand creates stream or reader it does own them.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classJsonParser- Throws:
IOException- if there is either an underlying I/O problem
-
isClosed
public abstract boolean isClosed()Description copied from class:JsonParserMethod 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:
isClosedin classJsonParser- Returns:
Trueif this parser instance has been closed
-
getParsingContext
Description copied from class:JsonParserMethod 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:
getParsingContextin classJsonParser- Returns:
- Stream input context (
JsonStreamContext) associated with this parser
-
currentTokenCount
public long currentTokenCount()Description copied from class:JsonParserGet an approximate count of the number of tokens that have been read. This count is likely to be only updated ifStreamReadConstraints.Builder.maxTokenCount(long)has been used to set a limit on the number of tokens that can be read.- Overrides:
currentTokenCountin classJsonParser- Returns:
- the number of tokens that have been read (-1 if the count is not available)
-
clearCurrentToken
public void clearCurrentToken()Description copied from class:JsonParserMethod 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:
clearCurrentTokenin classJsonParser
-
getLastClearedToken
Description copied from class:JsonParserMethod 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:
getLastClearedTokenin classJsonParser- Returns:
- Last cleared token, if any;
nullotherwise
-
overrideCurrentName
Description copied from class:JsonParserMethod 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:
overrideCurrentNamein classJsonParser- Parameters:
name- Name to use as the current name; may be null.
-
getText
Description copied from class:JsonParserMethod 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:
getTextin 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, orJsonParseExceptionfor decoding problems, including if the text is too large, seeStreamReadConstraints.Builder.maxStringLength(int)
-
getTextCharacters
Description copied from class:JsonParserMethod 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:
getTextCharactersin 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, orJsonParseExceptionfor 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:JsonParserMethod 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:
hasTextCharactersin 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:JsonParserAccessor used withJsonParser.getTextCharacters(), to know length of String stored in returned buffer.- Specified by:
getTextLengthin 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, orJsonParseExceptionfor decoding problems
-
getTextOffset
Description copied from class:JsonParserAccessor used withJsonParser.getTextCharacters(), to know offset of the first text content character within buffer.- Specified by:
getTextOffsetin 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, orJsonParseExceptionfor decoding problems
-
getBinaryValue
Description copied from class:JsonParserMethod 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:
getBinaryValuein classJsonParser- Parameters:
b64variant- Expected variant of base64 encoded content (seeBase64Variantsfor definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsBoolean
Description copied from class:JsonParserMethod 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:
getValueAsBooleanin classJsonParser- Parameters:
defaultValue- Default value to return if conversion tobooleanis not possible- Returns:
booleanvalue current token is converted to, if possible;defotherwise- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsInt
Description copied from class:JsonParserMethod that will try to convert value of current token to a Javaintvalue. 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:
getValueAsIntin classJsonParser- Returns:
intvalue current token is converted to, if possible; exception thrown otherwise- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsInt
Description copied from class:JsonParserMethod 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:
getValueAsIntin classJsonParser- Parameters:
defaultValue- Default value to return if conversion tointis not possible- Returns:
intvalue current token is converted to, if possible;defotherwise- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsLong
Description copied from class:JsonParserMethod 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:
getValueAsLongin classJsonParser- Returns:
longvalue current token is converted to, if possible; exception thrown otherwise- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsLong
Description copied from class:JsonParserMethod 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:
getValueAsLongin classJsonParser- Parameters:
defaultValue- Default value to return if conversion tolongis not possible- Returns:
longvalue current token is converted to, if possible;defotherwise- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsDouble
Description copied from class:JsonParserMethod 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:
getValueAsDoublein classJsonParser- Parameters:
defaultValue- Default value to return if conversion todoubleis not possible- Returns:
doublevalue current token is converted to, if possible;defotherwise- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsString
Description copied from class:JsonParserMethod 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 andnulltoken), default value of null will be returned; no exceptions are thrown.- Overrides:
getValueAsStringin classJsonParser- Returns:
Stringvalue current token is converted to, if possible;nullotherwise- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
getValueAsString
Description copied from class:JsonParserMethod 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 andnulltoken), specified default value will be returned; no exceptions are thrown.- Specified by:
getValueAsStringin classJsonParser- Parameters:
defaultValue- Default value to return if conversion toStringis not possible- Returns:
Stringvalue current token is converted to, if possible;defotherwise- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor 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, orJsonParseExceptionfor 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
-
_reportInputCoercion
protected void _reportInputCoercion(String msg, JsonToken inputType, Class<?> targetType) throws InputCoercionException - Throws:
InputCoercionException
-
_reportInvalidEOF
- Throws:
JsonParseException
-
_reportInvalidEOFInValue
- Throws:
JsonParseException
-
_reportInvalidEOF
- 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
-
_reportMissingRootWS
- Throws:
JsonParseException
-
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 beInputCoercionExceptionbeing 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 beInputCoercionExceptionbeing thrown.- Throws:
JsonParseException- Exception that describes problem with number range validityIOException
-
reportOverflowLong
- Throws:
IOException
-
reportOverflowLong
- Throws:
IOException
-
_longIntegerDesc
-
_longNumberDesc
-
_reportUnexpectedChar
- Throws:
JsonParseException
-
_reportUnexpectedNumberChar
- Type Parameters:
T- Nominal type for bogus return value- Parameters:
ch- Character that was unexpectedcomment- Additional failure comment to add, if any- Returns:
- Nothing, just declared to let caller use
returnwhen calling this method, to keep compiler happy. - Throws:
JsonParseException- constructed withJsonParser._constructReadException(String, JsonLocation)- Since:
- 2.14
-
reportUnexpectedNumberChar
@Deprecated protected void reportUnexpectedNumberChar(int ch, String comment) throws JsonParseException Deprecated.- Throws:
JsonParseException
-
_throwInvalidSpace
- Throws:
JsonParseException
-
_constructError
-
_currentLocationMinusOne
Factory method used to provide location for cases where we must read and consume a single "wrong" character (to possibly allow error recovery), but need to report accurate location for that character: if so, the current location is past location we want, and location we want will be "one location earlier".Default implementation simply returns
JsonParser.currentLocation()- Returns:
- Same as
JsonParser.currentLocation()except offset by -1 - Since:
- 2.17
-
_getCharDesc
-
_reportError
- Throws:
JsonParseException
-
_reportError
- Throws:
JsonParseException
-
_reportError
- Throws:
JsonParseException
-
_throwInternal
protected final void _throwInternal() -
_throwInternalReturnAny
protected final <T> T _throwInternalReturnAny() -
_wrapError
- Throws:
JsonParseException
-
_updateToken
- Throws:
StreamConstraintsException
-
_nullSafeUpdateToken
- Throws:
StreamConstraintsException
-
_updateTokenToNull
-
_updateTokenToNA
-
_asciiBytes
Deprecated. -
_ascii
Deprecated.
-