Package com.fasterxml.jackson.core.json

Class UTF8StreamJsonParser

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.JsonParserBase

com.fasterxml.jackson.core.json.UTF8StreamJsonParser

All Implemented Interfaces:

Versioned, Closeable, AutoCloseable

public class UTF8StreamJsonParser
extends JsonParserBase

This is a concrete implementation of JsonParser, which is based on a InputStream as the input source.

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser

JsonParser.Feature, JsonParser.NumberType, JsonParser.NumberTypeFP

Constructor Summary

Constructors

Constructor	Description
UTF8StreamJsonParser(IOContext ctxt, int features, InputStream in, ObjectCodec codec, ByteQuadsCanonicalizer sym, byte[] inputBuffer, int start, int end, boolean bufferRecyclable)	Deprecated. Since 2.10
UTF8StreamJsonParser(IOContext ctxt, int features, InputStream in, ObjectCodec codec, ByteQuadsCanonicalizer sym, byte[] inputBuffer, int start, int end, int bytesPreProcessed, boolean bufferRecyclable)	Constructor called when caller wants to provide input buffer directly (or needs to, in case of bootstrapping having read some of contents) and it may or may not be recyclable use standard recycle context.

Method Summary

Modifier and Type	Method	Description
JsonLocation	currentLocation()	Method that returns location of the last processed input unit (character or byte) from the input; usually for error reporting purposes.
JsonLocation	currentTokenLocation()	Method that return the starting location of the current (most recently returned) token; that is, the position of the first input unit (character or byte) from input that starts the current token.
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.
Object	getInputSource()	Method that can be used to get access to object that is used to access input being parsed; this is usually either InputStream or Reader, depending on what parser was constructed with.
String	getText()	Method for accessing textual representation of the current token; if no current token (before first call to JsonParser.nextToken(), or after encountering end-of-input), returns null.
int	getText(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 to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.
int	getTextLength()	Accessor used with JsonParser.getTextCharacters(), to know length of String stored in returned buffer.
int	getTextOffset()	Accessor used with JsonParser.getTextCharacters(), to know offset of the first text content character within buffer.
int	getValueAsInt()	Method that will try to convert value of current token to a Java int value.
int	getValueAsInt(int defValue)	Method that will try to convert value of current token to a int.
String	getValueAsString()	Method that will try to convert value of current token to a String.
String	getValueAsString(String defValue)	Method that will try to convert value of current token to a String.
Boolean	nextBooleanValue()	Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE returns matching Boolean value; otherwise return null.
String	nextFieldName()	Method that fetches next token (as if calling JsonParser.nextToken()) and verifies whether it is JsonToken.FIELD_NAME; if it is, returns same as JsonParser.currentName(), otherwise null.
boolean	nextFieldName(SerializableString str)	Method that fetches next token (as if calling JsonParser.nextToken()) and verifies whether it is JsonToken.FIELD_NAME with specified name and returns result of that comparison.
int	nextIntValue(int defaultValue)	Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.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 calling JsonParser.nextToken()) and if it is JsonToken.VALUE_NUMBER_INT returns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:
String	nextTextValue()	Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.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, OutputStream out)	Similar to JsonParser.readBinaryValue(OutputStream) but allows explicitly specifying base64 variant to use.
int	releaseBuffered(OutputStream out)	Method that can be called to push back any content that has been read but not consumed by the parser.

Methods inherited from class com.fasterxml.jackson.core.json.JsonParserBase

getCodec, getCurrentLocation, getNumberTypeFP, getReadCapabilities, getTokenLocation, setCodec

Methods inherited from class com.fasterxml.jackson.core.base.ParserBase

_getByteArrayBuilder, assignCurrentValue, close, currentValue, disable, enable, getBigIntegerValue, getCurrentName, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberType, getNumberValue, getNumberValueDeferred, getNumberValueExact, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, hasTextCharacters, isClosed, isNaN, overrideCurrentName, overrideStdFeatures, setFeatureMask, streamReadConstraints, version

Methods inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase

clearCurrentToken, currentToken, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsLong, getValueAsLong, hasCurrentToken, hasToken, hasTokenId, isExpectedNumberIntToken, isExpectedStartArrayToken, isExpectedStartObjectToken, nextValue, skipChildren

Methods inherited from class com.fasterxml.jackson.core.JsonParser

canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentName, getBinaryValue, getBooleanValue, getByteValue, getCurrentValue, getEmbeddedObject, getFeatureMask, getFormatFeatures, getNonBlockingInputFeeder, getObjectId, getSchema, getShortValue, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, overrideFormatFeatures, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, requiresCustomCodec, setCurrentValue, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UTF8StreamJsonParser

@Deprecated
public UTF8StreamJsonParser(IOContext ctxt,
 int features,
 InputStream in,
 ObjectCodec codec,
 ByteQuadsCanonicalizer sym,
 byte[] inputBuffer,
 int start,
 int end,
 boolean bufferRecyclable)

Deprecated.

Since 2.10

Constructor called when caller wants to provide input buffer directly (or needs to, in case of bootstrapping having read some of contents) and it may or may not be recyclable use standard recycle context.

