Field Detail

• BUFFER_SIZE

  public static final int BUFFER_SIZE

  The buffer size used for reading and writing, which is 8192.

  See Also:

  Constant Field Values

• executor

  private static final ExecutorService executor

• FIFO_SIZE

  static final int FIFO_SIZE

  The size of the FIFO used for exchanging I/O buffers between a reader thread and a writer thread. A minimum of two elements is required. The actual number is optimized to compensate for oscillating I/O bandwidths like e.g. with network shares.

  See Also:

  Constant Field Values

Constructor Detail

• Streams

  private Streams()

Method Detail

• cancel

  private static void cancel(Future<?> result)

  Cancels the reader thread synchronously. Synchronous cancellation of the reader thread is required so that a re-entry to the cat(...) method by the same thread cannot concurrently access the same shared buffers that an unfinished reader thread of a previous call may still be using.

• cat

  public static void cat(@WillNotClose
         InputStream in,
         @WillNotClose
         OutputStream out)
                  throws IOException

  Copies the data from the given input stream to the given output stream without closing them. This method calls OutputStream.flush() unless an IOException occurs when writing to the output stream. This hold true even if an IOException occurs when reading from the input stream.

  This is a high performance implementation which uses a pooled background thread to fill a FIFO of pooled buffers which is concurrently flushed by the current thread. It performs best when used with unbuffered streams.

  The name of this method is inspired by the Unix command line utility cat because you could use it to concatenate the contents of multiple streams.

  Parameters:

  in - the input stream.

  out - the output stream.

  Throws:

  InputException - if copying the data fails because of an IOException thrown by the input stream.

  IOException - if copying the data fails because of an IOException thrown by the output stream.

• copy

  public static void copy(@WillClose
          InputStream in,
          @WillClose
          OutputStream out)
                   throws IOException

  Copies the data from the given input stream to the given output stream and always closes both streams - even if an exception occurs.

  This is a high performance implementation which uses a pooled background thread to fill a FIFO of pooled buffers which is concurrently flushed by the current thread. It performs best when used with unbuffered streams.

  Parameters:

  in - the input stream.

  out - the output stream.

  Throws:

  InputException - if copying the data fails because of an IOException thrown by the input stream.

  IOException - if copying the data fails because of an IOException thrown by the output stream.