com.fasterxml.jackson.core.base

Class ParserBase

java.lang.Object

com.fasterxml.jackson.core.JsonParser

com.fasterxml.jackson.core.base.ParserMinimalBase

com.fasterxml.jackson.core.base.ParserBase

All Implemented Interfaces:

Versioned, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

NonBlockingJsonParserBase, ReaderBasedJsonParser, UTF8DataInputJsonParser, UTF8StreamJsonParser

public abstract class ParserBase
extends ParserMinimalBase

Intermediate base class used by all Jackson JsonParser implementations. Contains most common things that are independent of actual underlying input source.

Nested Class Summary

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

JsonParser.Feature, JsonParser.NumberType

Method Summary

Modifier and Type	Method and Description
ByteArrayBuilder	_getByteArrayBuilder()
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 JsonParser.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)
java.math.BigInteger	getBigIntegerValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can not be used as a Java long primitive type due to its magnitude.
byte[]	getBinaryValue(Base64Variant variant) 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.
JsonLocation	getCurrentLocation() Method that returns location of the last processed character; usually for error reporting purposes
java.lang.String	getCurrentName() Method that can be called to get the name associated with the current event.
java.lang.Object	getCurrentValue() Helper method, usually equivalent to: getParsingContext().getCurrentValue();
java.math.BigDecimal	getDecimalValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT or JsonToken.VALUE_NUMBER_INT.
double	getDoubleValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT and it can be expressed as a Java double primitive type.
float	getFloatValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT and it can be expressed as a Java float primitive type.
int	getIntValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a value of Java int primitive type.
long	getLongValue() Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a Java long primitive type.
JsonParser.NumberType	getNumberType() If current token is of type JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberType constants; otherwise returns null.
java.lang.Number	getNumberValue() Generic number value accessor method that will work for all kinds of numeric values.
JsonReadContext	getParsingContext() Method that can be used to access current parsing context reader is in.
long	getTokenCharacterOffset()
int	getTokenColumnNr()
int	getTokenLineNr()
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	hasTextCharacters() Method that can be used to determine whether calling of JsonParser.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	isNaN() Access for checking whether current token is a numeric value token, but one that is of "not-a-number" (NaN) variety (including both "NaN" AND positive/negative infinity!): not supported by all formats, but often supported for JsonToken.VALUE_NUMBER_FLOAT.
void	overrideCurrentName(java.lang.String name) Method that can be used to change what is considered to be the current (field) name.
JsonParser	overrideStdFeatures(int values, int mask) Bulk set method for (re)setting states of features specified by mask.
void	setCurrentValue(java.lang.Object v) Helper method, usually equivalent to: getParsingContext().setCurrentValue(v);
JsonParser	setFeatureMask(int newMask) Deprecated.
Version	version() Accessor for getting version of the core package, given a parser instance.

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

clearCurrentToken, currentToken, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getText, getTextCharacters, getTextLength, getTextOffset, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, getValueAsString, getValueAsString, hasCurrentToken, hasToken, hasTokenId, isExpectedStartArrayToken, isExpectedStartObjectToken, nextToken, nextValue, skipChildren

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

canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentName, finishToken, getBinaryValue, getBooleanValue, getByteValue, getCodec, getEmbeddedObject, getFeatureMask, getFormatFeatures, getInputSource, getNonBlockingInputFeeder, getObjectId, getSchema, getShortValue, getText, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, overrideFormatFeatures, readBinaryValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, requiresCustomCodec, setCodec, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema

Methods inherited from class java.lang.Object

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

Method Detail

version

public Version version()

Description copied from class: JsonParser

Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.

Specified by:

version in interface Versioned

Specified by:

version in class JsonParser

getCurrentValue

public java.lang.Object getCurrentValue()

Description copied from class: JsonParser

Helper method, usually equivalent to: getParsingContext().getCurrentValue();

Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.

Overrides:

