com.davidehrmann.vcdiff.io

Class IOUtils

java.lang.Object

com.davidehrmann.vcdiff.io.IOUtils

public final class IOUtils
extends Object

A subset of the Commons IOUtils class

Method Summary

Modifier and Type	Method and Description
static void	closeQuietly(Closeable closeable) Unconditionally close a Closeable.
static int	copy(InputStream input, OutputStream output) copy bytes from an InputStream to an OutputStream.
static long	copyLarge(InputStream input, OutputStream output) copy bytes from a large (over 2GB) InputStream to an OutputStream.
static long	copyLarge(InputStream input, OutputStream output, byte[] buffer) copy bytes from a large (over 2GB) InputStream to an OutputStream.
static byte[]	toByteArray(InputStream input) Get the contents of an InputStream as a byte[].

Methods inherited from class java.lang.Object

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

Method Detail

toByteArray

public static byte[] toByteArray(InputStream input)
                          throws IOException

Get the contents of an InputStream as a byte[].

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Parameters:

input - the InputStream to read from

Returns:

the requested byte array

Throws:

NullPointerException - if the input is null

IOException - if an I/O error occurs

copy

public static int copy(InputStream input,
                       OutputStream output)
                throws IOException

copy bytes from an InputStream to an OutputStream.

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Large streams (over 2GB) will return a bytes copied value of -1 after the copy has completed since the correct number of bytes cannot be returned as an int. For large streams use the copyLarge(InputStream, OutputStream) method.

Parameters:

input - the InputStream to read from

output - the OutputStream to write to

Returns:

the number of bytes copied, or -1 if > Integer.MAX_VALUE

Throws:

NullPointerException - if the input or output is null

IOException - if an I/O error occurs

Since:

1.1

copyLarge

public static long copyLarge(InputStream input,
                             OutputStream output)
                      throws IOException

copy bytes from a large (over 2GB) InputStream to an OutputStream.

This method buffers the input internally, so there is no need to use a BufferedInputStream.

The buffer size is given by DEFAULT_BUFFER_SIZE.

Parameters:

input - the InputStream to read from

output - the OutputStream to write to

Returns:

the number of bytes copied

Throws:

NullPointerException - if the input or output is null

IOException - if an I/O error occurs

Since:

1.3

copyLarge

public static long copyLarge(InputStream input,
                             OutputStream output,
                             byte[] buffer)
                      throws IOException

copy bytes from a large (over 2GB) InputStream to an OutputStream.

This method uses the provided buffer, so there is no need to use a BufferedInputStream.

Parameters:

input - the InputStream to read from

output - the OutputStream to write to

buffer - the buffer to use for the copy

Returns:

the number of bytes copied

Throws:

NullPointerException - if the input or output is null

IOException - if an I/O error occurs

Since:

2.2

closeQuietly

public static void closeQuietly(Closeable closeable)

Unconditionally close a Closeable.

Equivalent to Closeable.close(), except any exceptions will be ignored. This is typically used in finally blocks.

Example code:

   Closeable closeable = null;
   try {
       closeable = new FileReader("foo.txt");
       // process closeable
       closeable.close();
   } catch (Exception e) {
       // error handling
   } finally {
       IOUtils.closeQuietly(closeable);
   }
 

Parameters:

closeable - the object to close, may be null or already closed

Since:

2.0