org.apache.pdfbox.io
Class IOUtils

java.lang.Object
  org.apache.pdfbox.io.IOUtils

public class IOUtils
extends Object

This class contains various I/O-related methods.

Version:

$Revision$

Method Summary

static void	closeQuietly(InputStream input) Unconditionally close an InputStream.
static void	closeQuietly(OutputStream output) Unconditionally close an OutputStream.
static void	closeQuietly(Reader input) Unconditionally close an Reader.
static void	closeQuietly(Writer output) Unconditionally close a Writer.
static long	copy(InputStream input, OutputStream output) Copies all the contents from the given input stream to the given output stream.
static long	populateBuffer(InputStream in, byte[] buffer) Populates the given buffer with data read from the input stream.
static byte[]	toByteArray(InputStream in) Reads the input stream and returns its contents as a byte array.

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 in)
                          throws IOException

Reads the input stream and returns its contents as a byte array.

Parameters:

in - the input stream to read from.

Returns:

the byte array

Throws:

IOException - if an I/O error occurs

copy

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

Copies all the contents from the given input stream to the given output stream.

Parameters:

input - the input stream

output - the output stream

Returns:

the number of bytes that have been copied

Throws:

IOException - if an I/O error occurs

populateBuffer

public static long populateBuffer(InputStream in,
                                  byte[] buffer)
                           throws IOException

Populates the given buffer with data read from the input stream. If the data doesn't fit the buffer, only the data that fits in the buffer is read. If the data is less than fits in the buffer, the buffer is not completely filled.

Parameters:

in - the input stream to read from

buffer - the buffer to fill

Returns:

the number of bytes written to the buffer

Throws:

IOException - if an I/O error occurs

closeQuietly

public static void closeQuietly(InputStream input)

Unconditionally close an InputStream.

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

Parameters:

input - the InputStream to close, may be null or already closed

closeQuietly

public static void closeQuietly(Reader input)

Unconditionally close an Reader.

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

Parameters:

input - the Reader to close, may be null or already closed

closeQuietly

public static void closeQuietly(Writer output)

Unconditionally close a Writer.

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

Parameters:

output - the Writer to close, may be null or already closed

closeQuietly

public static void closeQuietly(OutputStream output)

Unconditionally close an OutputStream.

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

Parameters:

output - the OutputStream to close, may be null or already closed