uk.ac.ed.ph.snuggletex.internal.util

Class IOUtilities

java.lang.Object

uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

public final class IOUtilities
extends Object

A collection of vaguely useful utilities for doing common I/O and File-related tasks.

(This is a cut-down version of the Class of the same name in ph-commons-util.)

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE Buffer size when transferring streams
static int	MAX_TEXT_STREAM_SIZE Maximum size of characters we'll read from a text stream before complaining

Constructor Summary

Constructors

Constructor and Description
IOUtilities()

Method Summary

Modifier and Type	Method and Description
static void	ensureClose(Closeable... streams) Ensures that as many of the given Closeables are closed.
static File	ensureDirectoryCreated(File directory) Simple method to ensure that a given directory exists.
static File	ensureFileCreated(File file) Simple method to ensure that a given File exists.
static String	readCharacterStream(Reader reader) Reads all character data from the given Reader, returning a String containing all of the data.
static String	readUnicodeFile(File file) Same as readUnicodeStream(InputStream) but accepts a plain File object for convenience
static String	readUnicodeStream(InputStream in) Same as readCharacterStream(Reader) but assumes the stream is encoded as UTF-8.
static void	transfer(FileInputStream fileInStream, FileOutputStream fileOutStream) Version of transfer(InputStream, OutputStream) for File streams that uses NIO to do a hopefully more efficient transfer.
static void	transfer(InputStream inStream, OutputStream outStream) "Transfers" data from the given InputStream to the given OutputStream, closing both streams once the InputStream has been exhausted.
static void	transfer(InputStream inStream, OutputStream outStream, boolean closeOutputStream) "Transfers" data from the given InputStream to the given OutputStream, closing the InputStream afterwards.
static void	transfer(InputStream inStream, OutputStream outStream, boolean closeInputStream, boolean closeOutputStream) "Transfers" data from the given InputStream to the given OutputStream, optionally closing the given input and output streams afterwards.

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

Buffer size when transferring streams

See Also:

Constant Field Values

MAX_TEXT_STREAM_SIZE

public static final int MAX_TEXT_STREAM_SIZE

Maximum size of characters we'll read from a text stream before complaining

See Also:

Constant Field Values

Constructor Detail

IOUtilities

public IOUtilities()

Method Detail

ensureDirectoryCreated

public static File ensureDirectoryCreated(File directory)
                                   throws IOException

Simple method to ensure that a given directory exists. If the directory does not exist then it is created, along with all required parents.

Throws:

IOException - if creation could not succeed for some reason.

ensureFileCreated

public static File ensureFileCreated(File file)
                              throws IOException

Simple method to ensure that a given File exists. If the File does not exist then it is created, along with all required parent directories.

Throws:

IOException - if creation could not succeed for some reason.

ensureClose

public static void ensureClose(Closeable... streams)
                        throws IOException

Ensures that as many of the given Closeables are closed. If any fail to close, the first Exception is thrown after an attempt has been made to close the rest.

For convenience, any number of the stream may be null, in which case they will be ignored.

Parameters:

streams - "streams" to close

Throws:

IOException

transfer

public static void transfer(InputStream inStream,
                            OutputStream outStream)
                     throws IOException

"Transfers" data from the given InputStream to the given OutputStream, closing both streams once the InputStream has been exhausted.

This will check to see if both streams are File streams and, if so, use the transfer(FileInputStream, FileOutputStream) version of this method instead.

Parameters:

inStream -

outStream -

Throws:

IOException

transfer

public static void transfer(FileInputStream fileInStream,
                            FileOutputStream fileOutStream)
                     throws IOException

Version of transfer(InputStream, OutputStream) for File streams that uses NIO to do a hopefully more efficient transfer.

Throws:

IOException

transfer

public static void transfer(InputStream inStream,
                            OutputStream outStream,
                            boolean closeOutputStream)
                     throws IOException

"Transfers" data from the given InputStream to the given OutputStream, closing the InputStream afterwards. If the parameter closeOutputStream is true then the OutputStream is closed too. If not, it will be flushed.

Parameters:

inStream -

outStream -

Throws:

IOException

transfer

public static void transfer(InputStream inStream,
                            OutputStream outStream,
                            boolean closeInputStream,
                            boolean closeOutputStream)
                     throws IOException

"Transfers" data from the given InputStream to the given OutputStream, optionally closing the given input and output streams afterwards.

Even if not closing the output stream, it will still be flushed.

Parameters:

inStream -

outStream -

Throws:

IOException

readCharacterStream

public static String readCharacterStream(Reader reader)
                                  throws IOException

Reads all character data from the given Reader, returning a String containing all of the data. The Reader will be buffered for efficiency and will be closed once finished with. Be careful reading in very large files - we will barf if MAX_FILE_SIZE is passed as a safety precaution.

Parameters:

reader - source of string data

Returns:

String representing the data read

Throws:

IOException

readUnicodeStream

public static String readUnicodeStream(InputStream in)
                                throws IOException

Same as readCharacterStream(Reader) but assumes the stream is encoded as UTF-8.

Parameters:

in - InputStream supplying character data

Returns:

String representing the data read in

Throws:

IOException

readUnicodeFile

public static String readUnicodeFile(File file)
                              throws IOException

Same as readUnicodeStream(InputStream) but accepts a plain File object for convenience

Parameters:

file - File to read from

Returns:

String representing the data we read in

Throws:

IOException