OpenJDK 27 · jdk.internal.org.jline.terminal.impl.AbstractTerminal

Modifier and Type	Field and Description
protected final Set<InfoCmp.Capability>	bools
protected final Charset	encoding
protected final Map<Terminal.Signal, Terminal.SignalHandler>	handlers
protected final Map<InfoCmp.Capability, Integer>	ints
private MouseEvent	lastMouseEvent
protected final String	name
protected Runnable	onClose
protected final ColorPalette	palette
protected Status	status
protected final Map<InfoCmp.Capability, String>	strings
protected final String	type

Access	Constructor and Description
public	AbstractTerminal(String name, String type)
public	AbstractTerminal(String name, String type, Charset encoding, Terminal.SignalHandler signalHandler)

Modifier and Type	Method and Description
public boolean	canPauseResume() Implements jdk.internal.org.jline.terminal.Terminal.canPauseResume. Whether this terminal supports `pause()` and `resume()` calls.
protected void	checkInterrupted()
public final void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
protected void	doClose()
public boolean	echo() Implements jdk.internal.org.jline.terminal.Terminal.echo.
public boolean	echo(boolean echo) Implements jdk.internal.org.jline.terminal.Terminal.echo.
protected void	echoSignal(Terminal.Signal signal)
public Charset	encoding() Implements jdk.internal.org.jline.terminal.Terminal.encoding. Returns the `Charset` that should be used to encode characters for `input()` and `output()`.
public Attributes	enterRawMode() Implements jdk.internal.org.jline.terminal.Terminal.enterRawMode.
public void	flush() Implements jdk.internal.org.jline.terminal.Terminal.flush. Flushes this stream by writing any buffered output to the underlying stream.
public boolean	getBooleanCapability(InfoCmp.Capability capability) Implements jdk.internal.org.jline.terminal.Terminal.getBooleanCapability.
public Cursor	getCursorPosition(IntConsumer discarded) Implements jdk.internal.org.jline.terminal.Terminal.getCursorPosition. Query the terminal to report the cursor position.
public String	getKind()
public String	getName() Implements jdk.internal.org.jline.terminal.Terminal.getName.
public Integer	getNumericCapability(InfoCmp.Capability capability) Implements jdk.internal.org.jline.terminal.Terminal.getNumericCapability.
public ColorPalette	getPalette() Implements jdk.internal.org.jline.terminal.Terminal.getPalette. Color support
public Status	getStatus()
public Status	getStatus(boolean create)
public String	getStringCapability(InfoCmp.Capability capability) Implements jdk.internal.org.jline.terminal.Terminal.getStringCapability.
public String	getType() Implements jdk.internal.org.jline.terminal.Terminal.getType.
public Terminal.SignalHandler	handle(Terminal.Signal signal, Terminal.SignalHandler handler) Implements jdk.internal.org.jline.terminal.Terminal.handle. Registers a handler for the given `Signal`.
public boolean	hasFocusSupport() Implements jdk.internal.org.jline.terminal.Terminal.hasFocusSupport. Returns `true` if the terminal has support for focus tracking.
public boolean	hasMouseSupport() Implements jdk.internal.org.jline.terminal.Terminal.hasMouseSupport. Returns `true` if the terminal has support for mouse.
protected void	parseInfoCmp()
public void	pause() Implements jdk.internal.org.jline.terminal.Terminal.pause. Stop reading the input stream.
public void	pause(boolean wait) Implements jdk.internal.org.jline.terminal.Terminal.pause. Stop reading the input stream and optionally wait for the underlying threads to finish.
public boolean	paused() Implements jdk.internal.org.jline.terminal.Terminal.paused. Check whether the terminal is currently reading the input stream or not.
public boolean	puts(InfoCmp.Capability capability, Object... params) Implements jdk.internal.org.jline.terminal.Terminal.puts.
public void	raise(Terminal.Signal signal) Implements jdk.internal.org.jline.terminal.Terminal.raise. Raise the specific signal.
public MouseEvent	readMouseEvent() Implements jdk.internal.org.jline.terminal.Terminal.readMouseEvent. Read a MouseEvent from the terminal input stream.
public MouseEvent	readMouseEvent(IntSupplier reader) Implements jdk.internal.org.jline.terminal.Terminal.readMouseEvent. Read a MouseEvent from the given input stream.
public void	resume() Implements jdk.internal.org.jline.terminal.Terminal.resume. Resume reading the input stream.
public void	setOnClose(Runnable onClose)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public boolean	trackFocus(boolean tracking) Implements jdk.internal.org.jline.terminal.Terminal.trackFocus. Enable or disable focus tracking mode.
public boolean	trackMouse(Terminal.MouseTracking tracking) Implements jdk.internal.org.jline.terminal.Terminal.trackMouse. Change the mouse tracking mouse.

