Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Terminal.MouseTracking
public static enum	Terminal.Signal Types of signals.
public static interface	Terminal.SignalHandler The SignalHandler defines the interface used to trap signals and perform specific behaviors.

Field Summary

Modifier and Type	Field and Description
public static final String	TYPE_DUMB Type used for dumb terminals.
public static final String	TYPE_DUMB_COLOR

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: whether this terminal supports `pause()` and `resume()` calls. canPauseResume() Whether this terminal supports `pause()` and `resume()` calls.
public boolean	echo()
public boolean	echo(boolean echo)
public Charset	Returns: The terminal encoding encoding() Returns the `Charset` that should be used to encode characters for `input()` and `output()`.
public Attributes	enterRawMode()
public void	flush() Redeclares java.io.Flushable.flush. Flushes this stream by writing any buffered output to the underlying stream.
public Attributes	Returns: the terminal attributes. getAttributes() Returns the terminal attributes.
public boolean	getBooleanCapability(InfoCmp.Capability capability)
public default Size	Returns: the terminal buffer size getBufferSize() Retrieve the size of the window buffer.
public Cursor	Returns: `null` if cursor position reporting is not supported or a valid cursor position getCursorPosition(IntConsumer a consumer receiving discarded characters discarded) Query the terminal to report the cursor position.
public default int	getHeight()
public String	getName()
public Integer	getNumericCapability(InfoCmp.Capability capability)
public ColorPalette	getPalette() Color support
public Size	Returns: the visible terminal size getSize() Retrieve the size of the visible window
public String	getStringCapability(InfoCmp.Capability capability)
public String	getType()
public default int	getWidth()
public Terminal.SignalHandler	Returns: the previous signal handler handle(Terminal.Signal the signal to register a handler for signal, Terminal.SignalHandler the handler handler) Registers a handler for the given `Signal`.
public boolean	Returns: whether focus tracking is supported by the terminal hasFocusSupport() Returns `true` if the terminal has support for focus tracking.
public boolean	Returns: whether mouse is supported by the terminal hasMouseSupport() Returns `true` if the terminal has support for mouse.
public InputStream	Returns: The input stream input() Retrieve the input stream for this terminal.
public OutputStream	Returns: The output stream output() Retrieve the output stream for this terminal.
public void	pause() Stop reading the input stream.
public void	pause(boolean `true` to wait until the terminal is actually paused wait) Stop reading the input stream and optionally wait for the underlying threads to finish.
public boolean	Returns: whether the terminal is currently reading the input stream or not paused() Check whether the terminal is currently reading the input stream or not.
public boolean	puts(InfoCmp.Capability capability, Object... params)
public void	raise(Terminal.Signal the signal to raise signal) Raise the specific signal.
public NonBlockingReader	Returns: The non blocking reader reader() Retrieve the `Reader` for this terminal.
public MouseEvent	Returns: the decoded mouse event. readMouseEvent() Read a MouseEvent from the terminal input stream.
public MouseEvent	Returns: the decoded mouse event readMouseEvent(IntSupplier the input supplier reader) Read a MouseEvent from the given input stream.
public void	resume() Resume reading the input stream.
public void	setAttributes(Attributes the new attributes attr) Set the terminal attributes.
public void	setSize(Size size)
public boolean	Returns: `true` if focus tracking is supported trackFocus(boolean whether the focus tracking mode should be enabled or not tracking) Enable or disable focus tracking mode.
public boolean	Returns: `true` if mouse tracking is supported trackMouse(Terminal.MouseTracking the mouse tracking mode tracking) Change the mouse tracking mouse.
public PrintWriter	Returns: The writer writer() Retrieve the `Writer` for this terminal.

Inherited from java.io.Closeable:: close

Field Detail

TYPE_DUMB	back to summary
public static final String TYPE_DUMB Type used for dumb terminals.

TYPE_DUMB_COLOR	back to summary
public static final String TYPE_DUMB_COLOR

Method Detail

canPauseResume back to summary

canPauseResume	back to summary
public boolean canPauseResume() Whether this terminal supports `pause()` and `resume()` calls. Returns:boolean whether this terminal supports `pause()` and `resume()` calls. See Also `paused()`, `pause()`, `resume()`

public boolean canPauseResume()

Whether this terminal supports pause() and resume() calls.

Returns:boolean: whether this terminal supports pause() and resume() calls.
See Also: paused(), pause(), resume()

echo	back to summary
public boolean echo()

echo	back to summary
public boolean echo(boolean echo)

encoding back to summary

encoding	back to summary
public Charset encoding() Returns the `Charset` that should be used to encode characters for `input()` and `output()`. Returns:Charset The terminal encoding

