Class Utf8StreamParser

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, Versioned

    public final class Utf8StreamParser
    extends JsonParserBase
    This is a concrete implementation of JsonParser, which is based on a InputStream as the input source.
    • Field Detail

      • _objectCodec

        protected ObjectCodec _objectCodec
        Codec used for data binding when (if) requested; typically full ObjectMapper, but that abstract is not part of core package.
      • _quadBuffer

        protected int[] _quadBuffer
        Temporary buffer used for name parsing.
      • _tokenIncomplete

        protected boolean _tokenIncomplete
        Flag that indicates that the current token has not yet been fully processed, and needs to be finished for some access (or skipped to obtain the next token)
      • _inputStream

        protected java.io.InputStream _inputStream
      • _inputBuffer

        protected byte[] _inputBuffer
        Current buffer from which data is read; generally data is read into buffer from input source, but in some cases pre-loaded buffer is handed to the parser.
      • _bufferRecyclable

        protected boolean _bufferRecyclable
        Flag that indicates whether the input buffer is recycable (and needs to be returned to recycler once we are done) or not.

        If it is not, it also means that parser can NOT modify underlying buffer.

    • Constructor Detail

      • Utf8StreamParser

        public Utf8StreamParser​(IOContext ctxt,
                                int features,
                                java.io.InputStream in,
                                ObjectCodec codec,
                                BytesToNameCanonicalizer sym,
                                byte[] inputBuffer,
                                int start,
                                int end,
                                boolean bufferRecyclable)
    • Method Detail

      • releaseBuffered

        public int releaseBuffered​(java.io.OutputStream out)
                            throws java.io.IOException
        Description copied from class: JsonParser
        Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given stream if possible; if underlying input is byte-based it can released, if not (char-based) it can not.
        Overrides:
        releaseBuffered in class JsonParser
        Returns:
        -1 if the underlying content source is not byte based (that is, input can not be sent to OutputStream; otherwise number of bytes released (0 if there was nothing to release)
        Throws:
        java.io.IOException - if write to stream threw exception
      • getInputSource

        public java.lang.Object getInputSource()
        Description copied from class: JsonParser
        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. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser and decorator object.

        In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.

        Overrides:
        getInputSource in class JsonParser
      • loadMore

        protected final boolean loadMore()
                                  throws java.io.IOException
        Specified by:
        loadMore in class JsonParserBase
        Throws:
        java.io.IOException
      • _loadToHaveAtLeast

        protected final boolean _loadToHaveAtLeast​(int minAvailable)
                                            throws java.io.IOException
        Helper method that will try to load at least specified number bytes in input buffer, possible moving existing data around if necessary
        Throws:
        java.io.IOException
        Since:
        1.6
      • _closeInput

        protected void _closeInput()
                            throws java.io.IOException
        Specified by:
        _closeInput in class JsonParserBase
        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).
        Overrides:
        _releaseBuffers in class JsonParserBase
        Throws:
        java.io.IOException
      • _getText2

        protected final java.lang.String _getText2​(JsonToken t)
      • getTextCharacters

        public char[] getTextCharacters()
                                 throws java.io.IOException,
                                        JsonParseException
        Description copied from class: JsonParser
        Method similar to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:
        • Textual contents are not guaranteed to start at index 0 (rather, call JsonParser.getTextOffset()) to know the actual offset
        • Length of textual contents may be less than the length of returned buffer: call JsonParser.getTextLength() for actual length of returned content.

        Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.

        The only reason to call this method (over JsonParser.getText()) is to avoid construction of a String object (which will make a copy of contents).

        Specified by:
        getTextCharacters in class JsonParserMinimalBase
        Throws:
        java.io.IOException
        JsonParseException
      • getBinaryValue

        public byte[] getBinaryValue​(Base64Variant b64variant)
                              throws java.io.IOException,
                                     JsonParseException
        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 JsonParserMinimalBase
        Parameters:
        b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).
        Returns:
        Decoded binary data
        Throws:
        java.io.IOException
        JsonParseException
      • nextToken

        public JsonToken nextToken()
                            throws java.io.IOException,
                                   JsonParseException
        Description copied from class: JsonParser
        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.
        Specified by:
        nextToken in class JsonParserMinimalBase
        Returns:
        Next token from the stream, if any found, or null to indicate end-of-input
        Throws:
        java.io.IOException
        JsonParseException
      • 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
        Overrides:
        close in class JsonParserBase
        Throws:
        java.io.IOException
      • nextFieldName

        public boolean nextFieldName​(SerializableString str)
                              throws java.io.IOException,
                                     JsonParseException
        Description copied from class: JsonParser
        Method that fetches next token (as if calling JsonParser.nextToken()) and verifies whether it is JsonToken.FIELD_NAME with specified name and returns result of that comparison. It is functionally equivalent to:
          return (nextToken() == JsonToken.FIELD_NAME) && str.getValue().equals(getCurrentName());
        
        but may be faster for parser to verify, and can therefore be used if caller expects to get such a property name from input next.
        Overrides:
        nextFieldName in class JsonParser
        Parameters:
        str - Property name to compare next token to (if next token is JsonToken.FIELD_NAME)
        Throws:
        java.io.IOException
        JsonParseException
      • nextTextValue

        public java.lang.String nextTextValue()
                                       throws java.io.IOException,
                                              JsonParseException
        Description copied from class: JsonParser
        Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.VALUE_STRING returns contained String value; otherwise returns null. It is functionally equivalent to:
          return (nextToken() == JsonToken.VALUE_STRING) ? getText() : null;
        
        but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.
        Overrides:
        nextTextValue in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException
      • nextIntValue

        public int nextIntValue​(int defaultValue)
                         throws java.io.IOException,
                                JsonParseException
        Description copied from class: JsonParser
        Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.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.
        Overrides:
        nextIntValue in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException
      • nextLongValue

        public long nextLongValue​(long defaultValue)
                           throws java.io.IOException,
                                  JsonParseException
        Description copied from class: JsonParser
        Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.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.
        Overrides:
        nextLongValue in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException
      • nextBooleanValue

        public java.lang.Boolean nextBooleanValue()
                                           throws java.io.IOException,
                                                  JsonParseException
        Description copied from class: JsonParser
        Method that fetches next token (as if calling JsonParser.nextToken()) and if it is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE returns matching Boolean value; otherwise return null. It is functionally equivalent to:
          JsonToken t = nextToken();
          if (t == JsonToken.VALUE_TRUE) return Boolean.TRUE;
          if (t == JsonToken.VALUE_FALSE) return Boolean.FALSE;
          return null;
        
        but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.
        Overrides:
        nextBooleanValue in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException
      • parseNumberText

        protected final JsonToken parseNumberText​(int c)
                                           throws java.io.IOException,
                                                  JsonParseException
        Initial parsing method for number values. It needs to be able to parse enough input to be able to determine whether the value is to be considered a simple integer value, or a more generic decimal value: latter of which needs to be expressed as a floating point number. The basic rule is that if the number has no fractional or exponential part, it is an integer; otherwise a floating point number.

        Because much of input has to be processed in any case, no partial parsing is done: all input text will be stored for further processing. However, actual numeric value conversion will be deferred, since it is usually the most complicated and costliest part of processing.

        Throws:
        java.io.IOException
        JsonParseException
      • slowParseFieldName

        protected Name slowParseFieldName()
                                   throws java.io.IOException,
                                          JsonParseException
        Method called when not even first 8 bytes are guaranteed to come consequtively. Happens rarely, so this is offlined; plus we'll also do full checks for escaping etc.
        Throws:
        java.io.IOException
        JsonParseException
      • parseEscapedFieldName

        protected Name parseEscapedFieldName​(int[] quads,
                                             int qlen,
                                             int currQuad,
                                             int ch,
                                             int currQuadBytes)
                                      throws java.io.IOException,
                                             JsonParseException
        Slower parsing method which is generally branched to when an escape sequence is detected (or alternatively for long names, or ones crossing input buffer boundary). In any case, needs to be able to handle more exceptional cases, gets slower, and hance is offlined to a separate method.
        Throws:
        java.io.IOException
        JsonParseException
      • _handleUnusualFieldName

        protected final Name _handleUnusualFieldName​(int ch)
                                              throws java.io.IOException,
                                                     JsonParseException
        Method called when we see non-white space character other than double quote, when expecting a field name. In standard mode will just throw an expection; but in non-standard modes may be able to parse name.
        Throws:
        java.io.IOException
        JsonParseException
      • _skipString

        protected void _skipString()
                            throws java.io.IOException,
                                   JsonParseException
        Method called to skim through rest of unparsed String value, if it is not needed. This can be done bit faster if contents need not be stored for future access.
        Throws:
        java.io.IOException
        JsonParseException
      • _handleUnexpectedValue

        protected JsonToken _handleUnexpectedValue​(int c)
                                            throws java.io.IOException,
                                                   JsonParseException
        Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content.
        Throws:
        java.io.IOException
        JsonParseException
        Since:
        1.3
      • _handleInvalidNumberStart

        protected JsonToken _handleInvalidNumberStart​(int ch,
                                                      boolean negative)
                                               throws java.io.IOException,
                                                      JsonParseException
        Method called if expected numeric value (due to leading sign) does not look like a number
        Throws:
        java.io.IOException
        JsonParseException
      • _matchToken

        protected final void _matchToken​(java.lang.String matchStr,
                                         int i)
                                  throws java.io.IOException,
                                         JsonParseException
        Throws:
        java.io.IOException
        JsonParseException
      • _reportInvalidToken

        protected void _reportInvalidToken​(java.lang.String matchedPart,
                                           java.lang.String msg)
                                    throws java.io.IOException,
                                           JsonParseException
        Throws:
        java.io.IOException
        JsonParseException
      • _decodeEscaped

        protected final char _decodeEscaped()
                                     throws java.io.IOException,
                                            JsonParseException
        Description copied from class: JsonParserBase
        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
        Overrides:
        _decodeEscaped in class JsonParserBase
        Throws:
        java.io.IOException
        JsonParseException
      • _skipCR

        protected final void _skipCR()
                              throws java.io.IOException
        We actually need to check the character value here (to see if we have \n following \r).
        Throws:
        java.io.IOException
      • _skipLF

        protected final void _skipLF()
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • growArrayBy

        public static int[] growArrayBy​(int[] arr,
                                        int more)
      • _decodeBase64

        protected byte[] _decodeBase64​(Base64Variant b64variant)
                                throws java.io.IOException,
                                       JsonParseException
        Efficient handling for incremental parsing of base64-encoded textual content.
        Throws:
        java.io.IOException
        JsonParseException