bools	back to summary
protected final Set<InfoCmp.Capability> bools

encoding	back to summary
protected final Charset encoding

handlers	back to summary
protected final Map<Terminal.Signal, Terminal.SignalHandler> handlers

ints	back to summary
protected final Map<InfoCmp.Capability, Integer> ints

lastMouseEvent	back to summary
private MouseEvent lastMouseEvent

name	back to summary
protected final String name

onClose	back to summary
protected Runnable onClose

palette	back to summary
protected final ColorPalette palette

status	back to summary
protected Status status

strings	back to summary
protected final Map<InfoCmp.Capability, String> strings

type	back to summary
protected final String type

AbstractTerminal	back to summary
public AbstractTerminal(String name, String type) throws IOException

AbstractTerminal	back to summary
public AbstractTerminal(String name, String type, Charset encoding, Terminal.SignalHandler signalHandler) throws IOException Annotations @SuppressWarnings:this-escape

Method Detail

canPauseResume back to summary

canPauseResume	back to summary
public boolean canPauseResume() Implements jdk.internal.org.jline.terminal.Terminal.canPauseResume. Doc from jdk.internal.org.jline.terminal.Terminal.canPauseResume. Whether this terminal supports `pause()` and `resume()` calls. Annotations @Override

public boolean canPauseResume()

Implements jdk.internal.org.jline.terminal.Terminal.canPauseResume.

Doc from jdk.internal.org.jline.terminal.Terminal.canPauseResume.

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

Annotations

@Override

checkInterrupted	back to summary
protected void checkInterrupted() throws InterruptedIOException

close back to summary

close	back to summary
public final void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Exceptions IOException: if an I/O error occurs

public final void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Exceptions

IOException:: if an I/O error occurs

doClose	back to summary
protected void doClose() throws IOException

echo	back to summary
public boolean echo() Implements jdk.internal.org.jline.terminal.Terminal.echo.

echo	back to summary
public boolean echo(boolean echo) Implements jdk.internal.org.jline.terminal.Terminal.echo.

echoSignal	back to summary
protected void echoSignal(Terminal.Signal signal)

encoding back to summary

encoding	back to summary
public Charset encoding() Implements jdk.internal.org.jline.terminal.Terminal.encoding. Doc from jdk.internal.org.jline.terminal.Terminal.encoding. Returns the `Charset` that should be used to encode characters for `input()` and `output()`. Annotations @Override

public Charset encoding()

Implements jdk.internal.org.jline.terminal.Terminal.encoding.

Doc from jdk.internal.org.jline.terminal.Terminal.encoding.

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

Annotations

@Override

enterRawMode	back to summary
public Attributes enterRawMode() Implements jdk.internal.org.jline.terminal.Terminal.enterRawMode.

flush	back to summary
public void flush() Implements jdk.internal.org.jline.terminal.Terminal.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()

Implements jdk.internal.org.jline.terminal.Terminal.flush.

Doc from java.io.Flushable.flush.

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

getBooleanCapability	back to summary
public boolean getBooleanCapability(InfoCmp.Capability capability) Implements jdk.internal.org.jline.terminal.Terminal.getBooleanCapability.

