unlimited.fc.client.api.multiclient.transferJob

Class DownloadJob

java.lang.Object

unlimited.fc.client.api.multiclient.transferJob.TransferJob

unlimited.fc.client.api.multiclient.transferJob.TransferJob.FileTypeJob<T>

unlimited.fc.client.api.multiclient.transferJob.ListJob<FileListDataItem>

unlimited.fc.client.api.multiclient.transferJob.DownloadJob

All Implemented Interfaces:

java.lang.Comparable<TransferJob>

Direct Known Subclasses:

DownloadArchiveJob

public class DownloadJob
extends ListJob<FileListDataItem>

The Class DownloadJob.

Nested Class Summary

Nested classes/interfaces inherited from class unlimited.fc.client.api.multiclient.transferJob.ListJob

ListJob.FilterStreamData

Nested classes/interfaces inherited from class unlimited.fc.client.api.multiclient.transferJob.TransferJob

TransferJob.FileNameHandler, TransferJob.FileTypeHandler, TransferJob.FileTypeJob<T>, TransferJob.JobRepeateRemover

Field Summary

Fields inherited from class unlimited.fc.client.api.multiclient.transferJob.ListJob

defaultArchivingCompressionData, fzu, lastUpdateToSize, mainTransferCompressionData, needsRecurse, size, sizeInBytes

Fields inherited from class unlimited.fc.client.api.multiclient.transferJob.TransferJob.FileTypeJob

directories

Fields inherited from class unlimited.fc.client.api.multiclient.transferJob.TransferJob

destination, directoryCount, jobFailureReason, repeatRemover, transferUniqueID

Constructor Summary

Constructors

Constructor and Description
DownloadJob(java.util.List<FileListDataItem> files, java.lang.String remoteFilename, java.lang.String transferUniqueID, boolean needsRecurse, boolean isProgressive) Instantiates a new download job.
DownloadJob(java.util.Set<FileListDataItem> files, java.lang.String remoteFilename, java.lang.String transferUniqueID, boolean needsRecurse, boolean isProgressive)
DownloadJob(TransferJob.FileTypeJob<FileListDataItem> parent)

Method Summary

Modifier and Type	Method and Description
TransferAsJob<FileListDataItem>	getAsJobEquivalent(FileListDataItem aFile, java.lang.String currentWorkingDirectory) Returns the TransferAs job equivalent of this job.
protected long	getFileSize(java.util.Set<FileListDataItem> list) Returns the combined file size for the Set provided.
void	getHandledBy(JobHandler handler, FileTransferMechanism client) Gets the handled by.
FileListData	getNewListInstance() Returns a new List instance for the generic type that this class is
java.util.Set<FileListDataItem>	getNewSetInstance() Returns a new Set instance for the job.
protected TransferJob	getNextJob() Gets the next job.
unlimited.fc.client.api.multiclient.transferJob.ZipJob	getPendingZipJob(CompressionData defaultArchivingCompressionData, CompressionData mainTransferCompressionData) Gets the pending zip job.
protected boolean	instanceOf(TransferJob job) Returns whether or not the supplied TransferJob is and instance of this TransferJob
boolean	isUpload() Returns whether or not this job is an upload job or a download job

Methods inherited from class unlimited.fc.client.api.multiclient.transferJob.ListJob

addJob, addSizes, addSizes, addWork, applyFilter, applyFilterHandler, clear, countDirectories, decrementDirectory, getFiles, getFileSetCopy, getFilesSet, getJobSizeInBytes, getNewFilterStreamData, getNextJobSizeInBytes, getNextList, incrementDirectoryCount, isNeedsRecurse, needsSplit, removeCachedWork, removeDuplicates, removeFile, removeNextFile, removeRepeatFilesFrom, removeSizes, removeSizes, removeWork, setNeedsRecurse, size, startAsynchSizeUpdating, stillHasWork, stopSizeUpdating, stream, toString, updateSizeInBytes, useAutoArchiveSettings

Methods inherited from class unlimited.fc.client.api.multiclient.transferJob.TransferJob.FileTypeJob

