Uses of Interface
org.jline.terminal.Terminal

Packages that use Terminal

Package	Description
org.jline.jansi
org.jline.terminal	JLine Terminal API - Core abstractions for terminal operations across different platforms.
org.jline.terminal.impl	JLine Terminal implementation classes.
org.jline.terminal.impl.exec	Implementation of terminal functionality using external command-line utilities.
org.jline.terminal.impl.jni
org.jline.terminal.impl.jni.win
org.jline.terminal.spi	JLine Terminal Service Provider Interface (SPI).
org.jline.utils	JLine utility classes.

Uses of Terminal in org.jline.jansi

Methods in org.jline.jansi that return Terminal

Modifier and Type	Method	Description
static Terminal	AnsiConsole.getTerminal()

Methods in org.jline.jansi with parameters of type Terminal

Modifier and Type	Method	Description
static void	AnsiConsole.setTerminal(Terminal terminal)

Uses of Terminal in org.jline.terminal

Methods in org.jline.terminal that return Terminal

Modifier and Type	Method	Description
Terminal	TerminalBuilder.build()	Create and configure a Terminal instance according to this builder's settings.
static Terminal	TerminalBuilder.terminal()	Returns the default system terminal with automatic configuration.

Methods in org.jline.terminal with parameters of type Terminal

Modifier and Type	Method	Description
static void	TerminalBuilder.setTerminalOverride(Terminal terminal)	Deprecated. This method is deprecated to discourage its use.

Uses of Terminal in org.jline.terminal.impl

Classes in org.jline.terminal.impl that implement Terminal

Modifier and Type	Class	Description
class	AbstractPosixTerminal	Base implementation for terminals on POSIX-compliant systems.
class	AbstractTerminal	Base implementation of the Terminal interface.
class	AbstractUnixSysTerminal	Base class for flattened POSIX system terminals that bypass the PTY abstraction.
class	AbstractWindowsTerminal<Console>	Base implementation for terminals on Windows systems.
class	DumbTerminal	A minimal terminal implementation with limited capabilities.
class	ExternalTerminal	Terminal implementation designed for external connections with embedded line discipline.
class	LineDisciplineTerminal	Abstract terminal with support for line discipline.
class	PosixPtyTerminal	Terminal implementation for POSIX systems using a pseudoterminal (PTY).
class	PosixSysTerminal	Terminal implementation for POSIX systems using system streams.

Methods in org.jline.terminal.impl that return Terminal

Modifier and Type	Method	Description
Terminal	DumbTerminalProvider.newTerminal(String name, String type, InputStream masterInput, OutputStream masterOutput, Charset encoding, Charset inputEncoding, Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)
Terminal	DumbTerminalProvider.sysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)

Methods in org.jline.terminal.impl with parameters of type Terminal