public Charset encoding()

Returns the Charset that should be used to encode characters for input() and output().

Returns:Charset: The terminal encoding

enterRawMode	back to summary
public Attributes enterRawMode()

flush	back to summary
public void flush() Redeclares java.io.Flushable.flush. Doc from java.io.Flushable.flush. Flushes this stream by writing any buffered output to the underlying stream.

flush

back to summary

public void flush()

Redeclares java.io.Flushable.flush.

Doc from java.io.Flushable.flush.

Flushes this stream by writing any buffered output to the underlying stream.

getAttributes back to summary

getAttributes	back to summary
public Attributes getAttributes() Returns the terminal attributes. The returned object can be safely modified further used in a call to `setAttributes(Attributes)`. Returns:Attributes the terminal attributes.

public Attributes getAttributes()

Returns the terminal attributes. The returned object can be safely modified further used in a call to setAttributes(Attributes).

Returns:Attributes: the terminal attributes.

getBooleanCapability	back to summary
public boolean getBooleanCapability(InfoCmp.Capability capability)

getBufferSize back to summary

getBufferSize	back to summary
public default Size getBufferSize() Retrieve the size of the window buffer. Some terminals can be configured to have a buffer size larger than the visible window size and provide scroll bars. In such cases, this method should attempt to return the size of the whole buffer. The `getBufferSize()` method can be used to avoid wrapping when using the terminal in a line editing mode, while the `getSize()` method should be used when using full screen mode. Returns:Size the terminal buffer size See Also `getSize()`

public default Size getBufferSize()

Retrieve the size of the window buffer. Some terminals can be configured to have a buffer size larger than the visible window size and provide scroll bars. In such cases, this method should attempt to return the size of the whole buffer. The getBufferSize() method can be used to avoid wrapping when using the terminal in a line editing mode, while the getSize() method should be used when using full screen mode.

Returns:Size: the terminal buffer size
See Also: getSize()

getCursorPosition back to summary

getCursorPosition	back to summary
public 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:IntConsumer a consumer receiving discarded characters Returns:Cursor `null` if cursor position reporting is not supported or a valid cursor position

public 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:IntConsumer: a consumer receiving discarded characters

Returns:Cursor

null if cursor position reporting is not supported or a valid cursor position

getHeight	back to summary
public default int getHeight()

getName	back to summary
public String getName()

getNumericCapability	back to summary
public Integer getNumericCapability(InfoCmp.Capability capability)

getPalette	back to summary
public ColorPalette getPalette() Color support

getSize back to summary

getSize	back to summary
public Size getSize() Retrieve the size of the visible window Returns:Size the visible terminal size See Also `getBufferSize()`

public Size getSize()

Retrieve the size of the visible window

Returns:Size: the visible terminal size
See Also: getBufferSize()

getStringCapability	back to summary
public String getStringCapability(InfoCmp.Capability capability)

getType	back to summary
public String getType()

getWidth	back to summary
public default int getWidth()

handle back to summary

handle	back to summary
public Terminal.SignalHandler handle(Terminal.Signal signal, Terminal.SignalHandler handler) Registers a handler for the given `Signal`. Note that the JVM does not easily allow catching the `Signal#QUIT` signal, which causes a thread dump to be displayed. This signal is mainly used when connecting through an SSH socket to a virtual terminal. Parameters signal:Terminal.Signal the signal to register a handler for handler:Terminal.SignalHandler the handler Returns:Terminal.SignalHandler the previous signal handler

public Terminal.SignalHandler handle(Terminal.Signal signal, Terminal.SignalHandler handler)

Registers a handler for the given Signal.

Note that the JVM does not easily allow catching the Signal#QUIT signal, which causes a thread dump to be displayed. This signal is mainly used when connecting through an SSH socket to a virtual terminal.

Parameters

signal:Terminal.Signal: the signal to register a handler for
handler:Terminal.SignalHandler: the handler

Returns:Terminal.SignalHandler

the previous signal handler

hasFocusSupport back to summary

hasFocusSupport	back to summary
public boolean hasFocusSupport() Returns `true` if the terminal has support for focus tracking. Returns:boolean whether focus tracking is supported by the terminal See Also `trackFocus(boolean)`

public boolean hasFocusSupport()

Returns true if the terminal has support for focus tracking.

Returns:boolean: whether focus tracking is supported by the terminal
See Also: trackFocus(boolean)

hasMouseSupport back to summary

hasMouseSupport	back to summary
public boolean hasMouseSupport() Returns `true` if the terminal has support for mouse. Returns:boolean whether mouse is supported by the terminal See Also `trackMouse(MouseTracking)`

public boolean hasMouseSupport()

