Class IOUtils

java.lang.Object

com.blackrook.gloop.openal.struct.IOUtils

public final class IOUtils
extends Object

Simple IO utility functions.

Author:

Matthew Tropiano

Method Summary

Modifier and Type	Method	Description
static void	close(Closeable c)	Attempts to close a Closeable object.
static void	close(AutoCloseable c)	Attempts to close an AutoCloseable object.
static byte[]	getBinaryContents(InputStream in)	Retrieves the binary contents of a stream until it hits the end of the stream.
static int	relay(InputStream in, OutputStream out, int bufferSize)	Reads from an input stream, reading in a consistent set of data and writing it to the output stream.
static int	relay(InputStream in, OutputStream out, int bufferSize, int maxLength)	Reads from an input stream, reading in a consistent set of data and writing it to the output stream.

Methods inherited from class Object

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

Method Details

getBinaryContents

public static byte[] getBinaryContents(InputStream in)
                                throws IOException

Retrieves the binary contents of a stream until it hits the end of the stream.

Parameters:

in - the input stream to use.

Returns:

an array of len bytes that make up the data in the stream.

Throws:

IOException - if the read cannot be done.

relay

public static int relay(InputStream in,
 OutputStream out,
 int bufferSize)
                 throws IOException

Reads from an input stream, reading in a consistent set of data and writing it to the output stream. The read/write is buffered so that it does not bog down the OS's other I/O requests. This method finishes when the end of the source stream is reached. Note that this may block if the input stream is a type of stream that will block if the input stream blocks for additional input. This method is thread-safe.

Parameters:

in - the input stream to grab data from.

out - the output stream to write the data to.

bufferSize - the buffer size for the I/O. Must be > 0.

Returns:

the total amount of bytes relayed.

Throws:

IOException - if a read or write error occurs.

relay

public static int relay(InputStream in,
 OutputStream out,
 int bufferSize,
 int maxLength)
                 throws IOException

Reads from an input stream, reading in a consistent set of data and writing it to the output stream. The read/write is buffered so that it does not bog down the OS's other I/O requests. This method finishes when the end of the source stream is reached. Note that this may block if the input stream is a type of stream that will block if the input stream blocks for additional input. This method is thread-safe.

Parameters:

in - the input stream to grab data from.

out - the output stream to write the data to.

bufferSize - the buffer size for the I/O. Must be > 0.

maxLength - the maximum amount of bytes to relay, or a value < 0 for no max.

Returns:

the total amount of bytes relayed.

Throws:

IOException - if a read or write error occurs.

close

public static void close(Closeable c)

Attempts to close a Closeable object. If the object is null, this does nothing.

Parameters:

c - the reference to the closeable object.

close

public static void close(AutoCloseable c)

Attempts to close an AutoCloseable object. If the object is null, this does nothing.

Parameters:

c - the reference to the AutoCloseable object.