directories, getUUIDForFile, normalizeDestination

Methods inherited from class unlimited.fc.client.api.multiclient.transferJob.TransferJob

applyFilter, buildListJob, compareTo, getClientID, getClone, getDestination, getDisplayName, getEmptyClone, getFailureReason, getNumOfRetries, getPriority, getTransferUniqueID, getUUID, hasFiles, isFlaggedForDelta, isLastJobInQueue, isProgressive, removeRepeatWorkFrom, resetFlagForDelta, retried, setClientID, setFailureReason, setIsLastJobInQueue, setPriority, setProgressive, similarJobTo

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadJob

public DownloadJob(TransferJob.FileTypeJob<FileListDataItem> parent)

DownloadJob

public DownloadJob(java.util.List<FileListDataItem> files,
                   java.lang.String remoteFilename,
                   java.lang.String transferUniqueID,
                   boolean needsRecurse,
                   boolean isProgressive)

Instantiates a new download job.

Parameters:

files - the files

remoteFilename - the remote filename

transferUniqueID - the transfer unique id

needsRecurse - the needs recurse

DownloadJob

public DownloadJob(java.util.Set<FileListDataItem> files,
                   java.lang.String remoteFilename,
                   java.lang.String transferUniqueID,
                   boolean needsRecurse,
                   boolean isProgressive)

Method Detail

getHandledBy

public void getHandledBy(JobHandler handler,
                         FileTransferMechanism client)

Description copied from class: TransferJob

Gets the handled by.

Specified by:

getHandledBy in class TransferJob

Parameters:

handler - the handler

client - the client

getPendingZipJob

public unlimited.fc.client.api.multiclient.transferJob.ZipJob getPendingZipJob(CompressionData defaultArchivingCompressionData,
                                                                               CompressionData mainTransferCompressionData)

Description copied from class: TransferJob

Gets the pending zip job.

Specified by:

getPendingZipJob in class TransferJob

Parameters:

defaultArchivingCompressionData - the default archiving compression data

mainTransferCompressionData - the main transfer compression data

Returns:

the pending zip job

getNextJob

protected TransferJob getNextJob()

Description copied from class: TransferJob

Gets the next job.

Overrides:

getNextJob in class TransferJob

Returns:

the next job

getFileSize

protected long getFileSize(java.util.Set<FileListDataItem> list)

Description copied from class: ListJob

Returns the combined file size for the Set provided.

Specified by:

getFileSize in class ListJob<FileListDataItem>

Parameters:

list - Files to check for size

Returns:

Total combined size of the files

getNewSetInstance

public java.util.Set<FileListDataItem> getNewSetInstance()

Description copied from class: ListJob

Returns a new Set instance for the job.

Specified by:

getNewSetInstance in class ListJob<FileListDataItem>

Returns:

instanceOf

protected boolean instanceOf(TransferJob job)

Description copied from class: TransferJob

Returns whether or not the supplied TransferJob is and instance of this TransferJob

Overrides:

instanceOf in class TransferJob

Parameters:

job - Job to check for

Returns:

true if instance, false if not

getNewListInstance

public FileListData getNewListInstance()

Description copied from class: TransferJob.FileTypeJob

Returns a new List instance for the generic type that this class is

Specified by:

getNewListInstance in class ListJob<FileListDataItem>

Returns:

getAsJobEquivalent

public TransferAsJob<FileListDataItem> getAsJobEquivalent(FileListDataItem aFile,
                                                          java.lang.String currentWorkingDirectory)

Description copied from class: TransferJob.FileTypeJob

Returns the TransferAs job equivalent of this job. Examples: UploadJobs will return UploadAsJobs, and DownloadJobs will return DownloadAsJobs

Specified by:

getAsJobEquivalent in class TransferJob.FileTypeJob<FileListDataItem>

Returns:

isUpload

public boolean isUpload()

Description copied from class: TransferJob

Returns whether or not this job is an upload job or a download job

Specified by:

isUpload in class TransferJob

Returns: