Package com.sshtools.client.tasks

Class DownloadFileTask.DownloadFileTaskBuilder

java.lang.Object

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

com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder<DownloadFileTask.DownloadFileTaskBuilder,DownloadFileTask>

com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder

Enclosing class:

DownloadFileTask

public static final class DownloadFileTask.DownloadFileTaskBuilder
extends AbstractFileTask.AbstractFileTaskBuilder<DownloadFileTask.DownloadFileTaskBuilder,DownloadFileTask>

Builder for DownloadFileTask.

Field Summary

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

clientSupplier, connection

Method Summary

Modifier and Type	Method	Description
DownloadFileTask	build()
static DownloadFileTask.DownloadFileTaskBuilder	create()	Create a new DownloadFileTask.DownloadFileTaskBuilder
DownloadFileTask.DownloadFileTaskBuilder	withLocal(Path file)	Set the local local to download to.
DownloadFileTask.DownloadFileTaskBuilder	withLocal(Optional<Path> file)	Set the local local to download to.
DownloadFileTask.DownloadFileTaskBuilder	withLocalFile(File file)	Set the local local to download to.
DownloadFileTask.DownloadFileTaskBuilder	withLocalFile(Optional<File> file)	Set the local local to download to.
DownloadFileTask.DownloadFileTaskBuilder	withRemote(Path remote)	Set the remote path of the local to download.
DownloadFileTask.DownloadFileTaskBuilder	withRemote(Optional<Path> remote)	Set the remote path of the local to download.
DownloadFileTask.DownloadFileTaskBuilder	withRemotePath(String remote)	Set the remote path of the local to download.
DownloadFileTask.DownloadFileTaskBuilder	withRemotePath(Optional<String> remote)	Set the remote path of the local to download.

Methods inherited from class com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder

withProgress, withProgress

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

Method Details

create

public static DownloadFileTask.DownloadFileTaskBuilder create()

Create a new DownloadFileTask.DownloadFileTaskBuilder

Returns:

builder

withLocalFile

public DownloadFileTask.DownloadFileTaskBuilder withLocalFile(Optional<File> file)

Set the local local to download to. If empty, will be download the current local working directory, with the same name as the remote local.

Parameters:

local - local

Returns:

builder for chaining

withLocal

public DownloadFileTask.DownloadFileTaskBuilder withLocal(Optional<Path> file)

Set the local local to download to. If empty, will be download the current local working directory, with the same name as the remote local.

Parameters:

local - local

Returns:

builder for chaining

withLocalFile

public DownloadFileTask.DownloadFileTaskBuilder withLocalFile(File file)

Set the local local to download to.

Parameters:

local - local

Returns:

builder for chaining

withLocal

public DownloadFileTask.DownloadFileTaskBuilder withLocal(Path file)

Set the local local to download to. If empty, will be download the current local working directory, with the same name as the remote local.

Parameters:

local - local

Returns:

builder for chaining

withRemotePath

public DownloadFileTask.DownloadFileTaskBuilder withRemotePath(Optional<String> remote)

Set the remote path of the local to download.

Parameters:

remote - remote path

Returns:

builder for chaining

withRemote

public DownloadFileTask.DownloadFileTaskBuilder withRemote(Path remote)

Set the remote path of the local to download.

Parameters:

remote - remote path

Returns:

builder for chaining

withRemote

public DownloadFileTask.DownloadFileTaskBuilder withRemote(Optional<Path> remote)

Set the remote path of the local to download.

Parameters:

remote - remote path

Returns:

builder for chaining

withRemotePath

public DownloadFileTask.DownloadFileTaskBuilder withRemotePath(String remote)

Set the remote path of the local to download.

Parameters:

remote - remote path

Returns:

builder for chaining

build

public DownloadFileTask build()

Specified by:

build in class AbstractFileTask.AbstractFileTaskBuilder<DownloadFileTask.DownloadFileTaskBuilder,DownloadFileTask>