Package com.sshtools.client.tasks

Class DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder

java.lang.Object

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

com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder<DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder,DownloadOutputStreamTask>

com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder

Enclosing class:

DownloadOutputStreamTask

public static final class DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder
extends AbstractFileTask.AbstractFileTaskBuilder<DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder,DownloadOutputStreamTask>

Builder for DownloadOutputStreamTask.

Field Summary

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

clientSupplier, connection

Method Summary

Modifier and Type	Method	Description
DownloadOutputStreamTask	build()
static DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder	create()	Create a new DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder
DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder	withOutputStream(OutputStream outputStream)	Set the output stream to download to.
DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder	withOutputStream(Optional<OutputStream> outputStream)	Set the output stream to download to.
DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder	withRemote(Path remote)	Set the remote remote of the local to download.
DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder	withRemote(Optional<Path> remote)	Set the remote remote of the local to download.
DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder	withRemotePath(String remote)	Set the remote remote of the local to download.
DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder	withRemotePath(Optional<String> remote)	Set the remote remote 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 DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder create()

Create a new DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder

Returns:

builder

withOutputStream

public DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder withOutputStream(Optional<OutputStream> outputStream)

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

Parameters:

file - file

Returns:

builder for chaining

withOutputStream

public DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder withOutputStream(OutputStream outputStream)

Set the output stream to download to.

Parameters:

file - file

Returns:

builder for chaining

withRemotePath

public DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder withRemotePath(Optional<String> remote)

Set the remote remote of the local to download.

Parameters:

remote - remote remote

Returns:

builder for chaining

withRemote

public DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder withRemote(Path remote)

Set the remote remote of the local to download.

Parameters:

remote - remote remote

Returns:

builder for chaining

withRemote

public DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder withRemote(Optional<Path> remote)

Set the remote remote of the local to download.

Parameters:

remote - remote remote

Returns:

builder for chaining

withRemotePath

public DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder withRemotePath(String remote)

Set the remote remote of the local to download.

Parameters:

remote - remote remote

Returns:

builder for chaining

build

public DownloadOutputStreamTask build()

Specified by:

build in class AbstractFileTask.AbstractFileTaskBuilder<DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder,DownloadOutputStreamTask>