Package com.enterprisedt.net.ftp.async

Class TransferFileResult

java.lang.Object

com.enterprisedt.net.ftp.async.AsyncResult

com.enterprisedt.net.ftp.async.RemoteTransferResult

com.enterprisedt.net.ftp.async.RemoteFileResult

com.enterprisedt.net.ftp.async.TransferFileResult

Direct Known Subclasses:

DownloadFileResult, DownloadStreamResult, UploadFileResult, UploadStreamResult

public class TransferFileResult
extends RemoteFileResult

The result object from a file transfer operation.

Version:

$Revision$

Author:

Bruce Blackshaw

Field Summary

Fields inherited from class com.enterprisedt.net.ftp.async.RemoteFileResult

cancelled, remoteFileName

Fields inherited from class com.enterprisedt.net.ftp.async.RemoteTransferResult

DEFAULT_NOTIFY_INTERVAL

Constructor Summary

Constructors

Constructor	Description
TransferFileResult(String localFileName, String remoteFileName, WriteMode writeMode)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	endAsync()	This method is called to complete the asynchronous operation.
String	getLocalFileName()	Get the local file name.
WriteMode	getWriteMode()	What write mode is this operation?

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

addProgressMonitor, getRemoteFileName, isCancelled

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

getMinTransferNotifyPeriod, getNotifyInterval, setMinTransferNotifyPeriod, setNotifyInterval

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

Constructor Details

TransferFileResult

public TransferFileResult(String localFileName,
 String remoteFileName,
 WriteMode writeMode)

Constructor.

Parameters:

localFileName - local file's name

remoteFileName - remote file's name

append - true if appending to remote file

Method Details

getWriteMode

public WriteMode getWriteMode()

What write mode is this operation?

Returns:

FTPWriteMode

getLocalFileName

public String getLocalFileName()

Get the local file name.

Returns:

the local file name, or null if no local file.

endAsync

public void endAsync()
              throws 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:

IOException

FTPException