Package com.fasterxml.jackson.core.base

Class ParserBase

    • 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 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​(Object v)
        Description copied from class: JsonParser
        Helper method, usually equivalent to: getParsingContext().setCurrentValue(v);
        Overrides:
        setCurrentValue in class JsonParser

      • 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

      • overrideCurrentName

        public void overrideCurrentName​(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 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 AutoCloseable
        Specified by:
        close in interface Closeable
        Specified by:
        close in class ParserMinimalBase
        Throws:
        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 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:
        IOException

      • getTokenCharacterOffset

        public long getTokenCharacterOffset()

      • getTokenLineNr

        public int getTokenLineNr()

      • getTokenColumnNr

        public int getTokenColumnNr()

      • 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 Number getNumberValue()
                      throws 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:
        IOException