org.pfsw.util

Class StreamCopy

java.lang.Object

org.pfsw.util.StreamCopy

public class StreamCopy
extends java.lang.Object

This class supports convenient stream copying.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_AUTO_FLUSH
static boolean	DEFAULT_CLOSE_AFTER_COPY

Constructor Summary

Constructors

Constructor and Description
StreamCopy()
StreamCopy(boolean closeStreamsAfterCopy)
StreamCopy(boolean closeStreamsAfterCopy, IProgressListener listener)
StreamCopy(int bufferSize)
StreamCopy(int bufferSize, boolean closeStreamsAfterCopy)
StreamCopy(int bufferSize, boolean closeStreamsAfterCopy, IProgressListener listener)
StreamCopy(int bufferSize, IProgressListener listener)
StreamCopy(IProgressListener listener)

Method Summary

Modifier and Type	Method and Description
long	copy(java.io.InputStream inStream, java.io.OutputStream outStream) Copies all data from the input stream to the output stream using a buffer of the underlying defined size in bytes.
long	copy(java.io.InputStream inStream, java.io.OutputStream outStream, java.lang.Long limit) Copies all data from the input stream to the output stream using a buffer of the underlying defined size in bytes.
static StreamCopy	create() Returns a new instance with default settings.
int	getBufferSize()
IProgressListener	getProgressListener()
protected IOUtil	ioUtil()
boolean	isAutoFlush()
boolean	isCloseStreamsAfterCopy()
StreamCopy	setAutoFlush(boolean autoFlush) Setting autoFlush to true means to flush the output stream after each write of a buffer chunk.
StreamCopy	setBufferSize(int bufferSize)
StreamCopy	setCloseStreamsAfterCopy(boolean closeStreamsAfterCopy)
StreamCopy	setProgressListener(IProgressListener listener)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLOSE_AFTER_COPY

public static boolean DEFAULT_CLOSE_AFTER_COPY

DEFAULT_AUTO_FLUSH

public static boolean DEFAULT_AUTO_FLUSH

Constructor Detail

StreamCopy

public StreamCopy()

StreamCopy

public StreamCopy(IProgressListener listener)

StreamCopy

public StreamCopy(int bufferSize)

StreamCopy

public StreamCopy(boolean closeStreamsAfterCopy)

StreamCopy

public StreamCopy(int bufferSize,
                  IProgressListener listener)

StreamCopy

public StreamCopy(boolean closeStreamsAfterCopy,
                  IProgressListener listener)

StreamCopy

public StreamCopy(int bufferSize,
                  boolean closeStreamsAfterCopy)

StreamCopy

public StreamCopy(int bufferSize,
                  boolean closeStreamsAfterCopy,
                  IProgressListener listener)

Method Detail

create

public static StreamCopy create()

Returns a new instance with default settings.

getBufferSize

public int getBufferSize()

setBufferSize

public StreamCopy setBufferSize(int bufferSize)

isCloseStreamsAfterCopy

public boolean isCloseStreamsAfterCopy()

setCloseStreamsAfterCopy

public StreamCopy setCloseStreamsAfterCopy(boolean closeStreamsAfterCopy)

getProgressListener

public IProgressListener getProgressListener()

setProgressListener

public StreamCopy setProgressListener(IProgressListener listener)

isAutoFlush

public boolean isAutoFlush()

setAutoFlush

public StreamCopy setAutoFlush(boolean autoFlush)

Setting autoFlush to true means to flush the output stream after each write of a buffer chunk.

copy

public long copy(java.io.InputStream inStream,
                 java.io.OutputStream outStream)
          throws java.io.IOException

Copies all data from the input stream to the output stream using a buffer of the underlying defined size in bytes.
Depending on the value of 'closeStreamsAfterCopy' the two streams will be closed at the end of this method execution.

Parameters:

inStream - The source stream.

outStream - The target stream.

Returns:

The number of bytes copied.

Throws:

java.io.IOException

copy

public long copy(java.io.InputStream inStream,
                 java.io.OutputStream outStream,
                 java.lang.Long limit)
          throws java.io.IOException

Copies all data from the input stream to the output stream using a buffer of the underlying defined size in bytes.
Depending on the value of 'closeStreamsAfterCopy' the two streams will be closed at the end of this method execution.

Parameters:

inStream - The source stream.

outStream - The target stream.

limit - The maximum number of bytes that will be copied. If exceeded an IOException will be thrown. Setting this parameter to null, zero or a negative value will specify no limit.

Returns:

The number of bytes copied.

Throws:

java.io.IOException

ioUtil

protected IOUtil ioUtil()