Class SSHAttributesBuilder

java.lang.Object

org.aesh.terminal.ssh.SSHAttributesBuilder

public class SSHAttributesBuilder
extends Object

Builder for creating terminal Attributes from an SSH environment.

Author:

Ståle W. Pedersen

Method Summary

Modifier and Type	Method	Description
Attributes	build()	Builds the terminal Attributes from the configured SSH environment.
static SSHAttributesBuilder	builder()	Creates a new SSHAttributesBuilder instance.
SSHAttributesBuilder	environment(org.apache.sshd.server.Environment environment)	Sets the SSH environment to read PTY modes from.

Methods inherited from class Object

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

Method Details

builder

public static SSHAttributesBuilder builder()

Creates a new SSHAttributesBuilder instance.

Returns:

a new builder instance

environment

public SSHAttributesBuilder environment(org.apache.sshd.server.Environment environment)

Sets the SSH environment to read PTY modes from.

Parameters:

environment - the SSH environment

Returns:

this builder for method chaining

build

public Attributes build()

Builds the terminal Attributes from the configured SSH environment. Maps SSH PTY modes to terminal control characters and flags.

Returns:

the configured Attributes instance