Returns true if the terminal has support for mouse.

Returns:boolean: whether mouse is supported by the terminal
See Also: trackMouse(MouseTracking)

input back to summary

input	back to summary
public 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:InputStream The input stream See Also `reader()`

public 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:InputStream: The input stream
See Also: reader()

output back to summary

output	back to summary
public 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:OutputStream The output stream See Also `writer()`

public 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:OutputStream: The output stream
See Also: writer()

pause back to summary

pause	back to summary
public void pause() Stop reading the input stream. See Also `resume()`, `paused()`

public void pause()

Stop reading the input stream.

See Also: resume(), paused()

pause back to summary

pause	back to summary
public void pause(boolean wait) throws InterruptedException Stop reading the input stream and optionally wait for the underlying threads to finish. Parameters wait:boolean `true` to wait until the terminal is actually paused Exceptions InterruptedException: if the call has been interrupted

public void pause(boolean wait) throws InterruptedException

Stop reading the input stream and optionally wait for the underlying threads to finish.

Parameters

wait:boolean: true to wait until the terminal is actually paused

Exceptions

InterruptedException:: if the call has been interrupted

paused back to summary

paused	back to summary
public 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:boolean whether the terminal is currently reading the input stream or not See Also `pause()`, `resume()`

public 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:boolean: whether the terminal is currently reading the input stream or not
See Also: pause(), resume()

puts	back to summary
public boolean puts(InfoCmp.Capability capability, Object... params)

raise back to summary

raise	back to summary
public void raise(Terminal.Signal signal) Raise the specific signal. This is not method usually called by non system terminals. When accessing a terminal through a SSH or Telnet connection, signals may be conveyed by the protocol and thus need to be raised when reaching the terminal code. The terminals do that automatically when the terminal input stream has a character mapped to `Attributes.ControlChar#VINTR`, `Attributes.ControlChar#VQUIT`, or `Attributes.ControlChar#VSUSP`. Parameters signal:Terminal.Signal the signal to raise

public void raise(Terminal.Signal signal)

Raise the specific signal. This is not method usually called by non system terminals. When accessing a terminal through a SSH or Telnet connection, signals may be conveyed by the protocol and thus need to be raised when reaching the terminal code. The terminals do that automatically when the terminal input stream has a character mapped to Attributes.ControlChar#VINTR, Attributes.ControlChar#VQUIT, or Attributes.ControlChar#VSUSP.

Parameters

signal:Terminal.Signal: the signal to raise

reader back to summary

reader	back to summary
public 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:NonBlockingReader The non blocking reader

public 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:NonBlockingReader: The non blocking reader

readMouseEvent back to summary

readMouseEvent	back to summary
public MouseEvent readMouseEvent() Read a MouseEvent from the terminal input stream. Such an event must have been detected by scanning the terminal's `Capability#key_mouse` in the stream immediately before reading the event. Returns:MouseEvent the decoded mouse event. See Also `trackMouse(MouseTracking)`

public MouseEvent readMouseEvent()

Read a MouseEvent from the terminal input stream. Such an event must have been detected by scanning the terminal's Capability#key_mouse in the stream immediately before reading the event.

Returns:MouseEvent: the decoded mouse event.
See Also: trackMouse(MouseTracking)

readMouseEvent	back to summary
public MouseEvent readMouseEvent(IntSupplier reader) Read a MouseEvent from the given input stream. Parameters reader:IntSupplier the input supplier Returns:MouseEvent the decoded mouse event

readMouseEvent

back to summary

public MouseEvent readMouseEvent(IntSupplier reader)

Read a MouseEvent from the given input stream.

Parameters

reader:IntSupplier: the input supplier

Returns:MouseEvent

the decoded mouse event

resume back to summary

resume	back to summary
public void resume() Resume reading the input stream. See Also `pause()`, `paused()`

public void resume()

Resume reading the input stream.

See Also: pause(), paused()

setAttributes	back to summary
public void setAttributes(Attributes attr) Set the terminal attributes. The terminal will perform a copy of the given attributes. Parameters attr:Attributes the new attributes

setAttributes

back to summary

public void setAttributes(Attributes attr)

Set the terminal attributes. The terminal will perform a copy of the given attributes.

Parameters

attr:Attributes: the new attributes

setSize	back to summary
public void setSize(Size size)

trackFocus back to summary

trackFocus	back to summary
public 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:boolean whether the focus tracking mode should be enabled or not Returns:boolean `true` if focus tracking is supported

public 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:boolean: whether the focus tracking mode should be enabled or not

Returns:boolean

true if focus tracking is supported

trackMouse back to summary

