Package com.sshtools.client.tasks

Class UploadFileTask.UploadFileTaskBuilder

java.lang.Object

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

com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder<UploadFileTask.UploadFileTaskBuilder,UploadFileTask>

com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder

Enclosing class:

UploadFileTask

public static final class UploadFileTask.UploadFileTaskBuilder
extends AbstractFileTask.AbstractFileTaskBuilder<UploadFileTask.UploadFileTaskBuilder,UploadFileTask>

Builder for UploadFileTask.

Field Summary

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

clientSupplier, connection

Method Summary

Modifier and Type	Method	Description
UploadFileTask	build()
static UploadFileTask.UploadFileTaskBuilder	create()	Create a new UploadFileTask.UploadFileTaskBuilder
UploadFileTask.UploadFileTaskBuilder	withLocal(Path path)	Set the local file to upload.
UploadFileTask.UploadFileTaskBuilder	withLocalFile(File file)	Set the local file to upload.
UploadFileTask.UploadFileTaskBuilder	withRemote(Path remote)	Set the remote path to upload the file to.
UploadFileTask.UploadFileTaskBuilder	withRemote(Optional<Path> remmote)	Set the remote path to upload the file to.
UploadFileTask.UploadFileTaskBuilder	withRemotePath(String remote)	Set the remote path to upload the file to.
UploadFileTask.UploadFileTaskBuilder	withRemotePath(Optional<String> remote)	Set the remote path to upload the file to.

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 UploadFileTask.UploadFileTaskBuilder create()

Create a new UploadFileTask.UploadFileTaskBuilder

Returns:

builder

withRemotePath

public UploadFileTask.UploadFileTaskBuilder withRemotePath(Optional<String> remote)

Set the remote path to upload the file to. If empty, will be uploaded the current remote working directory

Parameters:

remote - path

Returns:

builder for chaining

withRemote

public UploadFileTask.UploadFileTaskBuilder withRemote(Path remote)

Set the remote path to upload the file to. If empty, will be uploaded the current remote working directory

Parameters:

remote - remote path

Returns:

builder for chaining

withRemote

public UploadFileTask.UploadFileTaskBuilder withRemote(Optional<Path> remmote)

Set the remote path to upload the file to. If empty, will be uploaded the current remote working directory

Parameters:

remmote - remote path

Returns:

builder for chaining

withRemotePath

public UploadFileTask.UploadFileTaskBuilder withRemotePath(String remote)

Set the remote path to upload the file to. If empty, will be uploaded the current remote working directory

Parameters:

remote - remote path

Returns:

builder for chaining

withLocalFile

public UploadFileTask.UploadFileTaskBuilder withLocalFile(File file)

Set the local file to upload. This is required.

Parameters:

path - path

Returns:

builder for chaining

withLocal

public UploadFileTask.UploadFileTaskBuilder withLocal(Path path)

Set the local file to upload. This is required.

Parameters:

path - path

Returns:

builder for chaining

build

public UploadFileTask build()

Specified by:

build in class AbstractFileTask.AbstractFileTaskBuilder<UploadFileTask.UploadFileTaskBuilder,UploadFileTask>