getCurrentValue in class JsonParser

setCurrentValue

public void setCurrentValue(java.lang.Object v)

Description copied from class: JsonParser

Helper method, usually equivalent to: getParsingContext().setCurrentValue(v);

Overrides:

setCurrentValue in class JsonParser

enable

public JsonParser enable(JsonParser.Feature f)

Description copied from class: JsonParser

Method for enabling specified parser feature (check JsonParser.Feature for list of features)

Overrides:

enable in class JsonParser

disable

public JsonParser disable(JsonParser.Feature f)

Description copied from class: JsonParser

Method for disabling specified feature (check JsonParser.Feature for list of features)

Overrides:

disable in class JsonParser

setFeatureMask

@Deprecated
public JsonParser setFeatureMask(int newMask)

Deprecated.

Description copied from class: JsonParser

Bulk set method for (re)setting states of all standard JsonParser.Features

Overrides:

setFeatureMask in class JsonParser

Returns:

This parser object, to allow chaining of calls

overrideStdFeatures

public JsonParser overrideStdFeatures(int values,
                                      int mask)

Description copied from class: JsonParser

Bulk set method for (re)setting states of features specified by mask. Functionally equivalent to int oldState = getFeatureMask(); int newState = (oldState & ~mask) | (values & mask); setFeatureMask(newState); but preferred as this lets caller more efficiently specify actual changes made.

Overrides:

overrideStdFeatures in class JsonParser

Parameters:

values - Bit mask of set/clear state for features to change

mask - Bit mask of features to change

getCurrentName

public java.lang.String getCurrentName()
                                throws java.io.IOException

Method that can be called to get the name associated with the current event.

Specified by:

getCurrentName in class ParserMinimalBase

Throws:

java.io.IOException

overrideCurrentName

public void overrideCurrentName(java.lang.String name)

Description copied from class: JsonParser

Method that can be used to change what is considered to be the current (field) name. May be needed to support non-JSON data formats or unusual binding conventions; not needed for typical processing.

Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.

Specified by:

overrideCurrentName in class ParserMinimalBase

Parameters:

name - Name to use as the current name; may be null.

close

public void close()
           throws java.io.IOException

Description copied from class: JsonParser

Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature JsonParser.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 File or URL and creates stream or reader it does own them.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class ParserMinimalBase

Throws:

java.io.IOException

isClosed

public boolean isClosed()

Description copied from class: JsonParser

Method that can be called to determine whether this parser is closed or not. If it is closed, no new tokens can be retrieved by calling JsonParser.nextToken() (and the underlying stream may be closed). Closing may be due to an explicit call to JsonParser.close() or because parser has encountered end of input.

Specified by:

isClosed in class ParserMinimalBase

getParsingContext

public JsonReadContext getParsingContext()

Description copied from class: JsonParser

Method that can be used to access current parsing context reader is in. There are 3 different types: root, array and object contexts, with slightly different available information. Contexts are hierarchically nested, and can be used for example for figuring out part of the input document that correspond to specific array or object (for highlighting purposes, or error reporting). Contexts can also be used for simple xpath-like matching of input, if so desired.

Specified by:

getParsingContext in class ParserMinimalBase

getTokenLocation

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

Specified by:

getTokenLocation in class JsonParser

getCurrentLocation

public JsonLocation getCurrentLocation()

Method that returns location of the last processed character; usually for error reporting purposes

Specified by:

getCurrentLocation in class JsonParser

hasTextCharacters

public boolean hasTextCharacters()

Description copied from class: JsonParser

Method that can be used to determine whether calling of JsonParser.getTextCharacters() would be the most efficient way to access textual content for the event parser currently points to.

Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.

Specified by:

hasTextCharacters in class ParserMinimalBase

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

getBinaryValue

public byte[] getBinaryValue(Base64Variant variant)
                      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 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.

Specified by:

getBinaryValue in class ParserMinimalBase