Modifier and Type	Method	Description
void	KittyGraphics.clearAllImages(Terminal terminal)	Clears all images from the terminal.
void	KittyGraphics.deleteImage(Terminal terminal, int imageId)	Deletes an image from the terminal's memory.
void	ITerm2Graphics.displayBackgroundImage(Terminal terminal, BufferedImage image, String position)	Displays an image as a background (non-inline).
void	ITerm2Graphics.displayImage(Terminal terminal, BufferedImage image)
void	ITerm2Graphics.displayImage(Terminal terminal, BufferedImage image, TerminalGraphics.ImageOptions options)
void	ITerm2Graphics.displayImage(Terminal terminal, File file)
void	ITerm2Graphics.displayImage(Terminal terminal, File file, TerminalGraphics.ImageOptions options)
void	ITerm2Graphics.displayImage(Terminal terminal, InputStream inputStream)
void	ITerm2Graphics.displayImage(Terminal terminal, InputStream inputStream, TerminalGraphics.ImageOptions options)
void	KittyGraphics.displayImage(Terminal terminal, BufferedImage image)
void	KittyGraphics.displayImage(Terminal terminal, BufferedImage image, TerminalGraphics.ImageOptions options)
void	KittyGraphics.displayImage(Terminal terminal, File file)
void	KittyGraphics.displayImage(Terminal terminal, File file, TerminalGraphics.ImageOptions options)
void	KittyGraphics.displayImage(Terminal terminal, InputStream inputStream)
void	KittyGraphics.displayImage(Terminal terminal, InputStream inputStream, TerminalGraphics.ImageOptions options)
void	SixelGraphics.displayImage(Terminal terminal, BufferedImage image)
void	SixelGraphics.displayImage(Terminal terminal, BufferedImage image, int maxWidth, int maxHeight)	Displays an image with size constraints.
void	SixelGraphics.displayImage(Terminal terminal, BufferedImage image, TerminalGraphics.ImageOptions options)
void	SixelGraphics.displayImage(Terminal terminal, File file)
void	SixelGraphics.displayImage(Terminal terminal, File file, TerminalGraphics.ImageOptions options)
void	SixelGraphics.displayImage(Terminal terminal, InputStream inputStream)
void	SixelGraphics.displayImage(Terminal terminal, InputStream inputStream, TerminalGraphics.ImageOptions options)
void	TerminalGraphics.displayImage(Terminal terminal, BufferedImage image)	Displays a BufferedImage on the terminal using this graphics protocol.
void	TerminalGraphics.displayImage(Terminal terminal, BufferedImage image, TerminalGraphics.ImageOptions options)	Displays a BufferedImage on the terminal with custom options.
void	TerminalGraphics.displayImage(Terminal terminal, File file)	Displays an image file on the terminal.
void	TerminalGraphics.displayImage(Terminal terminal, File file, TerminalGraphics.ImageOptions options)	Displays an image file on the terminal with custom options.
void	TerminalGraphics.displayImage(Terminal terminal, InputStream inputStream)	Displays an image from an input stream on the terminal.
void	TerminalGraphics.displayImage(Terminal terminal, InputStream inputStream, TerminalGraphics.ImageOptions options)	Displays an image from an input stream on the terminal with custom options.
static void	TerminalGraphicsManager.displayImage(Terminal terminal, BufferedImage image)	Displays a BufferedImage on the terminal using the best available protocol.
static void	TerminalGraphicsManager.displayImage(Terminal terminal, BufferedImage image, TerminalGraphics.ImageOptions options)	Displays a BufferedImage on the terminal with custom options.
static void	TerminalGraphicsManager.displayImage(Terminal terminal, File file)	Displays an image file on the terminal using the best available protocol.
static void	TerminalGraphicsManager.displayImage(Terminal terminal, File file, TerminalGraphics.ImageOptions options)	Displays an image file on the terminal with custom options.
static void	TerminalGraphicsManager.displayImage(Terminal terminal, InputStream inputStream)	Displays an image from an input stream on the terminal using the best available protocol.
static void	TerminalGraphicsManager.displayImage(Terminal terminal, InputStream inputStream, TerminalGraphics.ImageOptions options)	Displays an image from an input stream on the terminal with custom options.
static void	SixelGraphics.displayImageStatic(Terminal terminal, BufferedImage image)	Displays an image in Sixel format on the terminal.
static void	SixelGraphics.displayImageStatic(Terminal terminal, File file)	Displays an image file in Sixel format on the terminal.
static void	SixelGraphics.displayImageStatic(Terminal terminal, InputStream inputStream)	Displays an image from an input stream in Sixel format on the terminal.
void	ITerm2Graphics.displayImageWithPercentageSize(Terminal terminal, BufferedImage image, int widthPercent, Integer heightPercent)	Displays an image with percentage-based sizing.
static Optional<TerminalGraphics>	TerminalGraphicsManager.getBestProtocol(Terminal terminal)	Finds the best graphics protocol for the given terminal.
static Cursor	CursorSupport.getCursorPosition(Terminal terminal, IntConsumer discarded)	Gets the current cursor position from the terminal.
static List<TerminalGraphics>	TerminalGraphicsManager.getSupportedProtocols(Terminal terminal)	Gets all graphics protocols supported by the given terminal.
static boolean	MouseSupport.hasMouseSupport(Terminal terminal)	Checks if the terminal supports mouse tracking.
static boolean	DoubleSizeCharacters.isDoubleSizeSupported(Terminal terminal)	Checks if the terminal supports double-size characters.
static boolean	TerminalGraphicsManager.isGraphicsSupported(Terminal terminal)	Checks if any graphics protocol is supported by the given terminal.
static boolean	SixelGraphics.isSixelSupported(Terminal terminal)	Checks if the terminal supports Sixel graphics.
boolean	ITerm2Graphics.isSupported(Terminal terminal)
boolean	KittyGraphics.isSupported(Terminal terminal)
boolean	SixelGraphics.isSupported(Terminal terminal)
boolean	TerminalGraphics.isSupported(Terminal terminal)	Checks if this graphics protocol is supported by the given terminal.
static String[]	MouseSupport.keys(Terminal terminal)	Returns a list of key sequences that could be used for mouse events, including the terminal's key_mouse capability if available.
static void	DoubleSizeCharacters.printBanner(Terminal terminal, String text, char borderChar)	Creates a banner with the specified text using double-height characters.
static void	DoubleSizeCharacters.printDoubleHeight(Terminal terminal, String text)	Prints text in double height (both top and bottom halves).
static void	DoubleSizeCharacters.printDoubleWidth(Terminal terminal, String text)	Prints text in double width.
static void	DoubleSizeCharacters.printNormal(Terminal terminal, String text)	Prints text in normal size.
static MouseEvent	MouseSupport.readMouse(Terminal terminal, MouseEvent last)	Reads a mouse event from the terminal.
static MouseEvent	MouseSupport.readMouse(Terminal terminal, MouseEvent last, String prefix)	Reads a mouse event from the terminal with a prefix that has already been consumed.
static void	DoubleSizeCharacters.reset(Terminal terminal)	Resets the terminal to normal character size.
static void	DoubleSizeCharacters.setMode(Terminal terminal, DoubleSizeCharacters.Mode mode)	Sets the double-size character mode for the current line.
static boolean	MouseSupport.trackMouse(Terminal terminal, Terminal.MouseTracking tracking)	Enables or disables mouse tracking in the terminal.

