TerminalBuilder (JLine 3.1.3 API)

java.lang.Object
- org.jline.terminal.TerminalBuilder

public final class TerminalBuilder
extends Object

Builder class to create terminals.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TerminalBuilder`	`attributes(Attributes attributes)` Attributes to use when creating a non system terminal, i.e.
`Terminal`	`build()`
`static TerminalBuilder`	`builder()` Creates a new terminal builder instance.
`TerminalBuilder`	`dumb(boolean dumb)`
`TerminalBuilder`	`encoding(String encoding)`
`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.
`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

- 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)
```
  - 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

Class TerminalBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

terminal

builder

name

streams

system

jna

dumb

type

encoding

attributes

size

nativeSignals

signalHandler

build