Parameters:

ctxt - I/O context to use

features - Standard stream read features enabled

in - InputStream used for reading actual content, if any; null if none

codec - ObjectCodec to delegate object deserialization to

sym - Name canonicalizer to use

inputBuffer - Input buffer to read initial content from (before Reader)

start - Pointer in inputBuffer that has the first content character to decode

end - Pointer past the last content character in inputBuffer

bufferRecyclable - Whether inputBuffer passed is managed by Jackson core (and thereby needs recycling)

UTF8StreamJsonParser

public UTF8StreamJsonParser(IOContext ctxt,
 int features,
 InputStream in,
 ObjectCodec codec,
 ByteQuadsCanonicalizer sym,
 byte[] inputBuffer,
 int start,
 int end,
 int bytesPreProcessed,
 boolean bufferRecyclable)

Constructor called when caller wants to provide input buffer directly (or needs to, in case of bootstrapping having read some of contents) and it may or may not be recyclable use standard recycle context.

Parameters:

ctxt - I/O context to use

features - Standard stream read features enabled

in - InputStream used for reading actual content, if any; null if none

codec - ObjectCodec to delegate object deserialization to

sym - Name canonicalizer to use

inputBuffer - Input buffer to read initial content from (before Reader)

start - Pointer in inputBuffer that has the first content character to decode

end - Pointer past the last content character in inputBuffer

bytesPreProcessed - Number of bytes that have been consumed already (by bootstrapping)

bufferRecyclable - Whether inputBuffer passed is managed by Jackson core (and thereby needs recycling)

Method Details

releaseBuffered

public int releaseBuffered(OutputStream out)
                    throws 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 stream if possible; if underlying input is byte-based it can released, if not (char-based) it can not.

Overrides:

releaseBuffered in class JsonParser

Parameters:

out - OutputStream to which buffered, undecoded content is written to

Returns:

-1 if the underlying content source is not byte based (that is, input can not be sent to OutputStream; otherwise number of bytes released (0 if there was nothing to release)

Throws:

IOException - if write to stream threw exception

getInputSource

public 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 either InputStream or Reader, 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 class JsonParser

Returns:

Input source this parser was configured with

getText

public String getText()
               throws IOException

Description copied from class: JsonParser

Method for accessing textual representation of the current token; if no current token (before first call to JsonParser.nextToken(), or after encountering end-of-input), returns null. Method can be called for any token type.

Specified by:

getText in class ParserMinimalBase

Returns:

Textual value associated with the current token (one returned by JsonParser.nextToken() or other iteration methods)

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems, including if the text is too large, see StreamReadConstraints.Builder.maxStringLength(int)

getText

public int getText(Writer writer)
            throws 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 single String to return, and write can occur directly from intermediate buffers Jackson uses.

NOTE: textual content will still be buffered (usually using TextBuffer) and will be accessible with other getText() calls (that is, it will not be consumed). So this accessor only avoids construction of String compared to plain JsonParser.getText() method.

Overrides:

getText in class JsonParser

Parameters:

writer - Writer to write textual content to

Returns:

The number of characters written to the Writer

Throws:

IOException - for low-level read issues or writes using passed writer, or JsonParseException for decoding problems

getValueAsString

public String getValueAsString()
                        throws IOException

Description copied from class: JsonParser

Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation can not be converted to a String value (including structured types like Objects and Arrays and null token), default value of null will be returned; no exceptions are thrown.

Overrides:

getValueAsString in class ParserMinimalBase

Returns:

String value current token is converted to, if possible; null otherwise

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

getValueAsString

public String getValueAsString(String defValue)
                        throws IOException

Description copied from class: JsonParser

Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation can not be converted to a String value (including structured types like Objects and Arrays and null token), specified default value will be returned; no exceptions are thrown.

Overrides:

getValueAsString in class ParserMinimalBase

Parameters:

defValue - Default value to return if conversion to String is not possible

Returns:

String value current token is converted to, if possible; def otherwise

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

getValueAsInt

public int getValueAsInt()
                  throws IOException

Description copied from class: JsonParser

Method that will try to convert value of current token to a Java int 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 class ParserMinimalBase

Returns:

int value current token is converted to, if possible; exception thrown otherwise

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

getValueAsInt

public int getValueAsInt(int defValue)
                  throws IOException

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 class ParserMinimalBase

Parameters:

defValue - Default value to return if conversion to int is not possible

Returns:

int value current token is converted to, if possible; def otherwise

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

getTextCharacters

public char[] getTextCharacters()
                         throws IOException

Description copied from class: JsonParser

Method similar to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. 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 class ParserMinimalBase

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, or JsonParseException for decoding problems, including if the text is too large, see StreamReadConstraints.Builder.maxStringLength(int)

getTextLength

public int getTextLength()
                  throws IOException

Description copied from class: JsonParser

Accessor used with JsonParser.getTextCharacters(), to know length of String stored in returned buffer.

Specified by:

getTextLength in class ParserMinimalBase

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, or JsonParseException for decoding problems

getTextOffset

public int getTextOffset()
                  throws IOException

Description copied from class: JsonParser

Accessor used with JsonParser.getTextCharacters(), to know offset of the first text content character within buffer.

Specified by:

getTextOffset in class ParserMinimalBase

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, or JsonParseException for decoding problems

getBinaryValue

public byte[] getBinaryValue(Base64Variant b64variant)
                      throws 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 via JsonParser.getText() and decoding result (except for decoding part), but should be significantly more performant.

Note that non-decoded textual contents of the current token are not guaranteed to be accessible after this method is called. Current implementation, for example, clears up textual content during decoding. Decoded binary content, however, will be retained until parser is advanced to the next event.

Overrides:

getBinaryValue in class ParserBase

Parameters:

b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).

