Package com.fasterxml.jackson.core.base

Class ParserBase

  • All Implemented Interfaces:
    Versioned, java.io.Closeable, java.lang.AutoCloseable
    Direct Known Subclasses:
    JsonParserBase
    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.

    • 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
        Returns:
        Version of this generator (derived from version declared for jackson-core jar that contains the class

      • currentValue

        public java.lang.Object currentValue()
        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:
        currentValue in class JsonParser
        Returns:
        "Current value" associated with the current input context (state) of this parser

      • assignCurrentValue

        public void assignCurrentValue​(java.lang.Object v)
        Description copied from class: JsonParser
        Helper method, usually equivalent to: getParsingContext().setCurrentValue(v);
        Overrides:
        assignCurrentValue in class JsonParser
        Parameters:
        v - Current value to assign for the current input context of this parser

      • 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
        Parameters:
        newMask - Bit mask that defines set of features to enable
        Returns:
        This parser, to allow call chaining

      • 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
        Returns:
        This parser, to allow call chaining

      • getCurrentName

        @Deprecated
public java.lang.String getCurrentName()
                                throws java.io.IOException
        Deprecated.
        Method that can be called to get the name associated with the current event.
        Specified by:
        getCurrentName in class ParserMinimalBase
        Returns:
        Name of the current field in the parsing context
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • 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.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class ParserMinimalBase
        Throws:
        java.io.IOException - if there is either an underlying I/O problem

      • 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
        Returns:
        True if this parser instance has been closed

      • 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
        Returns:
        Stream input context (JsonStreamContext) associated with this parser

      • getTokenLocation

        @Deprecated
public JsonLocation getTokenLocation()
        Deprecated.
        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
        Returns:
        Starting location of the token parser currently points to

      • getCurrentLocation

        @Deprecated
public JsonLocation getCurrentLocation()
        Deprecated.
        Method that returns location of the last processed character; usually for error reporting purposes
        Specified by:
        getCurrentLocation in class JsonParser
        Returns:
        Location of the last processed input unit (byte or character)

      • 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 - for low-level read issues, or JsonParseException for decoding problems

      • getTokenCharacterOffset

        public long getTokenCharacterOffset()

      • getTokenLineNr

        public int getTokenLineNr()

      • getTokenColumnNr

        public int getTokenColumnNr()

      • isNaN

        public boolean isNaN()
              throws java.io.IOException
        Description copied from class: JsonParser
        Accessor for checking whether current token is a special "not-a-number" (NaN) token (including both "NaN" AND positive/negative infinity!). These values are not supported by all formats: JSON, for example, only supports them if JsonReadFeature.ALLOW_NON_NUMERIC_NUMBERS is enabled.

        NOTE: in case where numeric value is outside range of requested type -- most notably Float or Double -- and decoding results effectively in a NaN value, this method DOES NOT return true: only explicit incoming markers do. This is because value could still be accessed as a valid BigDecimal.

        Overrides:
        isNaN in class JsonParser
        Returns:
        True if the current token is reported as JsonToken.VALUE_NUMBER_FLOAT and represents a "Not a Number" value; false for other tokens and regular floating-point numbers.
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • 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
        Returns:
        Numeric value of the current token in its most optimal representation
        Throws:
        java.io.IOException - Problem with access: JsonParseException if the current token is not numeric, or if decoding of the value fails (invalid format for numbers); plain IOException if underlying content read fails (possible if values are extracted lazily)

      • getNumberValueExact

        public java.lang.Number getNumberValueExact()
                                     throws java.io.IOException
        Description copied from class: JsonParser
        Method similar to JsonParser.getNumberValue() with the difference that for floating-point numbers value returned may be BigDecimal if the underlying format does not store floating-point numbers using native representation: for example, textual formats represent numbers as Strings (which are 10-based), and conversion to Double is potentially lossy operation.

        Default implementation simply returns JsonParser.getNumberValue()

        Overrides:
        getNumberValueExact in class JsonParser
        Returns:
        Numeric value of the current token using most accurate representation
        Throws:
        java.io.IOException - Problem with access: JsonParseException if the current token is not numeric, or if decoding of the value fails (invalid format for numbers); plain IOException if underlying content read fails (possible if values are extracted lazily)

      • getNumberValueDeferred

        public java.lang.Object getNumberValueDeferred()
                                        throws java.io.IOException
        Description copied from class: JsonParser
        Method similar to JsonParser.getNumberValue() but that returns either same Number value as JsonParser.getNumberValue() (if already decoded), or String representation of as-of-yet undecoded number. Typically textual formats allow deferred decoding from String, whereas binary formats either decode numbers eagerly or have binary representation from which to decode value to return.

        Same constraints apply to calling this method as to JsonParser.getNumberValue(): current token must be either JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT; otherwise an exception is thrown

        Default implementation simply returns JsonParser.getNumberValue()

        Overrides:
        getNumberValueDeferred in class JsonParser
        Returns:
        Either Number (for already decoded numbers) or String (for deferred decoding).
        Throws:
        java.io.IOException - Problem with access: JsonParseException if the current token is not numeric, or if decoding of the value fails (invalid format for numbers); plain IOException if underlying content read fails (possible if values are extracted lazily)

      • 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 InputCoercionException may be thrown to indicate numeric overflow/underflow.

        Specified by:
        getIntValue in class JsonParser
        Returns:
        Current number value as int (if numeric token within Java 32-bit signed int range); otherwise exception thrown
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • 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 InputCoercionException may be thrown to indicate numeric overflow/underflow.

        Specified by:
        getLongValue in class JsonParser
        Returns:
        Current number value as long (if numeric token within Java 32-bit signed long range); otherwise exception thrown
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • 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
        Returns:
        Current number value as BigInteger (if numeric token); otherwise exception thrown
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • 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 InputCoercionException will be thrown to indicate numeric overflow/underflow.

        Specified by:
        getFloatValue in class JsonParser
        Returns:
        Current number value as float (if numeric token within Java float range); otherwise exception thrown
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • 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 InputCoercionException will be thrown to indicate numeric overflow/underflow.

        Specified by:
        getDoubleValue in class JsonParser
        Returns:
        Current number value as double (if numeric token within Java double range); otherwise exception thrown
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • 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
        Returns:
        Current number value as BigDecimal (if numeric token); otherwise exception thrown
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems