Package com.sshtools.client.tasks

Class AbstractFileTask.AbstractFileTaskBuilder<B extends AbstractFileTask.AbstractFileTaskBuilder<B,T>,T extends AbstractConnectionTask>

java.lang.Object

com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder<B,T>

com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder<B,T>

Direct Known Subclasses:

AbstractOptimisedTask.AbstractOptimisedTaskBuilder, DownloadFileTask.DownloadFileTaskBuilder, DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder, StatTask.StatTaskBuilder, UploadFileContentTask.UploadFileContentTaskBuilder, UploadFileTask.UploadFileTaskBuilder, UploadInputStreamTask.UploadInputStreamTaskBuilder

Enclosing class:

AbstractFileTask

public abstract static class AbstractFileTask.AbstractFileTaskBuilder<B extends AbstractFileTask.AbstractFileTaskBuilder<B,T>,T extends AbstractConnectionTask>
extends AbstractConnectionTask.AbstractConnectionTaskBuilder<B,T>

Field Summary

Fields inherited from class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder

clientSupplier, connection

Constructor Summary

Constructors

Constructor	Description
AbstractFileTaskBuilder()

Method Summary

Modifier and Type	Method	Description
abstract T	build()
B	withProgress(FileTransferProgress progress)	Set a FileTransferProgress for the overall progress of the transfer.
B	withProgress(Optional<FileTransferProgress> progress)	Set a FileTransferProgress for the overall progress of the transfer.

Methods inherited from class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder

withClient, withClients, withConnection

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractFileTaskBuilder

public AbstractFileTaskBuilder()

Method Details

withProgress

public B withProgress(Optional<FileTransferProgress> progress)

Set a FileTransferProgress for the overall progress of the transfer. FileTransferProgress.started(long, String) may be called multiple times if multiple files are being transferred.

Parameters:

progress - overall progress monitor

Returns:

builder for chaining

withProgress

public B withProgress(FileTransferProgress progress)

Set a FileTransferProgress for the overall progress of the transfer. FileTransferProgress.started(long, String) may be called multiple times if multiple files are being transferred.

Parameters:

progress - overall progress monitor

Returns:

builder for chaining

build

public abstract T build()

Specified by:

build in class AbstractConnectionTask.AbstractConnectionTaskBuilder<B extends AbstractFileTask.AbstractFileTaskBuilder<B,T>,T extends AbstractConnectionTask>