net.sf.mmm.util.io.base

Class StreamUtilImpl.StreamTransferrer

java.lang.Object

net.sf.mmm.util.io.base.StreamUtilImpl.AbstractAsyncTransferrer

net.sf.mmm.util.io.base.StreamUtilImpl.BaseTransferrer<byte[]>

net.sf.mmm.util.io.base.StreamUtilImpl.StreamTransferrer

All Implemented Interfaces:

Callable<Long>, Stoppable

Enclosing class:

StreamUtilImpl

protected class StreamUtilImpl.StreamTransferrer
extends StreamUtilImpl.BaseTransferrer<byte[]>

This inner class is used to transfer an InputStream to an OutputStream.

Field Summary

Fields

Modifier and Type	Field and Description
private OutputStream	destination The destination to write to.
private InputStream	source The source to read from (to copy).

Constructor Summary

Constructors

Constructor and Description
StreamTransferrer(InputStream source, OutputStream destination, boolean keepDestinationOpen, TransferCallback callback) The constructor.

Method Summary

Modifier and Type	Method and Description
protected OutputStream	getDestination() This method gets the destination to transfer to.
protected Pool<byte[]>	getPool() This method gets the Pool to retrieve buffers.
protected InputStream	getSource() This method gets the source to transfer.
long	transfer(byte[] buffer) This method performs the actual transfer.

Methods inherited from class net.sf.mmm.util.io.base.StreamUtilImpl.BaseTransferrer

call, transfer

Methods inherited from class net.sf.mmm.util.io.base.StreamUtilImpl.AbstractAsyncTransferrer

isCompleted, isStopped, setCompleted, stop

Methods inherited from class java.lang.Object

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

Field Detail

source

private final InputStream source

The source to read from (to copy).

destination

private final OutputStream destination

The destination to write to.

Constructor Detail

StreamTransferrer

public StreamTransferrer(InputStream source,
                         OutputStream destination,
                         boolean keepDestinationOpen,
                         TransferCallback callback)

The constructor.

Parameters:

source - is InputStream to read from.

destination - the OutputStream to write to.

keepDestinationOpen - true if the destination should be closed.

callback - is the callback or null.

See Also:

StreamUtilImpl.transfer(InputStream, OutputStream, boolean)

Method Detail

getSource

protected InputStream getSource()

Description copied from class: StreamUtilImpl.BaseTransferrer

This method gets the source to transfer.

Specified by:

getSource in class StreamUtilImpl.BaseTransferrer<byte[]>

Returns:

the source (e.g. InputStream or Reader).

getDestination

protected OutputStream getDestination()

Description copied from class: StreamUtilImpl.BaseTransferrer

This method gets the destination to transfer to.

Specified by:

getDestination in class StreamUtilImpl.BaseTransferrer<byte[]>

Returns:

the destination (e.g. OutputStream or Writer).

getPool

protected Pool<byte[]> getPool()

Description copied from class: StreamUtilImpl.BaseTransferrer

This method gets the Pool to retrieve buffers.

Specified by:

getPool in class StreamUtilImpl.BaseTransferrer<byte[]>

Returns:

the Pool.

transfer

public long transfer(byte[] buffer)
              throws IOException

Description copied from class: StreamUtilImpl.BaseTransferrer

This method performs the actual transfer.

Specified by:

transfer in class StreamUtilImpl.BaseTransferrer<byte[]>

Parameters:

buffer - is the buffer used for the transfer.

Returns:

the number of bytes that have been transferred.

Throws:

IOException - if the transfer failed.