Uses of Terminal in org.jline.terminal.impl.exec

Methods in org.jline.terminal.impl.exec that return Terminal

Modifier and Type	Method	Description
Terminal	ExecTerminalProvider.newTerminal(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset inputEncoding, Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)	Creates a new terminal with custom input and output streams.
Terminal	ExecTerminalProvider.posixSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Creates a terminal connected to a system stream on POSIX systems.
Terminal	ExecTerminalProvider.posixSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Create a POSIX system terminal backed by the specified system stream.
Terminal	ExecTerminalProvider.sysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused)	Creates a terminal connected to a system stream.
Terminal	ExecTerminalProvider.sysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
Terminal	ExecTerminalProvider.winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Creates a terminal connected to a system stream.
Terminal	ExecTerminalProvider.winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Create a POSIX-style system terminal for Windows environments that provide a POSIX layer (Cygwin/MSYS); returns null on other Windows variants.

Uses of Terminal in org.jline.terminal.impl.jni

Classes in org.jline.terminal.impl.jni that implement Terminal

Modifier and Type	Class	Description
class	JniUnixSysTerminal	JNI-based POSIX system terminal that calls CLibrary directly.

Methods in org.jline.terminal.impl.jni that return Terminal

Modifier and Type	Method	Description
Terminal	JniTerminalProvider.newTerminal(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset inputEncoding, Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)	Create a new terminal backed by a newly opened POSIX pseudo-terminal (PTY).
Terminal	JniTerminalProvider.posixSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
Terminal	JniTerminalProvider.posixSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Create a POSIX system terminal backed by a native PTY.
Terminal	JniTerminalProvider.sysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
Terminal	JniTerminalProvider.winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
Terminal	JniTerminalProvider.winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)