Parameters:

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

Returns:

Decoded binary data

Throws:

java.io.IOException

getTokenCharacterOffset

public long getTokenCharacterOffset()

getTokenLineNr

public int getTokenLineNr()

getTokenColumnNr

public int getTokenColumnNr()

_getByteArrayBuilder

public ByteArrayBuilder _getByteArrayBuilder()

isNaN

public boolean isNaN()

Description copied from class: JsonParser

Access for checking whether current token is a numeric value token, but one that is of "not-a-number" (NaN) variety (including both "NaN" AND positive/negative infinity!): not supported by all formats, but often supported for JsonToken.VALUE_NUMBER_FLOAT. NOTE: roughly equivalent to calling !Double.isFinite() on value you would get from calling JsonParser.getDoubleValue().

Overrides:

isNaN in class JsonParser

getNumberValue

public java.lang.Number getNumberValue()
                                throws java.io.IOException

Description copied from class: JsonParser

Generic number value accessor method that will work for all kinds of numeric values. It will return the optimal (simplest/smallest possible) wrapper object that can express the numeric value just parsed.

Specified by:

getNumberValue in class JsonParser

Throws:

java.io.IOException

getNumberType

public JsonParser.NumberType getNumberType()
                                    throws java.io.IOException

Description copied from class: JsonParser

If current token is of type JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberType constants; otherwise returns null.

Specified by:

getNumberType in class JsonParser

Throws:

java.io.IOException

getIntValue

public int getIntValue()
                throws java.io.IOException

Description copied from class: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a value of Java int primitive type. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.getDoubleValue() and then casting; except for possible overflow/underflow exception.

Note: if the resulting integer value falls outside range of Java int, a JsonParseException may be thrown to indicate numeric overflow/underflow.

Specified by:

getIntValue in class JsonParser

Throws:

java.io.IOException

getLongValue

public long getLongValue()
                  throws java.io.IOException

Description copied from class: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can be expressed as a Java long primitive type. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.getDoubleValue() and then casting to int; except for possible overflow/underflow exception.

Note: if the token is an integer, but its value falls outside of range of Java long, a JsonParseException may be thrown to indicate numeric overflow/underflow.

Specified by:

getLongValue in class JsonParser

Throws:

java.io.IOException

getBigIntegerValue

public java.math.BigInteger getBigIntegerValue()
                                        throws java.io.IOException

Description copied from class: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it can not be used as a Java long primitive type due to its magnitude. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.getDecimalValue() and then constructing a BigInteger from that value.

Specified by:

getBigIntegerValue in class JsonParser

Throws:

java.io.IOException

getFloatValue

public float getFloatValue()
                    throws java.io.IOException

Description copied from class: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT and it can be expressed as a Java float primitive type. It can also be called for JsonToken.VALUE_NUMBER_INT; if so, it is equivalent to calling JsonParser.getLongValue() and then casting; except for possible overflow/underflow exception.

Note: if the value falls outside of range of Java float, a JsonParseException will be thrown to indicate numeric overflow/underflow.

Specified by:

getFloatValue in class JsonParser

Throws:

java.io.IOException

getDoubleValue

public double getDoubleValue()
                      throws java.io.IOException

Description copied from class: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT and it can be expressed as a Java double primitive type. It can also be called for JsonToken.VALUE_NUMBER_INT; if so, it is equivalent to calling JsonParser.getLongValue() and then casting; except for possible overflow/underflow exception.

Note: if the value falls outside of range of Java double, a JsonParseException will be thrown to indicate numeric overflow/underflow.

Specified by:

getDoubleValue in class JsonParser

Throws:

java.io.IOException

getDecimalValue

public java.math.BigDecimal getDecimalValue()
                                     throws java.io.IOException

Description copied from class: JsonParser

Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT or JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions are ever thrown.

Specified by:

getDecimalValue in class JsonParser

Throws:

java.io.IOException