Terminal (JLine Terminal 3.8.1 API)

All Superinterfaces:

AutoCloseable, Closeable, Flushable

All Known Implementing Classes:

AbstractPosixTerminal, AbstractTerminal, AbstractWindowsTerminal, DumbTerminal, ExternalTerminal, LineDisciplineTerminal, PosixPtyTerminal, PosixSysTerminal
```
public interface Terminal
extends Closeable, Flushable
```
A terminal representing a virtual terminal on the computer. Terminals should be closed by calling the Closeable.close() method in order to restore their original state.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Terminal.MouseTracking

static class Terminal.Signal

static interface Terminal.SignalHandler

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Terminal.MouseTracking`
`static class`	`Terminal.Signal`
`static interface`	`Terminal.SignalHandler`

Field Summary

Fields
Modifier and Type Field and Description

static String TYPE_DUMB
Type used for dumb terminals.

static String TYPE_DUMB_COLOR

Fields
Modifier and Type	Field and Description
`static String`	`TYPE_DUMB` Type used for dumb terminals.
`static String`	`TYPE_DUMB_COLOR`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`canPauseResume()` Whether this terminal supports `pause()` and `resume()` calls.
`boolean`	`echo()`
`boolean`	`echo(boolean echo)`
`Charset`	`encoding()` Returns the `Charset` that should be used to encode characters for `input()` and `output()`.
`Attributes`	`enterRawMode()`
`void`	`flush()`
`Attributes`	`getAttributes()`
`boolean`	`getBooleanCapability(InfoCmp.Capability capability)`
`Cursor`	`getCursorPosition(IntConsumer discarded)` Query the terminal to report the cursor position.
`default int`	`getHeight()`
`String`	`getName()`
`Integer`	`getNumericCapability(InfoCmp.Capability capability)`
`Size`	`getSize()`
`String`	`getStringCapability(InfoCmp.Capability capability)`
`String`	`getType()`
`default int`	`getWidth()`
`Terminal.SignalHandler`	`handle(Terminal.Signal signal, Terminal.SignalHandler handler)`
`boolean`	`hasFocusSupport()` Returns `true` if the terminal has support for focus tracking.
`boolean`	`hasMouseSupport()` Returns `true` if the terminal has support for mouse.
`InputStream`	`input()` Retrieve the input stream for this terminal.
`OutputStream`	`output()` Retrieve the output stream for this terminal.
`void`	`pause()` Stop reading the input stream.
`void`	`pause(boolean wait)` Stop reading the input stream and optionally wait for the underlying threads to finish.
`boolean`	`paused()` Check whether the terminal is currently reading the input stream or not.
`boolean`	`puts(InfoCmp.Capability capability, Object... params)`
`void`	`raise(Terminal.Signal signal)`
`NonBlockingReader`	`reader()` Retrieve the `Reader` for this terminal.
`MouseEvent`	`readMouseEvent()` Read a MouseEvent from the terminal input stream.
`MouseEvent`	`readMouseEvent(IntSupplier reader)` Read a MouseEvent from the given input stream.
`void`	`resume()` Resume reading the input stream.
`void`	`setAttributes(Attributes attr)`
`void`	`setSize(Size size)`
`boolean`	`trackFocus(boolean tracking)` Enable or disable focus tracking mode.
`boolean`	`trackMouse(Terminal.MouseTracking tracking)` Change the mouse tracking mouse.
`PrintWriter`	`writer()` Retrieve the `Writer` for this terminal.

Methods inherited from interface java.io.Closeable
close

- Field Detail
  - TYPE_DUMB
```
static final String TYPE_DUMB
```
    Type used for dumb terminals.
    
    See Also:
    
    Constant Field Values
  - TYPE_DUMB_COLOR
```
static final String TYPE_DUMB_COLOR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
  - handle
```
Terminal.SignalHandler handle(Terminal.Signal signal,
                              Terminal.SignalHandler handler)
```
  - raise
```
void raise(Terminal.Signal signal)
```
  - reader
```
NonBlockingReader reader()
```
    Retrieve the Reader for this terminal. This is the standard way to read input from this terminal. The reader is non blocking.
    
    Returns:
    
    The non blocking reader
  - writer
```
PrintWriter writer()
```
    Retrieve the Writer for this terminal. This is the standard way to write to this terminal.
    
    Returns:
    
    The writer
  - encoding
```
Charset encoding()
```
    Returns the Charset that should be used to encode characters for input() and output().
    
    Returns:
    
    The terminal encoding
  - input
```
InputStream input()
```
    Retrieve the input stream for this terminal. In some rare cases, there may be a need to access the terminal input stream directly. In the usual cases, use the reader() instead.
    
    Returns:
    
    The input stream
    
    See Also:
    
    reader()
  - output
```
OutputStream output()
```
    Retrieve the output stream for this terminal. In some rare cases, there may be a need to access the terminal output stream directly. In the usual cases, use the writer() instead.
    
    Returns:
    
    The output stream
    
    See Also:
    
    writer();
  - canPauseResume