Uses of Terminal in org.jline.terminal.impl.jni.win

Classes in org.jline.terminal.impl.jni.win that implement Terminal

Modifier and Type	Class	Description
class	NativeWinSysTerminal

Uses of Terminal in org.jline.terminal.spi

Subinterfaces of Terminal in org.jline.terminal.spi

Modifier and Type	Interface	Description
interface	TerminalExt	Extended Terminal interface that provides access to internal implementation details.

Methods in org.jline.terminal.spi that return Terminal

Modifier and Type	Method	Description
Terminal	TerminalProvider.newTerminal(String name, String type, InputStream masterInput, OutputStream masterOutput, Charset encoding, Charset inputEncoding, Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)	Creates a new terminal with custom input and output streams.
default Terminal	TerminalProvider.sysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused)	Creates a terminal connected to the controlling terminal device (/dev/tty).
Terminal	TerminalProvider.sysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Creates a terminal connected to a system stream.

Uses of Terminal in org.jline.utils

Fields in org.jline.utils declared as Terminal

Modifier and Type	Field	Description
protected final Terminal	Display.terminal
protected final Terminal	Status.terminal

Methods in org.jline.utils with parameters of type Terminal

Modifier and Type	Method	Description
static int	WCWidth.charCountForDisplay(CharSequence cs, int index, Terminal terminal)	Compute the number of Java chars that form the display unit (code point or grapheme cluster) starting at index in cs.
int	AttributedCharSequence.columnLength(Terminal terminal)	Returns the display width of this attributed string in columns.
List<AttributedString>	AttributedCharSequence.columnSplitLength(int columns, boolean includeNewlines, boolean delayLineWrap, Terminal terminal)	Deprecated. Use AttributedCharSequence.columnSplitLength(Terminal, int, boolean, boolean) instead
List<AttributedString>	AttributedCharSequence.columnSplitLength(Terminal terminal, int columns, boolean includeNewlines, boolean delayLineWrap)	Splits this attributed string into multiple lines based on column width.
AttributedString	AttributedCharSequence.columnSubSequence(int start, int stop, Terminal terminal)	Deprecated. Use AttributedCharSequence.columnSubSequence(Terminal, int, int) instead
AttributedString	AttributedCharSequence.columnSubSequence(Terminal terminal, int start, int stop)	Returns a subsequence of this attributed string based on column positions.
static AttributedString	AttributedString.fromAnsi(String ansi, Terminal terminal)	Creates an AttributedString from an ANSI-encoded string, using terminal capabilities.
static Optional<Status>	Status.getExistingStatus(Terminal terminal)
static Status	Status.getStatus(Terminal terminal)
static Status	Status.getStatus(Terminal terminal, boolean create)
void	AttributedCharSequence.print(Terminal terminal)	Prints this attributed string to the specified terminal.
void	AttributedCharSequence.println(Terminal terminal)	Prints this attributed string to the specified terminal, followed by a line break.
String	AttributedCharSequence.toAnsi(Terminal terminal)	Converts this attributed string to an ANSI escape sequence string appropriate for the specified terminal.
static int	WCWidth.wcwidthForDisplay(CharSequence cs, int index, Terminal terminal)	Compute the display width in terminal columns of the character or grapheme cluster that begins at the given index in the character sequence.

Constructors in org.jline.utils with parameters of type Terminal

Modifier	Constructor	Description
	ColorPalette(Terminal terminal)
	ColorPalette(Terminal terminal, String distance)
	Display(Terminal terminal, boolean fullscreen)	Create a Display bound to the given Terminal and configured for either full-screen or inline (partial-screen) usage.
	Status(Terminal terminal)