getCursorPosition back to summary

getCursorPosition	back to summary
public Cursor getCursorPosition(IntConsumer discarded) Implements jdk.internal.org.jline.terminal.Terminal.getCursorPosition. Doc from jdk.internal.org.jline.terminal.Terminal.getCursorPosition. 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)` Annotations @Override

public Cursor getCursorPosition(IntConsumer discarded)

Implements jdk.internal.org.jline.terminal.Terminal.getCursorPosition.

Doc from jdk.internal.org.jline.terminal.Terminal.getCursorPosition.

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)

Annotations

@Override

getKind	back to summary
public String getKind()

getName	back to summary
public String getName() Implements jdk.internal.org.jline.terminal.Terminal.getName.

getNumericCapability	back to summary
public Integer getNumericCapability(InfoCmp.Capability capability) Implements jdk.internal.org.jline.terminal.Terminal.getNumericCapability.

getPalette	back to summary
public ColorPalette getPalette() Implements jdk.internal.org.jline.terminal.Terminal.getPalette. Doc from jdk.internal.org.jline.terminal.Terminal.getPalette. Color support Annotations @Override

getPalette

back to summary

public ColorPalette getPalette()

Implements jdk.internal.org.jline.terminal.Terminal.getPalette.

Doc from jdk.internal.org.jline.terminal.Terminal.getPalette.

Color support

Annotations

@Override

getStatus	back to summary
public Status getStatus()

getStatus	back to summary
public Status getStatus(boolean create)

getStringCapability	back to summary
public String getStringCapability(InfoCmp.Capability capability) Implements jdk.internal.org.jline.terminal.Terminal.getStringCapability.

getType	back to summary
public String getType() Implements jdk.internal.org.jline.terminal.Terminal.getType.

handle back to summary

handle	back to summary
public Terminal.SignalHandler handle(Terminal.Signal signal, Terminal.SignalHandler handler) Implements jdk.internal.org.jline.terminal.Terminal.handle. Doc from jdk.internal.org.jline.terminal.Terminal.handle. 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.

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

Implements jdk.internal.org.jline.terminal.Terminal.handle.

Doc from jdk.internal.org.jline.terminal.Terminal.handle.

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.

hasFocusSupport back to summary

hasFocusSupport	back to summary
public boolean hasFocusSupport() Implements jdk.internal.org.jline.terminal.Terminal.hasFocusSupport. Doc from jdk.internal.org.jline.terminal.Terminal.hasFocusSupport. Returns `true` if the terminal has support for focus tracking. Annotations @Override

public boolean hasFocusSupport()

Implements jdk.internal.org.jline.terminal.Terminal.hasFocusSupport.

Doc from jdk.internal.org.jline.terminal.Terminal.hasFocusSupport.

Returns true if the terminal has support for focus tracking.

Annotations

@Override

hasMouseSupport back to summary

hasMouseSupport	back to summary
public boolean hasMouseSupport() Implements jdk.internal.org.jline.terminal.Terminal.hasMouseSupport. Doc from jdk.internal.org.jline.terminal.Terminal.hasMouseSupport. Returns `true` if the terminal has support for mouse. Annotations @Override

public boolean hasMouseSupport()

Implements jdk.internal.org.jline.terminal.Terminal.hasMouseSupport.

Doc from jdk.internal.org.jline.terminal.Terminal.hasMouseSupport.

Returns true if the terminal has support for mouse.

Annotations

@Override

parseInfoCmp	back to summary
protected void parseInfoCmp()

pause	back to summary
public void pause() Implements jdk.internal.org.jline.terminal.Terminal.pause. Doc from jdk.internal.org.jline.terminal.Terminal.pause. Stop reading the input stream. Annotations @Override

pause

back to summary

public void pause()

Implements jdk.internal.org.jline.terminal.Terminal.pause.

Doc from jdk.internal.org.jline.terminal.Terminal.pause.

Stop reading the input stream.

Annotations

@Override

pause	back to summary
public void pause(boolean wait) throws InterruptedException Implements jdk.internal.org.jline.terminal.Terminal.pause. Doc from jdk.internal.org.jline.terminal.Terminal.pause. Stop reading the input stream and optionally wait for the underlying threads to finish. Annotations @Override Exceptions InterruptedException: if the call has been interrupted

pause

back to summary

public void pause(boolean wait) throws InterruptedException

Implements jdk.internal.org.jline.terminal.Terminal.pause.

Doc from jdk.internal.org.jline.terminal.Terminal.pause.

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

Annotations

@Override

Exceptions

InterruptedException:: if the call has been interrupted

paused	back to summary
public boolean paused() Implements jdk.internal.org.jline.terminal.Terminal.paused. Doc from jdk.internal.org.jline.terminal.Terminal.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. Annotations @Override

paused

back to summary

public boolean paused()

Implements jdk.internal.org.jline.terminal.Terminal.paused.

Doc from jdk.internal.org.jline.terminal.Terminal.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.

Annotations

@Override

puts	back to summary
public boolean puts(InfoCmp.Capability capability, Object... params) Implements jdk.internal.org.jline.terminal.Terminal.puts.

raise back to summary

raise	back to summary
public void raise(Terminal.Signal signal) Implements jdk.internal.org.jline.terminal.Terminal.raise. Doc from jdk.internal.org.jline.terminal.Terminal.raise. 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`.