trackMouse	back to summary
public 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 `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:Terminal.MouseTracking the mouse tracking mode Returns:boolean `true` if mouse tracking is supported

public 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 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:Terminal.MouseTracking: the mouse tracking mode

Returns:boolean

true if mouse tracking is supported

writer back to summary

writer	back to summary
public PrintWriter writer() Retrieve the `Writer` for this terminal. This is the standard way to write to this terminal. Returns:PrintWriter The writer

public PrintWriter writer()

Retrieve the Writer for this terminal. This is the standard way to write to this terminal.

Returns:PrintWriter: The writer

jdk.internal.org.jline.terminal back to summary

public final Enum Terminal.MouseTracking

Class Inheritance

extends Enum<Terminal.MouseTracking>

java.lang.Object
java.lang.Enum
jdk.internal.org.jline.terminal.Terminal.MouseTracking

Field Summary

Modifier and Type	Field and Description
public static final Terminal.MouseTracking	Any Report all motions events, even if no mouse button is down.
public static final Terminal.MouseTracking	Button Also report button-motion events.
public static final Terminal.MouseTracking	Normal Track button press and release.
public static final Terminal.MouseTracking	Off Disable mouse tracking

Constructor Summary

Access	Constructor and Description
private	MouseTracking()

Method Summary

Modifier and Type	Method and Description
public static Terminal.MouseTracking	valueOf(String name)
public static Terminal.MouseTracking[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

Any	back to summary
public static final Terminal.MouseTracking Any Report all motions events, even if no mouse button is down.

Button	back to summary
public static final Terminal.MouseTracking Button Also report button-motion events. Mouse movements are reported if the mouse pointer has moved to a different character cell.

Normal	back to summary
public static final Terminal.MouseTracking Normal Track button press and release.

Off	back to summary
public static final Terminal.MouseTracking Off Disable mouse tracking

Constructor Detail

MouseTracking	back to summary
private MouseTracking()

Method Detail

valueOf	back to summary
public static Terminal.MouseTracking valueOf(String name)

values	back to summary
public static Terminal.MouseTracking[] values()

jdk.internal.org.jline.terminal back to summary

public final Enum Terminal.Signal

Class Inheritance

extends Enum<Terminal.Signal>

java.lang.Object
java.lang.Enum
jdk.internal.org.jline.terminal.Terminal.Signal

Types of signals.

Field Summary

Modifier and Type	Field and Description
public static final Terminal.Signal	CONT
public static final Terminal.Signal	INFO
public static final Terminal.Signal	INT
public static final Terminal.Signal	QUIT
public static final Terminal.Signal	TSTP
public static final Terminal.Signal	WINCH

Constructor Summary

Access	Constructor and Description
private	Signal()

Method Summary

Modifier and Type	Method and Description
public static Terminal.Signal	valueOf(String name)
public static Terminal.Signal[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CONT	back to summary
public static final Terminal.Signal CONT

INFO	back to summary
public static final Terminal.Signal INFO

INT	back to summary
public static final Terminal.Signal INT

QUIT	back to summary
public static final Terminal.Signal QUIT

TSTP	back to summary
public static final Terminal.Signal TSTP

WINCH	back to summary
public static final Terminal.Signal WINCH

Constructor Detail

Signal	back to summary
private Signal()

Method Detail

valueOf	back to summary
public static Terminal.Signal valueOf(String name)

values	back to summary
public static Terminal.Signal[] values()

jdk.internal.org.jline.terminal back to summary

public Interface Terminal.SignalHandler

Known Direct Implementers: jdk.internal.org.jline.terminal.impl.NativeSignalHandler

The SignalHandler defines the interface used to trap signals and perform specific behaviors.

See Also: Terminal.Signal, Terminal#handle(Signal, SignalHandler)

Field Summary

Modifier and Type	Field and Description
public static final Terminal.SignalHandler	SIG_DFL The `SIG_DFL` value can be used to specify that the JVM default behavior should be used to handle this signal.
public static final Terminal.SignalHandler	SIG_IGN The `SIG_IGN` value can be used to ignore this signal and not perform any special processing.

Method Summary

Modifier and Type	Method and Description
public void	handle(Terminal.Signal the signal signal) Handle the signal.

Field Detail

SIG_DFL	back to summary
public static final Terminal.SignalHandler SIG_DFL The `SIG_DFL` value can be used to specify that the JVM default behavior should be used to handle this signal.

SIG_IGN	back to summary
public static final Terminal.SignalHandler SIG_IGN The `SIG_IGN` value can be used to ignore this signal and not perform any special processing.

Method Detail

handle

back to summary

public void handle(Terminal.Signal signal)

Handle the signal.

Parameters

signal:Terminal.Signal: the signal