```
boolean canPauseResume()
```
    Whether this terminal supports pause() and resume() calls.
    
    Returns:
    
    whether this terminal supports pause() and resume() calls.
    
    See Also:
    
    paused(), pause(), resume()
  - pause
```
void pause()
```
    Stop reading the input stream.
    
    See Also:
    
    resume(), paused()
  - pause
```
void pause(boolean wait)
    throws InterruptedException
```
    Stop reading the input stream and optionally wait for the underlying threads to finish.
    
    Parameters:
    
    wait - true to wait until the terminal is actually paused
    
    Throws:
    
    InterruptedException - if the call has been interrupted
  - resume
```
void resume()
```
    Resume reading the input stream.
    
    See Also:
    
    pause(), paused()
  - paused
```
boolean paused()
```
    Check whether the terminal is currently reading the input stream or not. In order to process signal as quickly as possible, the terminal need to read the input stream and buffer it internally so that it can detect specific characters in the input stream (Ctrl+C, Ctrl+D, etc...) and raise the appropriate signals. However, there are some cases where this processing should be disabled, for example when handing the terminal control to a subprocess.
    
    Returns:
    
    whether the terminal is currently reading the input stream or not
    
    See Also:
    
    pause(), resume()
  - enterRawMode
```
Attributes enterRawMode()
```
  - echo
```
boolean echo()
```
  - echo
```
boolean echo(boolean echo)
```
  - getAttributes
```
Attributes getAttributes()
```
  - setAttributes
```
void setAttributes(Attributes attr)
```
  - getSize
```
Size getSize()
```
  - setSize
```
void setSize(Size size)
```
  - getWidth
```
default int getWidth()
```
  - getHeight
```
default int getHeight()
```
  - flush
```
void flush()
```
    Specified by:
    
    flush in interface Flushable
  - getType
```
String getType()
```
  - puts
```
boolean puts(InfoCmp.Capability capability,
             Object... params)
```
  - getBooleanCapability
```
boolean getBooleanCapability(InfoCmp.Capability capability)
```
  - getNumericCapability
```
Integer getNumericCapability(InfoCmp.Capability capability)
```
  - getStringCapability
```
String getStringCapability(InfoCmp.Capability capability)
```
  - getCursorPosition
```
Cursor getCursorPosition(IntConsumer discarded)
```
    Query the terminal to report the cursor position. As the response is read from the input stream, some characters may be read before the cursor position is actually read. Those characters can be given back using org.jline.keymap.BindingReader#runMacro(String)
    
    Parameters:
    
    discarded - a consumer receiving discarded characters
    
    Returns:
    
    null if cursor position reporting is not supported or a valid cursor position
  - hasMouseSupport
```
boolean hasMouseSupport()
```
    Returns true if the terminal has support for mouse.
    
    Returns:
    
    whether mouse is supported by the terminal
    
    See Also:
    
    trackMouse(MouseTracking)
  - trackMouse
```
boolean trackMouse(Terminal.MouseTracking tracking)
```
    Change the mouse tracking mouse. To start mouse tracking, this method must be called with a valid mouse tracking mode. Mouse events will be reported by writing the InfoCmp.Capability.key_mouse to the input stream. When this character sequence is detected, the readMouseEvent() method can be called to actually read the corresponding mouse event.
    
    Parameters:
    
    tracking - the mouse tracking mode
    
    Returns:
    
    true if mouse tracking is supported
  - readMouseEvent
```
MouseEvent readMouseEvent()
```
    Read a MouseEvent from the terminal input stream. Such an event must have been detected by scanning the terminal's InfoCmp.Capability.key_mouse in the stream immediately before reading the event.
    
    Returns:
    
    the decoded mouse event.
    
    See Also:
    
    trackMouse(MouseTracking)
  - readMouseEvent
```
MouseEvent readMouseEvent(IntSupplier reader)
```
    Read a MouseEvent from the given input stream.
    
    Parameters:
    
    reader - the input supplier
    
    Returns:
    
    the decoded mouse event
  - hasFocusSupport
```
boolean hasFocusSupport()
```
    Returns true if the terminal has support for focus tracking.
    
    Returns:
    
    whether focus tracking is supported by the terminal
    
    See Also:
    
    trackFocus(boolean)
  - trackFocus
```
boolean trackFocus(boolean tracking)
```
    Enable or disable focus tracking mode. When focus tracking has been activated, each time the terminal grabs the focus, the string "\33[I" will be sent to the input stream and each time the focus is lost, the string "\33[O" will be sent to the input stream.
    
    Parameters:
    
    tracking - whether the focus tracking mode should be enabled or not
    
    Returns:
    
    true if focus tracking is supported

Interface Terminal

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface java.io.Closeable

Field Detail

TYPE_DUMB

TYPE_DUMB_COLOR

Method Detail

getName

handle

raise

reader

writer

encoding

input

output

canPauseResume

pause

pause

resume

paused

enterRawMode

echo

echo

getAttributes

setAttributes

getSize

setSize

getWidth

getHeight

flush

getType

puts

getBooleanCapability

getNumericCapability

getStringCapability

getCursorPosition

hasMouseSupport

trackMouse

readMouseEvent

readMouseEvent

hasFocusSupport

trackFocus