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 TypeMethodDescriptionbuild()
create()
Create a newDownloadFileTask.DownloadFileTaskBuilder
Set the local local to download to.Set the local local to download to.withLocalFile
(File file) Set the local local to download to.withLocalFile
(Optional<File> file) Set the local local to download to.withRemote
(Path remote) Set the remote path of the local to download.withRemote
(Optional<Path> remote) Set the remote path of the local to download.withRemotePath
(String remote) Set the remote path of the local to download.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
-
Method Details
-
create
Create a newDownloadFileTask.DownloadFileTaskBuilder
- Returns:
- builder
-
withLocalFile
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
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
Set the local local to download to.- Parameters:
local
- local- Returns:
- builder for chaining
-
withLocal
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
Set the remote path of the local to download.- Parameters:
remote
- remote path- Returns:
- builder for chaining
-
withRemote
Set the remote path of the local to download.- Parameters:
remote
- remote path- Returns:
- builder for chaining
-
withRemote
Set the remote path of the local to download.- Parameters:
remote
- remote path- Returns:
- builder for chaining
-
withRemotePath
Set the remote path of the local to download.- Parameters:
remote
- remote path- Returns:
- builder for chaining
-
build
- Specified by:
build
in classAbstractFileTask.AbstractFileTaskBuilder<DownloadFileTask.DownloadFileTaskBuilder,
DownloadFileTask>
-