Returns:

Decoded binary data

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

readBinaryValue

public int readBinaryValue(Base64Variant b64variant,
 OutputStream out)
                    throws IOException

Description copied from class: JsonParser

Similar to JsonParser.readBinaryValue(OutputStream) but allows explicitly specifying base64 variant to use.

Overrides:

readBinaryValue in class JsonParser

Parameters:

b64variant - base64 variant to use

out - Output stream to use for passing decoded binary data

Returns:

Number of bytes that were decoded and written via OutputStream

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

nextToken

public JsonToken nextToken()
                    throws 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 class ParserMinimalBase

Returns:

Next token from the stream, if any found, or null to indicate end-of-input

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

finishToken

public void finishToken()
                 throws 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, say JsonParser.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 class JsonParser

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

nextFieldName

public boolean nextFieldName(SerializableString str)
                      throws IOException

Description copied from class: JsonParser

Method that fetches next token (as if calling JsonParser.nextToken()) and verifies whether it is JsonToken.FIELD_NAME with specified name and returns result of that comparison. It is functionally equivalent to:

  return (nextToken() == JsonToken.FIELD_NAME) && str.getValue().equals(currentName());

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 class JsonParser

Parameters:

str - Property name to compare next token to (if next token is JsonToken.FIELD_NAME)

Returns:

True if parser advanced to JsonToken.FIELD_NAME with specified name; false otherwise (different token or non-matching name)

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

nextFieldName

public String nextFieldName()
                     throws IOException

Description copied from class: JsonParser

Method that fetches next token (as if calling JsonParser.nextToken()) and verifies whether it is JsonToken.FIELD_NAME; if it is, returns same as JsonParser.currentName(), otherwise null.

Overrides:

nextFieldName in class JsonParser

Returns:

Name of the the JsonToken.FIELD_NAME parser advanced to, if any; null if next token is of some other type

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

nextTextValue

public String nextTextValue()
                     throws IOException

Description copied from class: JsonParser

Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.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 class JsonParser

Returns:

Text value of the JsonToken.VALUE_STRING token parser advanced to; or null if next token is of some other type

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

nextIntValue

public int nextIntValue(int defaultValue)
                 throws IOException

Description copied from class: JsonParser

Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.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.

NOTE: value checks are performed similar to JsonParser.getIntValue()

Overrides:

nextIntValue in class JsonParser

Parameters:

defaultValue - Value to return if next token is NOT of type JsonToken.VALUE_NUMBER_INT

Returns:

Integer (int) value of the JsonToken.VALUE_NUMBER_INT token parser advanced to; or defaultValue if next token is of some other type

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

nextLongValue

public long nextLongValue(long defaultValue)
                   throws IOException

Description copied from class: JsonParser

Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.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.

NOTE: value checks are performed similar to JsonParser.getLongValue()

Overrides:

nextLongValue in class JsonParser

Parameters:

defaultValue - Value to return if next token is NOT of type JsonToken.VALUE_NUMBER_INT

Returns:

long value of the JsonToken.VALUE_NUMBER_INT token parser advanced to; or defaultValue if next token is of some other type

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

nextBooleanValue

public Boolean nextBooleanValue()
                         throws IOException

Description copied from class: JsonParser

Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.VALUE_TRUE or JsonToken.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 class JsonParser

Returns:

Boolean value of the JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE token parser advanced to; or null if next token is of some other type

Throws:

IOException - for low-level read issues, or JsonParseException for decoding problems

currentLocation

public JsonLocation currentLocation()

Description copied from class: JsonParser

Method that returns location of the last processed input unit (character or byte) from the input; usually for error reporting purposes.

Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only report specific boundary locations (start or end locations of tokens) and others only return JsonLocation.NA due to not having access to input location information (when delegating actual decoding work to other library)

Specified by:

currentLocation in class JsonParserBase

Returns:

Location of the last processed input unit (byte or character)

currentTokenLocation

public JsonLocation currentTokenLocation()

Description copied from class: JsonParser

Method that return the starting location of the current (most recently returned) token; that is, the position of the first input unit (character or byte) from input that starts the current token.

Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only return JsonLocation.NA due to not having access to input location information (when delegating actual decoding work to other library)

Specified by:

currentTokenLocation in class JsonParserBase

Returns:

Starting location of the token parser currently points to