public class

JsonParserSequence

extends JsonParserDelegate

java.lang.Object
↳	com.fasterxml.jackson.core.JsonParser
	↳	com.fasterxml.jackson.core.util.JsonParserDelegate
		↳	com.fasterxml.jackson.core.util.JsonParserSequence

Class Overview

Helper class that can be used to sequence multiple physical JsonParsers to create a single logical sequence of tokens, as a single JsonParser.

Fairly simple use of JsonParserDelegate: only need to override nextToken() to handle transition

Summary

Fields
protected int	_nextParser	Index of the next parser in `_parsers`.
protected final JsonParser[]	_parsers	Parsers other than the first one (which is initially assigned as delegate)

[Expand]

Inherited Fields

From class com.fasterxml.jackson.core.util.JsonParserDelegate

From class com.fasterxml.jackson.core.JsonParser

Protected Constructors
	JsonParserSequence(JsonParser[] parsers)

Public Methods
void	close() Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature `AUTO_CLOSE_SOURCE` is enabled.
int	containedParsersCount() Method that is most useful for debugging or testing; returns actual number of underlying parsers sequence was constructed with (nor just ones remaining active)
static JsonParserSequence	createFlattened(JsonParser first, JsonParser second) Method that will construct a parser (possibly a sequence) that contains all given sub-parsers.
JsonToken	nextToken() Main iteration method, which will advance stream enough to determine type of the next token, if any.

Protected Methods
void	addFlattenedActiveParsers(List<JsonParser> result)
boolean	switchToNext() Method that will switch active parser from the current one to next parser in sequence, if there is another parser left, making this the new delegate.

[Expand]

Inherited Methods

From class com.fasterxml.jackson.core.util.JsonParserDelegate

