net.sf.mmm.util.io.base

Class StreamUtilImpl.BaseTransferrer<BUFFER>

java.lang.Object

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

net.sf.mmm.util.io.base.StreamUtilImpl.BaseTransferrer<BUFFER>

Type Parameters:

BUFFER - is the generic type of the buffers provided by getPool().

All Implemented Interfaces:

Callable<Long>, Stoppable

Direct Known Subclasses:

StreamUtilImpl.ReaderTransferrer, StreamUtilImpl.StreamTransferrer

Enclosing class:

StreamUtilImpl

protected abstract class StreamUtilImpl.BaseTransferrer<BUFFER>
extends StreamUtilImpl.AbstractAsyncTransferrer

This is an abstract implementation of the AsyncTransferrer interface, that implements Runnable defining the main flow.

Field Summary

Fields

Modifier and Type	Field and Description
private TransferCallback	callback The callback or null.
private boolean	keepDestinationOpen true if destination should be closed.

Constructor Summary

Constructors

Constructor and Description
BaseTransferrer(TransferCallback callback, boolean keepDestinationOpen) The constructor.

Method Summary

Modifier and Type	Method and Description
Long	call()
protected abstract Closeable	getDestination() This method gets the destination to transfer to.
protected abstract Pool<BUFFER>	getPool() This method gets the Pool to retrieve buffers.
protected abstract Closeable	getSource() This method gets the source to transfer.
protected long	transfer() This method performs the actual transfer.
protected abstract long	transfer(BUFFER buffer) This method performs the actual 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

callback

private final TransferCallback callback

The callback or null.

keepDestinationOpen

private final boolean keepDestinationOpen

true if destination should be closed.

Constructor Detail

BaseTransferrer

public BaseTransferrer(TransferCallback callback,
                       boolean keepDestinationOpen)

The constructor.

Parameters:

callback - is the callback or null.

keepDestinationOpen - true if the destination should be closed, false otherwise.

Method Detail

getSource

protected abstract Closeable getSource()

This method gets the source to transfer.

Returns:

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

getDestination

protected abstract Closeable getDestination()

This method gets the destination to transfer to.

Returns:

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

getPool

protected abstract Pool<BUFFER> getPool()

This method gets the Pool to retrieve buffers.

Returns:

the Pool.

transfer

protected abstract long transfer(BUFFER buffer)
                          throws IOException

This method performs the actual transfer.

Parameters:

buffer - is the buffer used for the transfer.

Returns:

the number of bytes that have been transferred.

Throws:

IOException - if the transfer failed.

transfer

protected long transfer()
                 throws RuntimeIoException

This method performs the actual transfer.

Returns:

the number of bytes that have been transferred.

Throws:

RuntimeIoException - if the transfer failed.

call

public Long call()
          throws Exception

Throws:

Exception