Package com.sshtools.client.tasks

Class AbstractConnectionTask.AbstractConnectionTaskBuilder<B extends AbstractConnectionTask.AbstractConnectionTaskBuilder<B,T>,T extends AbstractConnectionTask>

java.lang.Object

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

Direct Known Subclasses:

AbstractFileTask.AbstractFileTaskBuilder, AbstractSessionTask.AbstractSessionTaskBuilder

Enclosing class:

AbstractConnectionTask

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<Function<Integer,SshClient>>	clientSupplier
protected Optional<SshConnection>	connection

Constructor Summary

Constructors

Constructor	Description
AbstractConnectionTaskBuilder()

Method Summary

Modifier and Type	Method	Description
abstract T	build()
B	withClient(SshClient client)	Set a single SshClient to use.
B	withClients(Function<Integer,SshClient> clientSupplier)	Set a Function that supplies SshClient instances.
B	withConnection(SshConnection connection)	Set a single Connection to use.

Methods inherited from class java.lang.Object

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

Field Details

clientSupplier

protected Optional<Function<Integer,SshClient>> clientSupplier

connection

protected Optional<SshConnection> connection

Constructor Details

AbstractConnectionTaskBuilder

public AbstractConnectionTaskBuilder()

Method Details

withClient

public B withClient(SshClient client)

Set a single SshClient to use.

Parameters:

client - client

Returns:

builder for chaining

withConnection

public B withConnection(SshConnection connection)

Set a single Connection to use.

Parameters:

connection - connection

Returns:

builder for chaining

withClients

public B withClients(Function<Integer,SshClient> clientSupplier)

Set a Function that supplies SshClient instances. The function is provided with an index, with the control client being index 0, and subsequent clients having index of 1 up to to whatever #withChunks(int) was given (or the default of 3).

Parameters:

clientSupplier - supplier of clients

Returns:

builder for chaining

build

public abstract T build()