com.enterprisedt.net.ftp.async
Class TransferDirectoryResult

java.lang.Object
  com.enterprisedt.net.ftp.async.AsyncResult
      com.enterprisedt.net.ftp.async.TransferDirectoryResult

public class TransferDirectoryResult
extends AsyncResult

The result object from a file transfer operation.

Version:

$Revision: 1.3 $

Author:

Bruce Blackshaw

Field Summary

static int

DEFAULT_NOTIFY_INTERVAL

Constructor Summary

TransferDirectoryResult(java.lang.String localDirectory, java.lang.String remoteDirectory)
Constructor.

Method Summary

void	addFileProgressMonitor(AsyncEventListener monitor) Add a progress monitor for this transfer
void	endAsync() This method is called to complete the asynchronous operation.
java.lang.String	getLocalDirectory() Get the local directory name.
int	getMinTransferNotifyPeriod() Get the minimum period before a transfer callback.
java.lang.String	getRemoteDirectory() Get the remote directory name.

Methods inherited from class com.enterprisedt.net.ftp.async.AsyncResult

cancelTask, endAsyncCalled, endAsyncInternal, getClient, getLocalContext, getTag, getTask, getTaskDescription, getTaskId, getThrowable, isCompleted, isSuccessful, notifyComplete, setAsIfCompleted, setClient, setEndAsyncCalled, setLocalContext, setSuccessful, setTag, setTask, setThrowable, waitTillComplete

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NOTIFY_INTERVAL

public static final int DEFAULT_NOTIFY_INTERVAL

See Also:

Constant Field Values

Constructor Detail

TransferDirectoryResult

public TransferDirectoryResult(java.lang.String localDirectory,
                               java.lang.String remoteDirectory)

Constructor.

Parameters:

localDirectory - local directory name

remoteDirectory - remote directory name

Method Detail

endAsync

public void endAsync()
              throws java.io.IOException,
                     FTPException

This method is called to complete the asynchronous operation. The same exceptions will be thrown as if the operation was performed synchronously.

Throws:

java.io.IOException

FTPException

getLocalDirectory

public java.lang.String getLocalDirectory()

Get the local directory name.

Returns:

the local directory name

getRemoteDirectory

public java.lang.String getRemoteDirectory()

Get the remote directory name.

Returns:

the remote directory name

getMinTransferNotifyPeriod

public int getMinTransferNotifyPeriod()

Get the minimum period before a transfer callback.

Returns:

the minimum notify period (milliseconds).

addFileProgressMonitor

public void addFileProgressMonitor(AsyncEventListener monitor)

Add a progress monitor for this transfer

Parameters:

monitor - progress monitor