Class UTF8Reader

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

    public final class UTF8Reader
    extends java.io.Reader
    Optimized Reader that reads UTF-8 encoded content from an input stream. Content may come either from a static byte[] buffer or InputStream.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean _autoClose  
      private int _byteCount
      Total read byte count; used for error reporting purposes
      private int _charCount
      Total read character count; used for error reporting purposes
      private byte[] _inputBuffer  
      private int _inputEnd
      Pointed to the end marker, that is, position one after the last valid available byte.
      private int _inputPtr
      Pointer to the next available byte (if any), iff less than mByteBufferEnd
      private java.io.InputStream _inputSource  
      private com.fasterxml.jackson.core.io.IOContext _ioContext
      IO context to use for returning input buffer, iff buffer is to be recycled when input ends.
      private int _surrogate
      Decoded first character of a surrogate pair, if one needs to be buffered
      private char[] _tmpBuffer  
      • Fields inherited from class java.io.Reader

        lock
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private UTF8Reader​(com.fasterxml.jackson.core.io.IOContext ctxt, java.io.InputStream in, boolean autoClose, byte[] buf, int ptr, int end)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean canModifyBuffer()
      Method that can be used to see if we can actually modify the underlying buffer.
      void close()  
      static UTF8Reader construct​(byte[] buf, int ptr, int len)  
      static UTF8Reader construct​(com.fasterxml.jackson.core.io.IOContext ctxt, java.io.InputStream in, boolean autoClose)  
      private void freeBuffers()
      This method should be called along with (or instead of) normal close.
      private boolean loadMore​(int available)  
      int read()  
      int read​(char[] cbuf)  
      int read​(char[] cbuf, int start, int len)  
      protected int readBytes()  
      protected int readBytesAt​(int offset)  
      protected void reportBounds​(char[] cbuf, int start, int len)  
      private void reportInvalidInitial​(int mask, int offset)  
      private void reportInvalidOther​(int mask, int offset)  
      protected void reportStrangeStream()  
      private void reportUnexpectedEOF​(int gotBytes, int needed)  
      • Methods inherited from class java.io.Reader

        mark, markSupported, nullReader, read, ready, reset, skip, transferTo
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • _ioContext

        private final com.fasterxml.jackson.core.io.IOContext _ioContext
        IO context to use for returning input buffer, iff buffer is to be recycled when input ends.
      • _inputSource

        private java.io.InputStream _inputSource
      • _autoClose

        private final boolean _autoClose
      • _inputBuffer

        private byte[] _inputBuffer
      • _inputPtr

        private int _inputPtr
        Pointer to the next available byte (if any), iff less than mByteBufferEnd
      • _inputEnd

        private int _inputEnd
        Pointed to the end marker, that is, position one after the last valid available byte.
      • _surrogate

        private int _surrogate
        Decoded first character of a surrogate pair, if one needs to be buffered
      • _charCount

        private int _charCount
        Total read character count; used for error reporting purposes
      • _byteCount

        private int _byteCount
        Total read byte count; used for error reporting purposes
      • _tmpBuffer

        private char[] _tmpBuffer
    • Constructor Detail

      • UTF8Reader

        private UTF8Reader​(com.fasterxml.jackson.core.io.IOContext ctxt,
                           java.io.InputStream in,
                           boolean autoClose,
                           byte[] buf,
                           int ptr,
                           int end)
    • Method Detail

      • construct

        public static UTF8Reader construct​(com.fasterxml.jackson.core.io.IOContext ctxt,
                                           java.io.InputStream in,
                                           boolean autoClose)
      • construct

        public static UTF8Reader construct​(byte[] buf,
                                           int ptr,
                                           int len)
      • freeBuffers

        private void freeBuffers()
        This method should be called along with (or instead of) normal close. After calling this method, no further reads should be tried. Method will try to recycle read buffers (if any).
      • canModifyBuffer

        protected final boolean canModifyBuffer()
        Method that can be used to see if we can actually modify the underlying buffer. This is the case if we are managing the buffer, but not if it was just given to us.
      • close

        public void close()
                   throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class java.io.Reader
        Throws:
        java.io.IOException
      • read

        public int read()
                 throws java.io.IOException
        Overrides:
        read in class java.io.Reader
        Throws:
        java.io.IOException
      • read

        public int read​(char[] cbuf)
                 throws java.io.IOException
        Overrides:
        read in class java.io.Reader
        Throws:
        java.io.IOException
      • read

        public int read​(char[] cbuf,
                        int start,
                        int len)
                 throws java.io.IOException
        Specified by:
        read in class java.io.Reader
        Throws:
        java.io.IOException
      • loadMore

        private boolean loadMore​(int available)
                          throws java.io.IOException
        Parameters:
        available - Number of "unused" bytes in the input buffer
        Returns:
        True, if enough bytes were read to allow decoding of at least one full character; false if EOF was encountered instead.
        Throws:
        java.io.IOException
      • readBytes

        protected final int readBytes()
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • readBytesAt

        protected final int readBytesAt​(int offset)
                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • reportInvalidInitial

        private void reportInvalidInitial​(int mask,
                                          int offset)
                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • reportInvalidOther

        private void reportInvalidOther​(int mask,
                                        int offset)
                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • reportUnexpectedEOF

        private void reportUnexpectedEOF​(int gotBytes,
                                         int needed)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • reportBounds

        protected void reportBounds​(char[] cbuf,
                                    int start,
                                    int len)
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • reportStrangeStream

        protected void reportStrangeStream()
                                    throws java.io.IOException
        Throws:
        java.io.IOException