com.enterprisedt.net.ftp.async
Class RemoteFileResult

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

Direct Known Subclasses:

DeleteFileResult, DownloadByteArrayResult, ExistsResult, ModifiedTimeResult, SizeResult, TransferFileResult, UploadByteArrayResult

public class RemoteFileResult
extends AsyncResult

Base class for result classes that deal with remote files.

Version:

$Revision$

Author:

Bruce Blackshaw

Field Summary

protected boolean	cancelled
static int	DEFAULT_NOTIFY_INTERVAL
protected java.lang.String	remoteFileName

Constructor Summary

RemoteFileResult(java.lang.String remoteFileName)
Constructor

Method Summary

void	addProgressMonitor(AsyncEventListener monitor) Add a progress monitor for this transfer
int	getMinTransferNotifyPeriod() Get the minimum period before a transfer callback.
int	getNotifyInterval() Get the interval used for progress notification of transfers.
java.lang.String	getRemoteFileName() Get the remote file's name
boolean	isCancelled()
void	setMinTransferNotifyPeriod(int minTransferNotifyPeriod) Set the minimum period before a transfer callback.
void	setNotifyInterval(int notifyInterval) Set the interval used for progress notification of transfers.

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

remoteFileName

protected java.lang.String remoteFileName

cancelled

protected boolean cancelled

Constructor Detail

RemoteFileResult

public RemoteFileResult(java.lang.String remoteFileName)

Constructor

Parameters:

remoteFileName - the remote file's name

Method Detail

getRemoteFileName

public java.lang.String getRemoteFileName()

Get the remote file's name

Returns:

file name

isCancelled

public boolean isCancelled()

addProgressMonitor

public void addProgressMonitor(AsyncEventListener monitor)

Add a progress monitor for this transfer

Parameters:

monitor - progress monitor

getNotifyInterval

public int getNotifyInterval()

Get the interval used for progress notification of transfers.

Returns:

number of bytes between each notification.

setNotifyInterval

public void setNotifyInterval(int notifyInterval)

Set the interval used for progress notification of transfers.

Parameters:

notifyInterval - number of bytes between each notification.

getMinTransferNotifyPeriod

public int getMinTransferNotifyPeriod()

Get the minimum period before a transfer callback.

Returns:

the minimum notify period (milliseconds).

setMinTransferNotifyPeriod

public void setMinTransferNotifyPeriod(int minTransferNotifyPeriod)

Set the minimum period before a transfer callback.

Parameters:

minTransferNotifyPeriod - the minimum notify period (milliseconds).