Class JsonParserBase

    • Field Detail

      • _ioContext

        protected final IOContext _ioContext
        I/O context for this reader. It handles buffer allocation for the reader.
      • _closed

        protected boolean _closed
        Flag that indicates whether parser is closed or not. Gets set when parser is either closed by explicit call (close()) or when end-of-input is reached.
      • _inputPtr

        protected int _inputPtr
        Pointer to next available character in buffer
      • _inputEnd

        protected int _inputEnd
        Index of character after last available one in the buffer.
      • _currInputProcessed

        protected long _currInputProcessed
        Number of characters/bytes that were contained in previous blocks (blocks that were already processed prior to the current buffer).
      • _currInputRow

        protected int _currInputRow
        Current row location of current point in input buffer, starting from 1, if available.
      • _currInputRowStart

        protected int _currInputRowStart
        Current index of the first character of the current row in input buffer. Needed to calculate column position, if necessary; benefit of not having column itself is that this only has to be updated once per line.
      • _tokenInputTotal

        protected long _tokenInputTotal
        Total number of bytes/characters read before start of current token. For big (gigabyte-sized) sizes are possible, needs to be long, unlike pointers and sizes related to in-memory buffers.
      • _tokenInputRow

        protected int _tokenInputRow
        Input row on which current token starts, 1-based
      • _tokenInputCol

        protected int _tokenInputCol
        Column on input row that current token starts; 0-based (although in the end it'll be converted to 1-based)
      • _parsingContext

        protected JsonReadContext _parsingContext
        Information about parser context, context in which the next token is to be parsed (root, array, object).
      • _nextToken

        protected JsonToken _nextToken
        Secondary token related to the next token after current one; used if its type is known. This may be value token that follows FIELD_NAME, for example.
      • _textBuffer

        protected final TextBuffer _textBuffer
        Buffer that contains contents of String values, including field names if necessary (name split across boundary, contains escape sequence, or access needed to char array)
      • _nameCopyBuffer

        protected char[] _nameCopyBuffer
        Temporary buffer that is needed if field name is accessed using JsonParserMinimalBase.getTextCharacters() method (instead of String returning alternatives)
      • _nameCopied

        protected boolean _nameCopied
        Flag set to indicate whether the field name is available from the name copy buffer or not (in addition to its String representation being available via read context)
      • _byteArrayBuilder

        protected ByteArrayBuilder _byteArrayBuilder
        ByteArrayBuilder is needed if 'getBinaryValue' is called. If so, we better reuse it for remainder of content.
      • _numTypesValid

        protected int _numTypesValid
        Bitfield that indicates which numeric representations have been calculated for the current type
      • _numberInt

        protected int _numberInt
      • _numberLong

        protected long _numberLong
      • _numberDouble

        protected double _numberDouble
      • _numberBigInt

        protected java.math.BigInteger _numberBigInt
      • _numberBigDecimal

        protected java.math.BigDecimal _numberBigDecimal
      • _numberNegative

        protected boolean _numberNegative
        Flag that indicates whether numeric value has a negative value. That is, whether its textual representation starts with minus character.
      • _intLength

        protected int _intLength
        Length of integer part of the number, in characters
      • _fractLength

        protected int _fractLength
        Length of the fractional part (not including decimal point or exponent), in characters. Not used for pure integer values.
      • _expLength

        protected int _expLength
        Length of the exponent part of the number, if any, not including 'e' marker or sign, just digits. Not used for pure integer values.
    • Constructor Detail

      • JsonParserBase

        protected JsonParserBase​(IOContext ctxt,
                                 int features)
    • Method Detail

      • version

        public Version version()
        Description copied from interface: Versioned
        Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).
        Specified by:
        version in interface Versioned
        Overrides:
        version in class JsonParser
      • 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 JsonParserMinimalBase
        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 JsonParserMinimalBase
      • 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 JsonParserMinimalBase
      • 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 JsonParserMinimalBase
        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
      • getTokenCharacterOffset

        public final long getTokenCharacterOffset()
      • getTokenLineNr

        public final int getTokenLineNr()
      • getTokenColumnNr

        public final int getTokenColumnNr()
      • loadMoreGuaranteed

        protected final void loadMoreGuaranteed()
                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • loadMore

        protected abstract boolean loadMore()
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • _closeInput

        protected abstract void _closeInput()
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • _releaseBuffers

        protected void _releaseBuffers()
                                throws java.io.IOException
        Method called to release internal buffers owned by the base reader. This may be called along with _closeInput() (for example, when explicitly closing this reader instance), or separately (if need be).
        Throws:
        java.io.IOException
      • reset

        protected final JsonToken reset​(boolean negative,
                                        int intLen,
                                        int fractLen,
                                        int expLen)
      • resetInt

        protected final JsonToken resetInt​(boolean negative,
                                           int intLen)
      • resetFloat

        protected final JsonToken resetFloat​(boolean negative,
                                             int intLen,
                                             int fractLen,
                                             int expLen)
      • resetAsNaN

        protected final JsonToken resetAsNaN​(java.lang.String valueStr,
                                             double value)
      • getNumberValue

        public java.lang.Number getNumberValue()
                                        throws java.io.IOException,
                                               JsonParseException
        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
        JsonParseException
      • _parseNumericValue

        protected void _parseNumericValue​(int expType)
                                   throws java.io.IOException,
                                          JsonParseException
        Method that will parse actual numeric value out of a syntactically valid number value. Type it will parse into depends on whether it is a floating point number, as well as its magnitude: smallest legal type (of ones available) is used for efficiency.
        Parameters:
        expType - Numeric type that we will immediately need, if any; mostly necessary to optimize handling of floating point numbers
        Throws:
        java.io.IOException
        JsonParseException
      • _decodeEscaped

        protected char _decodeEscaped()
                               throws java.io.IOException,
                                      JsonParseException
        Method that sub-classes must implement to support escaped sequences in base64-encoded sections. Sub-classes that do not need base64 support can leave this as is
        Throws:
        java.io.IOException
        JsonParseException
      • reportInvalidBase64Char

        protected java.lang.IllegalArgumentException reportInvalidBase64Char​(Base64Variant b64variant,
                                                                             int ch,
                                                                             int bindex)
                                                                      throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException
      • reportInvalidBase64Char

        protected java.lang.IllegalArgumentException reportInvalidBase64Char​(Base64Variant b64variant,
                                                                             int ch,
                                                                             int bindex,
                                                                             java.lang.String msg)
                                                                      throws java.lang.IllegalArgumentException
        Parameters:
        bindex - Relative index within base64 character unit; between 0 and 3 (as unit has exactly 4 characters)
        Throws:
        java.lang.IllegalArgumentException