iaik.utils

Class StreamCopier

java.lang.Object

iaik.utils.StreamCopier

All Implemented Interfaces:

java.lang.Runnable

public class StreamCopier
extends java.lang.Object
implements java.lang.Runnable

This utility class copies all data from an InputStream to an OutputStream.

Version:

File Revision 13

Constructor Summary

Constructors

Constructor and Description
StreamCopier(java.io.InputStream inStream, boolean closeIn, java.io.OutputStream outStream, boolean closeOut) Creates a StreamCopier that reads from inStream and writes to outStream.
StreamCopier(java.io.InputStream inStream, java.io.OutputStream outStream) Creates a StreamCopier that reads from inStream and writes to outStream.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyStream() Start the copying.
java.io.IOException	getException() Get the IOException that occured during copying (if any).
boolean	isActive() Check whether the copier is already finished.
void	run() Run method to allow the StreamCopier to be run in a separate Thread easily.
void	setCloseIn(boolean closeIn) Set whether the InputStream shall be closed after copying.
void	setCloseOut(boolean closeOut) Set whether the OutputStream shall be closed after copying.
void	waitFinished() Wait for the StreamCopier to finish.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamCopier

public StreamCopier(java.io.InputStream inStream,
            java.io.OutputStream outStream)

Creates a StreamCopier that reads from inStream and writes to outStream. The streams are not closed after copying.

StreamCopier

public StreamCopier(java.io.InputStream inStream,
            boolean closeIn,
            java.io.OutputStream outStream,
            boolean closeOut)

Creates a StreamCopier that reads from inStream and writes to outStream. The closeIn and closeOut parameters indicate if the streams are to be closed after copying.

Method Detail

setCloseIn

public void setCloseIn(boolean closeIn)

Set whether the InputStream shall be closed after copying.

setCloseOut

public void setCloseOut(boolean closeOut)

Set whether the OutputStream shall be closed after copying.

isActive

public boolean isActive()

Check whether the copier is already finished. This will return true until the stream has been completely copied.

copyStream

public void copyStream()
                throws java.io.IOException

Start the copying. This method will read data from the InputStream and write it to the OutputStream until the end of the InputStream ( read() returns -1) or until an Exception occurs. If an IOException occurs, this method will still continue and close the stream, etc., but the Exception will be remembered and thrown at the end of the method (only EOFExceptions are not thrown, as they may occur in normal operations). If a Thread is waiting for the copy to finish (see waitFinished()) it will be awaken when copying is done.

Throws:

java.io.IOException

waitFinished

public void waitFinished()

Wait for the StreamCopier to finish. If the StreamCopier is running in a separate Thread, you can use this method to wait until the StreamCopier is finished. The current Thread will be suspended for the meantime. If the copier is no longer active, this method will return immediately.

run

public void run()

Run method to allow the StreamCopier to be run in a separate Thread easily. This method just calls copyStream() and ignores Exceptions.

Specified by:

run in interface java.lang.Runnable

getException

public java.io.IOException getException()

Get the IOException that occured during copying (if any). If no exception occured, we return null. This will always only return the first exception that occured, if more than one occured the further ones will be lost.