Terminal (JLine Terminal 3.5.0 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.

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`echo()`
`boolean`	`echo(boolean echo)`
`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`	`hasMouseSupport()` Returns `true` if the terminal has support for mouse.
`InputStream`	`input()`
`OutputStream`	`output()`
`boolean`	`puts(InfoCmp.Capability capability, Object... params)`
`void`	`raise(Terminal.Signal signal)`
`NonBlockingReader`	`reader()`
`MouseEvent`	`readMouseEvent()` Read a MouseEvent from the terminal input stream.
`MouseEvent`	`readMouseEvent(IntSupplier reader)` Read a MouseEvent from the given input stream.
`void`	`setAttributes(Attributes attr)`
`void`	`setSize(Size size)`
`boolean`	`trackMouse(Terminal.MouseTracking tracking)` Change the mouse tracking mouse.
`PrintWriter`	`writer()`

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
- Method Detail
  - getName
```
String getName()
```
  - handle
```
Terminal.SignalHandler handle(Terminal.Signal signal,
                              Terminal.SignalHandler handler)
```
  - raise
```
void raise(Terminal.Signal signal)
```
  - reader
```
NonBlockingReader reader()
```
  - writer
```
PrintWriter writer()
```
  - input
```
InputStream input()
```
  - output
```
OutputStream output()
```
  - 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

Interface Terminal

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface java.io.Closeable

Field Detail

TYPE_DUMB

Method Detail

getName

handle

raise

reader

writer

input

output

enterRawMode

echo

echo

getAttributes

setAttributes

getSize

setSize

getWidth

getHeight

flush

getType

puts

getBooleanCapability

getNumericCapability

getStringCapability

getCursorPosition

hasMouseSupport

trackMouse

readMouseEvent

readMouseEvent