boolean	canUseSchema(FormatSchema schema) Method that can be used to verify that given schema can be used with this parser (using `setSchema(FormatSchema)`).
void	clearCurrentToken() Method called to "consume" the current token by effectively removing it so that `hasCurrentToken()` returns false, and `getCurrentToken()` null).
void	close() Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature `AUTO_CLOSE_SOURCE` is enabled.
JsonParser	disable(JsonParser.Feature f) Method for disabling specified feature (check `JsonParser.Feature` for list of features)
JsonParser	enable(JsonParser.Feature f) Method for enabling specified parser feature (check `JsonParser.Feature` for list of features)
BigInteger	getBigIntegerValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can not be used as a Java long primitive type due to its magnitude.
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.
boolean	getBooleanValue() Convenience accessor that can be called when the current token is `VALUE_TRUE` or `VALUE_FALSE`.
byte	getByteValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can be expressed as a value of Java byte primitive type.
ObjectCodec	getCodec() Accessor for `ObjectCodec` associated with this parser, if any.
JsonLocation	getCurrentLocation() Method that returns location of the last processed character; usually for error reporting purposes.
String	getCurrentName() Method that can be called to get the name associated with the current token: for `FIELD_NAME`s it will be the same as what `getText()` returns; for field values it will be preceding field name; and for others (array values, root-level values) null.
JsonToken	getCurrentToken() Accessor to find which token parser currently points to, if any; null will be returned if none.
BigDecimal	getDecimalValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_FLOAT` or `VALUE_NUMBER_INT`.
double	getDoubleValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_FLOAT` and it can be expressed as a Java double primitive type.
Object	getEmbeddedObject() Accessor that can be called if (and only if) the current token is `VALUE_EMBEDDED_OBJECT`.
float	getFloatValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_FLOAT` and it can be expressed as a Java float primitive type.
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.
int	getIntValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can be expressed as a value of Java int primitive type.
JsonToken	getLastClearedToken() Method that can be called to get the last token that was cleared using `clearCurrentToken()`.
long	getLongValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can be expressed as a Java long primitive type.
JsonParser.NumberType	getNumberType() If current token is of type `VALUE_NUMBER_INT` or `VALUE_NUMBER_FLOAT`, returns one of `JsonParser.NumberType` constants; otherwise returns null.
Number	getNumberValue() Generic number value accessor method that will work for all kinds of numeric values.
JsonStreamContext	getParsingContext() Method that can be used to access current parsing context reader is in.
short	getShortValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can be expressed as a value of Java short primitive type.
String	getText() Method for accessing textual representation of the current token; if no current token (before first call to `nextToken()`, or after encountering end-of-input), returns null.
char[]	getTextCharacters() Method similar to `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 `getTextCharacters()`, to know length of String stored in returned buffer.
int	getTextOffset() Accessor used with `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.
boolean	hasCurrentToken() Method for checking whether parser currently points to a token (and data for that token is available).
boolean	hasTextCharacters() Method that can be used to determine whether calling of `getTextCharacters()` would be the most efficient way to access textual content for the event parser currently points to.
boolean	isClosed() Method that can be called to determine whether this parser is closed or not.
boolean	isEnabled(JsonParser.Feature f) Method for checking whether specified `JsonParser.Feature` is enabled.
JsonToken	nextToken() Main iteration method, which will advance stream enough to determine type of the next token, if any.
JsonToken	nextValue() Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers).
void	overrideCurrentName(String name) Method that can be used to change what is considered to be the current (field) name.
int	readBinaryValue(Base64Variant b64variant, OutputStream out) Similar to `readBinaryValue(OutputStream)` but allows explicitly specifying base64 variant to use.
void	setCodec(ObjectCodec c) Setter that allows defining `ObjectCodec` associated with this parser, if any.
void	setSchema(FormatSchema schema) Method to call to make this parser use specified schema.
JsonParser	skipChildren() Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to `START_OBJECT` or `START_ARRAY`.
Version	version() Accessor for getting version of the core package, given a parser instance.

From class com.fasterxml.jackson.core.JsonParser

JsonParseException	_constructError(String msg) Helper method for constructing `JsonParseException`s based on current state of the parser
void	_reportUnsupportedOperation() Helper method to call for operations that are not supported by parser implementation.
boolean	canUseSchema(FormatSchema schema) Method that can be used to verify that given schema can be used with this parser (using `setSchema(FormatSchema)`).
abstract void	clearCurrentToken() Method called to "consume" the current token by effectively removing it so that `hasCurrentToken()` returns false, and `getCurrentToken()` null).
abstract void	close() Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature `AUTO_CLOSE_SOURCE` is enabled.
JsonParser	configure(JsonParser.Feature f, boolean state) Method for enabling or disabling specified feature (check `JsonParser.Feature` for list of features)
JsonParser	disable(JsonParser.Feature f) Method for disabling specified feature (check `JsonParser.Feature` for list of features)
JsonParser	enable(JsonParser.Feature f) Method for enabling specified parser feature (check `JsonParser.Feature` for list of features)
abstract BigInteger	getBigIntegerValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can not be used as a Java long primitive type due to its magnitude.
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.
byte[]	getBinaryValue() Convenience alternative to `getBinaryValue(Base64Variant)` that defaults to using `getDefaultVariant()` as the default encoding.
boolean	getBooleanValue() Convenience accessor that can be called when the current token is `VALUE_TRUE` or `VALUE_FALSE`.
byte	getByteValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can be expressed as a value of Java byte primitive type.
abstract ObjectCodec	getCodec() Accessor for `ObjectCodec` associated with this parser, if any.
abstract JsonLocation	getCurrentLocation() Method that returns location of the last processed character; usually for error reporting purposes.
abstract String	getCurrentName() Method that can be called to get the name associated with the current token: for `FIELD_NAME`s it will be the same as what `getText()` returns; for field values it will be preceding field name; and for others (array values, root-level values) null.
abstract JsonToken	getCurrentToken() Accessor to find which token parser currently points to, if any; null will be returned if none.
abstract BigDecimal	getDecimalValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_FLOAT` or `VALUE_NUMBER_INT`.
abstract double	getDoubleValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_FLOAT` and it can be expressed as a Java double primitive type.
abstract Object	getEmbeddedObject() Accessor that can be called if (and only if) the current token is `VALUE_EMBEDDED_OBJECT`.
abstract float	getFloatValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_FLOAT` and it can be expressed as a Java float primitive type.
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.
abstract int	getIntValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can be expressed as a value of Java int primitive type.
abstract JsonToken	getLastClearedToken() Method that can be called to get the last token that was cleared using `clearCurrentToken()`.
abstract long	getLongValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can be expressed as a Java long primitive type.
abstract JsonParser.NumberType	getNumberType() If current token is of type `VALUE_NUMBER_INT` or `VALUE_NUMBER_FLOAT`, returns one of `JsonParser.NumberType` constants; otherwise returns null.
abstract Number	getNumberValue() Generic number value accessor method that will work for all kinds of numeric values.
abstract JsonStreamContext	getParsingContext() Method that can be used to access current parsing context reader is in.
FormatSchema	getSchema() Method for accessing Schema that this parser uses, if any.
short	getShortValue() Numeric accessor that can be called when the current token is of type `VALUE_NUMBER_INT` and it can be expressed as a value of Java short primitive type.
abstract String	getText() Method for accessing textual representation of the current token; if no current token (before first call to `nextToken()`, or after encountering end-of-input), returns null.
abstract char[]	getTextCharacters() Method similar to `getText()`, but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.
abstract int	getTextLength() Accessor used with `getTextCharacters()`, to know length of String stored in returned buffer.
abstract int	getTextOffset() Accessor used with `getTextCharacters()`, to know offset of the first text content character within buffer.
abstract 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.
boolean	getValueAsBoolean(boolean defaultValue) Method that will try to convert value of current token to a boolean.
boolean	getValueAsBoolean() Method that will try to convert value of current token to a boolean.
double	getValueAsDouble() Method that will try to convert value of current token to a Java double.
double	getValueAsDouble(double defaultValue) Method that will try to convert value of current token to a Java double.
int	getValueAsInt(int defaultValue) Method that will try to convert value of current token to a int.
int	getValueAsInt() Method that will try to convert value of current token to a int.
long	getValueAsLong() 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.
abstract boolean	hasCurrentToken() Method for checking whether parser currently points to a token (and data for that token is available).
abstract boolean	hasTextCharacters() Method that can be used to determine whether calling of `getTextCharacters()` would be the most efficient way to access textual content for the event parser currently points to.
abstract boolean	isClosed() Method that can be called to determine whether this parser is closed or not.
boolean	isEnabled(JsonParser.Feature f) Method for checking whether specified `JsonParser.Feature` is enabled.
boolean	isExpectedStartArrayToken() Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token is `START_ARRAY`) when start array is expected.
Boolean	nextBooleanValue() Method that fetches next token (as if calling `nextToken()`) and if it is `VALUE_TRUE` or `VALUE_FALSE` returns matching Boolean value; otherwise return null.
boolean	nextFieldName(SerializableString str) Method that fetches next token (as if calling `nextToken()`) and verifies whether it is `FIELD_NAME` with specified name and returns result of that comparison.
int	nextIntValue(int defaultValue) Method that fetches next token (as if calling `nextToken()`) and if it is `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 a String value next from input.
long	nextLongValue(long defaultValue) Method that fetches next token (as if calling `nextToken()`) and if it is `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 String value next from input.
String	nextTextValue() Method that fetches next token (as if calling `nextToken()`) and if it is `VALUE_STRING` returns contained String value; otherwise returns null.
abstract JsonToken	nextToken() Main iteration method, which will advance stream enough to determine type of the next token, if any.
abstract JsonToken	nextValue() Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers).
abstract void	overrideCurrentName(String name) Method that can be used to change what is considered to be the current (field) name.
int	readBinaryValue(Base64Variant b64variant, OutputStream out) Similar to `readBinaryValue(OutputStream)` but allows explicitly specifying base64 variant to use.
int	readBinaryValue(OutputStream out) Method that can be used as an alternative to `getBigIntegerValue()`, especially when value can be large.
<T> T	readValueAs(TypeReference<?> valueTypeRef) Method to deserialize JSON content into a Java type, reference to which is passed as argument.
<T> T	readValueAs(Class<T> valueType) Method to deserialize JSON content into a non-container type (it can be an array type, however): typically a bean, array or a wrapper type (like `Boolean`).
<T extends TreeNode> T	readValueAsTree() Method to deserialize JSON content into equivalent "tree model", represented by root `TreeNode` of resulting model.
<T> Iterator<T>	readValuesAs(Class<T> valueType) Method for reading sequence of Objects from parser stream, all with same specified value type.
<T> Iterator<T>	readValuesAs(TypeReference<?> valueTypeRef) Method for reading sequence of Objects from parser stream, all with same specified value type.
int	releaseBuffered(Writer w) Method that can be called to push back any content that has been read but not consumed by the parser.
int	releaseBuffered(OutputStream out) Method that can be called to push back any content that has been read but not consumed by the parser.
abstract void	setCodec(ObjectCodec c) Setter that allows defining `ObjectCodec` associated with this parser, if any.
void	setSchema(FormatSchema schema) Method to call to make this parser use specified schema.
abstract JsonParser	skipChildren() Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to `START_OBJECT` or `START_ARRAY`.
abstract Version	version() Accessor for getting version of the core package, given a parser instance.

