Package com.bumptech.glide.load.resource.bitmap

Class RecyclableBufferedInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public class RecyclableBufferedInputStream
extends java.io.FilterInputStream
    Wraps an existing InputStream and buffers the input. Expensive interaction with the underlying input stream is minimized, since most (smaller) requests can be satisfied by accessing the buffer alone. The drawback is that some extra space is required to hold the buffer and that copying takes place when filling that buffer, but this is usually outweighed by the performance benefits.

    A typical application pattern for the class looks like this: 

     BufferedInputStream buf = new BufferedInputStream(new FileInputStream("file.java"));

    • Field Summary

      • Fields inherited from class java.io.FilterInputStream

        in

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()
      Returns an estimated number of bytes that can be read or skipped without blocking for more input.
      void close()
      Closes this stream.
      void fixMarkLimit()
      Reduces the mark limit to match the current buffer length to prevent the buffer from continuing to increase in size.
      void mark​(int readlimit)
      Sets a mark position in this stream.
      boolean markSupported()
      Indicates whether BufferedInputStream supports the mark(int) and reset() methods.
      int read()
      Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
      int read​(byte[] buffer, int offset, int byteCount)
      Reads at most byteCount bytes from this stream and stores them in byte array buffer starting at offset offset.
      void release()  
      void reset()
      Resets this stream to the last marked location.
      long skip​(long byteCount)
      Skips byteCount bytes in this stream.

      • Methods inherited from class java.io.FilterInputStream

        read

      • Methods inherited from class java.io.InputStream

        nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RecyclableBufferedInputStream

        public RecyclableBufferedInputStream​(@NonNull
                                     java.io.InputStream in,
                                     @NonNull
                                     ArrayPool byteArrayPool)

    • Method Detail

      • available

        public int available()
              throws java.io.IOException
        Returns an estimated number of bytes that can be read or skipped without blocking for more input. This method returns the number of bytes available in the buffer plus those available in the source stream, but see InputStream.available() for important caveats.
        Overrides:
        available in class java.io.FilterInputStream
        Returns:
        the estimated number of bytes available
        Throws:
        java.io.IOException - if this stream is closed or an error occurs

      • fixMarkLimit

        public void fixMarkLimit()
        Reduces the mark limit to match the current buffer length to prevent the buffer from continuing to increase in size.

        Subsequent calls to mark(int) will be obeyed and may cause the buffer size to increase.

      • release

        public void release()

      • close

        public void close()
           throws java.io.IOException
        Closes this stream. The source stream is closed and any resources associated with it are released.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.FilterInputStream
        Throws:
        java.io.IOException - if an error occurs while closing this stream.

      • mark

        public void mark​(int readlimit)
        Sets a mark position in this stream. The parameter readlimit indicates how many bytes can be read before a mark is invalidated. Calling reset() will reposition the stream back to the marked position if readlimit has not been surpassed. The underlying buffer may be increased in size to allow readlimit number of bytes to be supported.
        Overrides:
        mark in class java.io.FilterInputStream
        Parameters:
        readlimit - the number of bytes that can be read before the mark is invalidated.
        See Also:
        reset()

      • markSupported

        public boolean markSupported()
        Indicates whether BufferedInputStream supports the mark(int) and reset() methods.
        Overrides:
        markSupported in class java.io.FilterInputStream
        Returns:
        true for BufferedInputStreams.
        See Also:
        mark(int), reset()

      • read

        public int read()
         throws java.io.IOException
        Reads a single byte from this stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the source string has been reached. If the internal buffer does not contain any available bytes then it is filled from the source stream and the first byte is returned.
        Overrides:
        read in class java.io.FilterInputStream
        Returns:
        the byte read or -1 if the end of the source stream has been reached.
        Throws:
        java.io.IOException - if this stream is closed or another IOException occurs.

      • read

        public int read​(@NonNull
                byte[] buffer,
                int offset,
                int byteCount)
         throws java.io.IOException
        Reads at most byteCount bytes from this stream and stores them in byte array buffer starting at offset offset. Returns the number of bytes actually read or -1 if no bytes were read and the end of the stream was encountered. If all the buffered bytes have been used, a mark has not been put and the requested number of bytes is larger than the receiver's buffer size, this implementation bypasses the buffer and simply places the results directly into buffer.
        Overrides:
        read in class java.io.FilterInputStream
        Parameters:
        buffer - the byte array in which to store the bytes read.
        Returns:
        the number of bytes actually read or -1 if end of stream.
        Throws:
        java.lang.IndexOutOfBoundsException - if offset < 0 or byteCount < 0, or if offset + byteCount is greater than the size of buffer.
        java.io.IOException - if the stream is already closed or another IOException occurs.

      • reset

        public void reset()
           throws java.io.IOException
        Resets this stream to the last marked location.
        Overrides:
        reset in class java.io.FilterInputStream
        Throws:
        java.io.IOException - if this stream is closed, no mark has been put or the mark is no longer valid because more than readlimit bytes have been read since setting the mark.
        See Also:
        mark(int)

      • skip

        public long skip​(long byteCount)
          throws java.io.IOException
        Skips byteCount bytes in this stream. Subsequent calls to read() will not return these bytes unless reset() is used.
        Overrides:
        skip in class java.io.FilterInputStream
        Parameters:
        byteCount - the number of bytes to skip. This method does nothing and returns 0 if byteCount is less than zero.
        Returns:
        the number of bytes actually skipped.
        Throws:
        java.io.IOException - if this stream is closed or another IOException occurs.