org.jline.terminal

Class TerminalBuilder

java.lang.Object

org.jline.terminal.TerminalBuilder

public final class TerminalBuilder
extends Object

Builder class to create terminals.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_DUMB
static String	PROP_ENCODING
static String	PROP_EXEC
static String	PROP_JANSI
static String	PROP_JNA
static String	PROP_TYPE

Method Summary

Modifier and Type	Method and Description
TerminalBuilder	attributes(Attributes attributes) Attributes to use when creating a non system terminal, i.e. when the builder has been given the input and outut streams using the streams(InputStream, OutputStream) method or when system(boolean) has been explicitely called with false.
Terminal	build()
static TerminalBuilder	builder() Creates a new terminal builder instance.
TerminalBuilder	dumb(boolean dumb)
TerminalBuilder	encoding(String encoding)
TerminalBuilder	exec(boolean exec)
TerminalBuilder	jansi(boolean jansi)
TerminalBuilder	jna(boolean jna)
TerminalBuilder	name(String name)
TerminalBuilder	nativeSignals(boolean nativeSignals)
TerminalBuilder	signalHandler(Terminal.SignalHandler signalHandler)
TerminalBuilder	size(Size size) Initial size to use when creating a non system terminal, i.e. when the builder has been given the input and outut streams using the streams(InputStream, OutputStream) method or when system(boolean) has been explicitely called with false.
TerminalBuilder	streams(InputStream in, OutputStream out)
TerminalBuilder	system(boolean system)
static Terminal	terminal() Returns the default system terminal.
TerminalBuilder	type(String type)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_ENCODING

public static final String PROP_ENCODING

See Also:

Constant Field Values

PROP_TYPE

public static final String PROP_TYPE

See Also:

Constant Field Values

PROP_JNA

public static final String PROP_JNA

See Also:

Constant Field Values

PROP_JANSI

public static final String PROP_JANSI

See Also:

Constant Field Values

PROP_EXEC

public static final String PROP_EXEC

See Also:

Constant Field Values

PROP_DUMB

public static final String PROP_DUMB

See Also:

Constant Field Values

Method Detail

terminal

public static Terminal terminal()
                         throws IOException

Returns the default system terminal. Terminals should be closed properly using the Closeable.close() method in order to restore the original terminal state. This call is equivalent to: builder().build()

Throws:

IOException

builder

public static TerminalBuilder builder()

Creates a new terminal builder instance.

name

public TerminalBuilder name(String name)

streams

public TerminalBuilder streams(InputStream in,
                               OutputStream out)

system

public TerminalBuilder system(boolean system)

jna

public TerminalBuilder jna(boolean jna)

jansi

public TerminalBuilder jansi(boolean jansi)

exec

public TerminalBuilder exec(boolean exec)

dumb

public TerminalBuilder dumb(boolean dumb)

type

public TerminalBuilder type(String type)

encoding

public TerminalBuilder encoding(String encoding)

attributes

public TerminalBuilder attributes(Attributes attributes)

Attributes to use when creating a non system terminal, i.e. when the builder has been given the input and outut streams using the streams(InputStream, OutputStream) method or when system(boolean) has been explicitely called with false.

See Also:

size(Size), system(boolean)

size

public TerminalBuilder size(Size size)

Initial size to use when creating a non system terminal, i.e. when the builder has been given the input and outut streams using the streams(InputStream, OutputStream) method or when system(boolean) has been explicitely called with false.

See Also:

attributes(Attributes), system(boolean)

nativeSignals

public TerminalBuilder nativeSignals(boolean nativeSignals)

signalHandler

public TerminalBuilder signalHandler(Terminal.SignalHandler signalHandler)

build

public Terminal build()
               throws IOException

Throws:

IOException