public void raise(Terminal.Signal signal)

Implements jdk.internal.org.jline.terminal.Terminal.raise.

Doc from jdk.internal.org.jline.terminal.Terminal.raise.

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.

readMouseEvent back to summary

readMouseEvent	back to summary
public MouseEvent readMouseEvent() Implements jdk.internal.org.jline.terminal.Terminal.readMouseEvent. Doc from jdk.internal.org.jline.terminal.Terminal.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. Annotations @Override

public MouseEvent readMouseEvent()

Implements jdk.internal.org.jline.terminal.Terminal.readMouseEvent.

Doc from jdk.internal.org.jline.terminal.Terminal.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.

Annotations

@Override

readMouseEvent	back to summary
public MouseEvent readMouseEvent(IntSupplier reader) Implements jdk.internal.org.jline.terminal.Terminal.readMouseEvent. Doc from jdk.internal.org.jline.terminal.Terminal.readMouseEvent. Read a MouseEvent from the given input stream. Annotations @Override

readMouseEvent

back to summary

public MouseEvent readMouseEvent(IntSupplier reader)

Implements jdk.internal.org.jline.terminal.Terminal.readMouseEvent.

Doc from jdk.internal.org.jline.terminal.Terminal.readMouseEvent.

Read a MouseEvent from the given input stream.

Annotations

@Override

resume	back to summary
public void resume() Implements jdk.internal.org.jline.terminal.Terminal.resume. Doc from jdk.internal.org.jline.terminal.Terminal.resume. Resume reading the input stream. Annotations @Override

resume

back to summary

public void resume()

Implements jdk.internal.org.jline.terminal.Terminal.resume.

Doc from jdk.internal.org.jline.terminal.Terminal.resume.

Resume reading the input stream.

Annotations

@Override

setOnClose	back to summary
public void setOnClose(Runnable onClose)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

trackFocus

back to summary

public boolean trackFocus(boolean tracking)

Implements jdk.internal.org.jline.terminal.Terminal.trackFocus.

Doc from jdk.internal.org.jline.terminal.Terminal.trackFocus.

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.

Annotations

@Override

trackMouse back to summary

public boolean trackMouse(Terminal.MouseTracking tracking)

Implements jdk.internal.org.jline.terminal.Terminal.trackMouse.

Doc from jdk.internal.org.jline.terminal.Terminal.trackMouse.

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.

Annotations

@Override

public abstract Class AbstractTerminal

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail