Package com.sshtools.synergy.ssh

Class TerminalModes.TerminalModesBuilder

java.lang.Object

com.sshtools.synergy.ssh.TerminalModes.TerminalModesBuilder

Enclosing class:

TerminalModes

public static final class TerminalModes.TerminalModesBuilder
extends Object

Builds TerminalModes.

You can reuse an instance of this class providing that you do not want to change any of the modes. If you do want to change modes you can call the reset method to clear out old modes.

Constructor Summary

Constructors

Constructor	Description
TerminalModesBuilder()

Method Summary

Modifier and Type	Method	Description
TerminalModes	build()	Build a new TerminalModes.
static TerminalModes.TerminalModesBuilder	create()	Create a new TerminalModes.TerminalModesBuilder
TerminalModes.TerminalModesBuilder	fromBytes(byte[] modes)
TerminalModes.TerminalModesBuilder	read(com.sshtools.common.util.ByteArrayReader reader)
TerminalModes.TerminalModesBuilder	reset()	Clear all modes set in this builder.
TerminalModes.TerminalModesBuilder	withMode(int mode)	Set a boolean>code> mode to true.

Methods inherited from class java.lang.Object

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

Constructor Details

TerminalModesBuilder

public TerminalModesBuilder()

Method Details

reset

public TerminalModes.TerminalModesBuilder reset()

Clear all modes set in this builder.

Returns:

this for chaining

withModes

public TerminalModes.TerminalModesBuilder withModes(TerminalModes.Mode... modes)

Set one or more modes to true, i.e. a value of 1.

Parameters:

modes - modes

Returns:

this for chaining

withoutModes

public TerminalModes.TerminalModesBuilder withoutModes(TerminalModes.Mode... modes)

Set one or more modes to false, i.e. a value of 0.

Parameters:

modes - modes

Returns:

this for chaining

withMode

public TerminalModes.TerminalModesBuilder withMode(int mode,
 boolean value)

Set a boolean mode.

Parameters:

mode - mode

value - value to set

Returns:

this for chaining

withMode

public TerminalModes.TerminalModesBuilder withMode(TerminalModes.Mode mode,
 boolean value)

Set a boolean mode.

Parameters:

mode - mode

value - value to set

Returns:

this for chaining

withMode

public TerminalModes.TerminalModesBuilder withMode(int mode,
 int value)

Set an integer mode.

Parameters:

mode - mode

value - value to set

Returns:

this for chaining

withMode

public TerminalModes.TerminalModesBuilder withMode(TerminalModes.Mode mode,
 int value)

Set an integer mode.

Parameters:

mode - mode

value - value to set

Returns:

this for chaining

withMode

public TerminalModes.TerminalModesBuilder withMode(int mode)

Set a boolean>code> mode to true.

Parameters:

mode - mode

Returns:

this for chaining

withoutMode

public TerminalModes.TerminalModesBuilder withoutMode(int mode)

Set a boolean>code> mode to false.

Parameters:

mode - mode

Returns:

this for chaining

create

public static TerminalModes.TerminalModesBuilder create()

Create a new TerminalModes.TerminalModesBuilder

Returns:

builder

build

public TerminalModes build()

Build a new TerminalModes.

Returns:

modes

Throws:

IOException

fromBytes

public TerminalModes.TerminalModesBuilder fromBytes(byte[] modes)

read

public TerminalModes.TerminalModesBuilder read(com.sshtools.common.util.ByteArrayReader reader)