Class ReaderBasedJsonParser
- java.lang.Object
-
- com.fasterxml.jackson.core.JsonParser
-
- com.fasterxml.jackson.core.base.ParserMinimalBase
-
- com.fasterxml.jackson.core.base.ParserBase
-
- com.fasterxml.jackson.core.json.ReaderBasedJsonParser
-
- All Implemented Interfaces:
Versioned
,java.io.Closeable
,java.lang.AutoCloseable
public class ReaderBasedJsonParser extends ParserBase
This is a concrete implementation ofJsonParser
, which is based on aReader
to handle low-level character conversion tasks.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser
JsonParser.Feature, JsonParser.NumberType
-
-
Constructor Summary
Constructors Constructor Description ReaderBasedJsonParser(IOContext ctxt, int features, java.io.Reader r, ObjectCodec codec, CharsToNameCanonicalizer st)
Method called when input comes as aReader
, and buffer allocation can be done using default mechanism.ReaderBasedJsonParser(IOContext ctxt, int features, java.io.Reader r, ObjectCodec codec, CharsToNameCanonicalizer st, char[] inputBuffer, int start, int end, boolean bufferRecyclable)
Method called when caller wants to provide input buffer directly, and it may or may not be recyclable use standard recycle context.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
finishToken()
Method that may be used to force full handling of the current token so that even if lazy processing is enabled, the whole contents are read for possible retrieval.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.ObjectCodec
getCodec()
Accessor forObjectCodec
associated with this parser, if any.JsonLocation
getCurrentLocation()
Method that returns location of the last processed character; usually for error reporting purposesjava.lang.Object
getInputSource()
Method that can be used to get access to object that is used to access input being parsed; this is usually eitherInputStream
orReader
, depending on what parser was constructed with.java.lang.String
getText()
Method for accessing textual representation of the current event; if no current event (before first call tonextToken()
, or after encountering end-of-input), returns null.int
getText(java.io.Writer writer)
Method to read the textual representation of the current token in chunks and pass it to the given Writer.char[]
getTextCharacters()
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.int
getTextLength()
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.int
getTextOffset()
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.JsonLocation
getTokenLocation()
Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.java.lang.String
getValueAsString()
Method that will try to convert value of current token to aString
.java.lang.String
getValueAsString(java.lang.String defValue)
Method that will try to convert value of current token to aString
.java.lang.Boolean
nextBooleanValue()
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null.java.lang.String
nextFieldName()
Method that fetches next token (as if callingJsonParser.nextToken()
) and verifies whether it isJsonToken.FIELD_NAME
; if it is, returns same asJsonParser.getCurrentName()
, otherwise null.boolean
nextFieldName(SerializableString sstr)
Method that fetches next token (as if callingJsonParser.nextToken()
) and verifies whether it isJsonToken.FIELD_NAME
with specified name and returns result of that comparison.int
nextIntValue(int defaultValue)
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 32-bit int value; otherwise returns specified default value It is functionally equivalent to:long
nextLongValue(long defaultValue)
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:java.lang.String
nextTextValue()
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_STRING
returns contained String value; otherwise returns null.JsonToken
nextToken()
Main iteration method, which will advance stream enough to determine type of the next token, if any.int
readBinaryValue(Base64Variant b64variant, java.io.OutputStream out)
Similar toJsonParser.readBinaryValue(OutputStream)
but allows explicitly specifying base64 variant to use.int
releaseBuffered(java.io.Writer w)
Method that can be called to push back any content that has been read but not consumed by the parser.void
setCodec(ObjectCodec c)
Setter that allows definingObjectCodec
associated with this parser, if any.-
Methods inherited from class com.fasterxml.jackson.core.base.ParserBase
_getByteArrayBuilder, close, disable, enable, getBigIntegerValue, getCurrentName, getCurrentValue, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberType, getNumberValue, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, hasTextCharacters, isClosed, isNaN, overrideCurrentName, overrideStdFeatures, setCurrentValue, setFeatureMask, version
-
Methods inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase
clearCurrentToken, currentToken, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, hasCurrentToken, hasToken, hasTokenId, isExpectedStartArrayToken, isExpectedStartObjectToken, nextValue, skipChildren
-
Methods inherited from class com.fasterxml.jackson.core.JsonParser
canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentName, getBinaryValue, getBooleanValue, getByteValue, getEmbeddedObject, getFeatureMask, getFormatFeatures, getNonBlockingInputFeeder, getObjectId, getSchema, getShortValue, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, overrideFormatFeatures, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, requiresCustomCodec, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema
-
-
-
-
Constructor Detail
-
ReaderBasedJsonParser
public ReaderBasedJsonParser(IOContext ctxt, int features, java.io.Reader r, ObjectCodec codec, CharsToNameCanonicalizer st, char[] inputBuffer, int start, int end, boolean bufferRecyclable)
Method called when caller wants to provide input buffer directly, and it may or may not be recyclable use standard recycle context.- Since:
- 2.4
-
ReaderBasedJsonParser
public ReaderBasedJsonParser(IOContext ctxt, int features, java.io.Reader r, ObjectCodec codec, CharsToNameCanonicalizer st)
Method called when input comes as aReader
, and buffer allocation can be done using default mechanism.
-
-
Method Detail
-
getCodec
public ObjectCodec getCodec()
Description copied from class:JsonParser
Accessor forObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
getCodec
in classJsonParser
-
setCodec
public void setCodec(ObjectCodec c)
Description copied from class:JsonParser
Setter that allows definingObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
setCodec
in classJsonParser
-
releaseBuffered
public int releaseBuffered(java.io.Writer w) throws java.io.IOException
Description copied from class:JsonParser
Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given writer if possible; if underlying input is char-based it can released, if not (byte-based) it can not.- Overrides:
releaseBuffered
in classJsonParser
- Returns:
- -1 if the underlying content source is not char-based
(that is, input can not be sent to
Writer
; otherwise number of chars released (0 if there was nothing to release) - Throws:
java.io.IOException
- if write using Writer threw exception
-
getInputSource
public java.lang.Object getInputSource()
Description copied from class:JsonParser
Method that can be used to get access to object that is used to access input being parsed; this is usually eitherInputStream
orReader
, depending on what parser was constructed with. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser and decorator object.In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.
- Overrides:
getInputSource
in classJsonParser
-
getText
public final java.lang.String getText() throws java.io.IOException
Method for accessing textual representation of the current event; if no current event (before first call tonextToken()
, or after encountering end-of-input), returns null. Method can be called for any event.- Specified by:
getText
in classParserMinimalBase
- Throws:
java.io.IOException
-
getText
public int getText(java.io.Writer writer) throws java.io.IOException
Description copied from class:JsonParser
Method to read the textual representation of the current token in chunks and pass it to the given Writer. Conceptually same as calling:writer.write(parser.getText());
but should typically be more efficient as longer content does need to be combined into a singleString
to return, and write can occur directly from intermediate buffers Jackson uses.- Overrides:
getText
in classJsonParser
- Returns:
- The number of characters written to the Writer
- Throws:
java.io.IOException
-
getValueAsString
public final java.lang.String getValueAsString() throws java.io.IOException
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 and null token), default value of null will be returned; no exceptions are thrown.- Overrides:
getValueAsString
in classParserMinimalBase
- Throws:
java.io.IOException
-
getValueAsString
public final java.lang.String getValueAsString(java.lang.String defValue) throws java.io.IOException
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 and null token), specified default value will be returned; no exceptions are thrown.- Overrides:
getValueAsString
in classParserMinimalBase
- Throws:
java.io.IOException
-
getTextCharacters
public final char[] getTextCharacters() throws java.io.IOException
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 classParserMinimalBase
- Throws:
java.io.IOException
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
getTextLength
public final int getTextLength() throws java.io.IOException
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.- Specified by:
getTextLength
in classParserMinimalBase
- Returns:
- Number of characters within buffer returned
by
JsonParser.getTextCharacters()
that are part of textual content of the current token. - Throws:
java.io.IOException
-
getTextOffset
public final int getTextOffset() throws java.io.IOException
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.- Specified by:
getTextOffset
in classParserMinimalBase
- Returns:
- Offset of the first character within buffer returned
by
JsonParser.getTextCharacters()
that is part of textual content of the current token. - Throws:
java.io.IOException
-
getBinaryValue
public byte[] getBinaryValue(Base64Variant b64variant) throws java.io.IOException
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.
- Overrides:
getBinaryValue
in classParserBase
- Parameters:
b64variant
- Expected variant of base64 encoded content (seeBase64Variants
for definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
java.io.IOException
-
readBinaryValue
public int readBinaryValue(Base64Variant b64variant, java.io.OutputStream out) throws java.io.IOException
Description copied from class:JsonParser
Similar toJsonParser.readBinaryValue(OutputStream)
but allows explicitly specifying base64 variant to use.- Overrides:
readBinaryValue
in classJsonParser
- Parameters:
b64variant
- base64 variant to useout
- Output stream to use for passing decoded binary data- Returns:
- Number of bytes that were decoded and written via
OutputStream
- Throws:
java.io.IOException
-
nextToken
public final JsonToken nextToken() throws java.io.IOException
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 classParserMinimalBase
- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
java.io.IOException
-
finishToken
public void finishToken() throws java.io.IOException
Description copied from class:JsonParser
Method that may be used to force full handling of the current token so that even if lazy processing is enabled, the whole contents are read for possible retrieval. This is usually used to ensure that the token end location is available, as well as token contents (similar to what calling, sayJsonParser.getTextCharacters()
, would achieve).Note that for many dataformat implementations this method will not do anything; this is the default implementation unless overridden by sub-classes.
- Overrides:
finishToken
in classJsonParser
- Throws:
java.io.IOException
-
nextFieldName
public boolean nextFieldName(SerializableString sstr) throws java.io.IOException
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and verifies whether it isJsonToken.FIELD_NAME
with specified name and returns result of that comparison. It is functionally equivalent to:return (nextToken() == JsonToken.FIELD_NAME) && str.getValue().equals(getCurrentName());
but may be faster for parser to verify, and can therefore be used if caller expects to get such a property name from input next.- Overrides:
nextFieldName
in classJsonParser
- Parameters:
sstr
- Property name to compare next token to (if next token isJsonToken.FIELD_NAME
)- Throws:
java.io.IOException
-
nextFieldName
public java.lang.String nextFieldName() throws java.io.IOException
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and verifies whether it isJsonToken.FIELD_NAME
; if it is, returns same asJsonParser.getCurrentName()
, otherwise null.- Overrides:
nextFieldName
in classJsonParser
- Throws:
java.io.IOException
-
nextTextValue
public final java.lang.String nextTextValue() throws java.io.IOException
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_STRING
returns contained String value; otherwise returns null. It is functionally equivalent to:return (nextToken() == JsonToken.VALUE_STRING) ? getText() : null;
but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.- Overrides:
nextTextValue
in classJsonParser
- Throws:
java.io.IOException
-
nextIntValue
public final int nextIntValue(int defaultValue) throws java.io.IOException
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 32-bit int value; otherwise returns specified default value It is functionally equivalent to:return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getIntValue() : defaultValue;
but may be faster for parser to process, and can therefore be used if caller expects to get an int value next from input.- Overrides:
nextIntValue
in classJsonParser
- Throws:
java.io.IOException
-
nextLongValue
public final long nextLongValue(long defaultValue) throws java.io.IOException
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getLongValue() : defaultValue;
but may be faster for parser to process, and can therefore be used if caller expects to get a long value next from input.- Overrides:
nextLongValue
in classJsonParser
- Throws:
java.io.IOException
-
nextBooleanValue
public final java.lang.Boolean nextBooleanValue() throws java.io.IOException
Description copied from class:JsonParser
Method that fetches next token (as if callingJsonParser.nextToken()
) and if it isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null. It is functionally equivalent to:JsonToken t = nextToken(); if (t == JsonToken.VALUE_TRUE) return Boolean.TRUE; if (t == JsonToken.VALUE_FALSE) return Boolean.FALSE; return null;
but may be faster for parser to process, and can therefore be used if caller expects to get a Boolean value next from input.- Overrides:
nextBooleanValue
in classJsonParser
- Throws:
java.io.IOException
-
getTokenLocation
public JsonLocation getTokenLocation()
Description copied from class:ParserBase
Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.- Overrides:
getTokenLocation
in classParserBase
-
getCurrentLocation
public JsonLocation getCurrentLocation()
Description copied from class:ParserBase
Method that returns location of the last processed character; usually for error reporting purposes- Overrides:
getCurrentLocation
in classParserBase
-
-