au.gov.nehta.common.utils

Class IOUtils

java.lang.Object

au.gov.nehta.common.utils.IOUtils

public final class IOUtils
extends Object

Utility class that common I/O functions.

Method Summary

Modifier and Type	Method and Description
static String	read(File inputFile) Reads the content of a file into a string.
static String	read(InputStream inputStream) Reads the content of a byte stream into a string.
static String	read(Reader reader) Reads the content of a character stream into a string.
static void	write(File outputFile, String contents) Writes text content to a file.
static void	write(OutputStream outputStream, String contents) Writes text content to a character stream.
static void	write(Writer writer, String contents) Writes text content to a byte stream.

Methods inherited from class java.lang.Object

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

Method Detail

read

public static String read(File inputFile)
                   throws IOException

Reads the content of a file into a string.

Parameters:

inputFile - File to read from. Cannot be null.

Returns:

Text content from the file.

Throws:

IOException - Thrown when the file cannot be found, or there are I/O errors reading from the file.

read

public static String read(InputStream inputStream)
                   throws IOException

Reads the content of a byte stream into a string. The byte stream will be closed after the contents are read.

Parameters:

inputStream - Byte stream to read from. Cannot be null.

Returns:

Text content from the byte stream.

Throws:

IOException - Thrown when there are I/O errors reading from the byte stream.

read

public static String read(Reader reader)
                   throws IOException

Reads the content of a character stream into a string. The character stream will be closed after the contents are read.

Parameters:

reader - Character stream to read from. Cannot be null.

Returns:

Text content from the character stream.

Throws:

IOException - Thrown when there are I/O errors reading from the character stream.

write

public static void write(File outputFile,
                         String contents)
                  throws IOException

Writes text content to a file.

Parameters:

outputFile - File to write to. Cannot be null.

contents - Text content to write to the file. Cannot be null nor a blank string.

Throws:

IOException - Thrown when there are I/O errors writing to the file.

write

public static void write(OutputStream outputStream,
                         String contents)
                  throws IOException

Writes text content to a character stream.

Parameters:

outputStream - Character stream to write to. Cannot be null.

contents - Text content to write to the character stream. Cannot be null nor a blank string.

Throws:

IOException - Thrown when there are I/O errors writing to the character stream.

write

public static void write(Writer writer,
                         String contents)
                  throws IOException

Writes text content to a byte stream.

Parameters:

writer - Byte stream to write to. Cannot be null.

contents - Text content to write to the byte stream. Cannot be null nor a blank string.

Throws:

IOException - Thrown when there are I/O errors writing to the byte stream.