From class java.lang.Object

From interface com.fasterxml.jackson.core.Versioned

From interface java.io.Closeable

From interface java.lang.AutoCloseable

Fields

protected int _nextParser

Index of the next parser in _parsers.

protected final JsonParser[] _parsers

Parsers other than the first one (which is initially assigned as delegate)

Protected Constructors

protected JsonParserSequence (JsonParser[] parsers)

Public Methods

public void close ()

Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature AUTO_CLOSE_SOURCE is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so check JsonFactory for details, but the general idea is that if caller passes in closable resource (such as InputStream or Reader) parser does NOT own the source; but if it passes a reference (such as java.io.File or java.net.URL and creates stream or reader it does own them.

Throws

IOException

public int containedParsersCount ()

Method that is most useful for debugging or testing; returns actual number of underlying parsers sequence was constructed with (nor just ones remaining active)

public static JsonParserSequence createFlattened (JsonParser first, JsonParser second)

Method that will construct a parser (possibly a sequence) that contains all given sub-parsers. All parsers given are checked to see if they are sequences: and if so, they will be "flattened", that is, contained parsers are directly added in a new sequence instead of adding sequences within sequences. This is done to minimize delegation depth, ideally only having just a single level of delegation.

public JsonToken nextToken ()

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.

Returns

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

Throws

IOException
JsonParseException

Protected Methods

protected void addFlattenedActiveParsers (List<JsonParser> result)

protected boolean switchToNext ()

Method that will switch active parser from the current one to next parser in sequence, if there is another parser left, making this the new delegate. Old delegate is returned if switch succeeds.

Returns

True if switch succeeded; false otherwise

Interfaces

Classes

Enums

JsonParserSequence

Class Overview

Summary

Fields

protected int _nextParser

protected final JsonParser[] _parsers

Protected Constructors

protected JsonParserSequence (JsonParser[] parsers)

Public Methods

public void close ()

Throws

public int containedParsersCount ()

public static JsonParserSequence createFlattened (JsonParser first, JsonParser second)

public JsonToken nextToken ()

Returns

Throws

Protected Methods

protected void addFlattenedActiveParsers (List<JsonParser> result)

protected boolean switchToNext ()

Returns