Package org.apache.commons.io.input

Class BufferedFileChannelInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public final class BufferedFileChannelInputStream
extends java.io.InputStream
    InputStream implementation which uses direct buffer to read a file to avoid extra copy of data between Java and native memory which happens when using BufferedInputStream. Unfortunately, this is not something already available in JDK, sun.nio.ch.ChannelInputStream supports reading a file using NIO, but does not support buffering.

    This class was ported and adapted from Apache Spark commit 933dc6cb7b3de1d8ccaf73d124d6eb95b947ed19 where it was called NioBufferedFileInputStream.

    Since:
    2.9.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()  
      void close()  
      int read()  
      int read​(byte[] b, int offset, int len)  
      long skip​(long n)  

      • Methods inherited from class java.io.InputStream

        mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, transferTo

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BufferedFileChannelInputStream

        public BufferedFileChannelInputStream​(java.io.File file)
                               throws java.io.IOException
        Constructs a new instance for the given File.
        Parameters:
        file - The file to stream.
        Throws:
        java.io.IOException - If an I/O error occurs

      • BufferedFileChannelInputStream

        public BufferedFileChannelInputStream​(java.io.File file,
                                      int bufferSizeInBytes)
                               throws java.io.IOException
        Constructs a new instance for the given File and buffer size.
        Parameters:
        file - The file to stream.
        bufferSizeInBytes - buffer size.
        Throws:
        java.io.IOException - If an I/O error occurs

      • BufferedFileChannelInputStream

        public BufferedFileChannelInputStream​(java.nio.file.Path path)
                               throws java.io.IOException
        Constructs a new instance for the given Path.
        Parameters:
        path - The path to stream.
        Throws:
        java.io.IOException - If an I/O error occurs

      • BufferedFileChannelInputStream

        public BufferedFileChannelInputStream​(java.nio.file.Path path,
                                      int bufferSizeInBytes)
                               throws java.io.IOException
        Constructs a new instance for the given Path and buffer size.
        Parameters:
        path - The path to stream.
        bufferSizeInBytes - buffer size.
        Throws:
        java.io.IOException - If an I/O error occurs

    • Method Detail

      • available

        public int available()
              throws java.io.IOException
        Overrides:
        available in class java.io.InputStream
        Throws:
        java.io.IOException

      • close

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

      • read

        public int read()
         throws java.io.IOException
        Specified by:
        read in class java.io.InputStream
        Throws:
        java.io.IOException

      • read

        public int read​(byte[] b,
                int offset,
                int len)
         throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException

      • skip

        public long skip​(long n)
          throws java.io.IOException
        Overrides:
        skip in class java.io.InputStream
        Throws:
        java.io.IOException