Uses of Interface
org.jline.terminal.Terminal
Packages that use Terminal
Package
Description
JLine Builtins provides a collection of utility classes and implementations for common terminal
functionality.
JLine Console package provides a framework for building interactive command-line applications.
JLine 3 Keymap Package - Components for handling keyboard input and key bindings.
JLine 3 Reader Package - Core components for building interactive command-line interfaces.
JLine 3 Reader Implementation Package.
JLine 3 Completer Implementations.
JLine Style package provides a comprehensive styling system for terminal output.
JLine Terminal API - Core abstractions for terminal operations across different platforms.
JLine Terminal implementation classes.
Implementation of terminal functionality using external command-line utilities.
JLine Terminal Service Provider Interface (SPI).
JLine utility classes.
-
Uses of Terminal in org.jline.builtins
Fields in org.jline.builtins declared as TerminalModifier and TypeFieldDescriptionprotected final Terminal
Less.terminal
protected final Terminal
Nano.terminal
Methods in org.jline.builtins with parameters of type TerminalModifier and TypeMethodDescriptionstatic void
Commands.colors
(Terminal terminal, PrintStream out, String[] argv) Displays color tables and ANSI styles.protected String
Completers.FileNameCompleter.getDisplay
(Terminal terminal, Path p, StyleResolver resolver, String separator) static void
Commands.highlighter
(LineReader lineReader, Terminal terminal, PrintStream out, PrintStream err, String[] argv, ConfigurationPath configPath) Manages syntax highlighting themes.static void
Commands.less
(Terminal terminal, InputStream in, PrintStream out, PrintStream err, Path currentDir, Object[] argv) Launches the less pager with the specified arguments.static void
Commands.less
(Terminal terminal, InputStream in, PrintStream out, PrintStream err, Path currentDir, Object[] argv, ConfigurationPath configPath) Launches the less pager with the specified arguments.static void
Commands.nano
(Terminal terminal, PrintStream out, PrintStream err, Path currentDir, String[] argv) Launches the nano text editor with the specified arguments.static void
Commands.nano
(Terminal terminal, PrintStream out, PrintStream err, Path currentDir, String[] argv, ConfigurationPath configPath) Launches the nano text editor with the specified arguments.static void
Commands.tmux
(Terminal terminal, PrintStream out, PrintStream err, Supplier<Object> getter, Consumer<Object> setter, Consumer<Terminal> runner, String[] argv) Implements a terminal multiplexer similar to tmux.static void
TTop.ttop
(Terminal terminal, PrintStream out, PrintStream err, String[] argv) Constructors in org.jline.builtins with parameters of type TerminalModifierConstructorDescriptionLess
(Terminal terminal, Path currentDir, Options opts, ConfigurationPath configPath) Nano
(Terminal terminal, Path root, Options opts, ConfigurationPath configPath) Tmux
(Terminal terminal, PrintStream err, Consumer<Terminal> runner) Constructor parameters in org.jline.builtins with type arguments of type TerminalModifierConstructorDescriptionTmux
(Terminal terminal, PrintStream err, Consumer<Terminal> runner) -
Uses of Terminal in org.jline.builtins.telnet
Methods in org.jline.builtins.telnet with parameters of type TerminalModifier and TypeMethodDescriptionvoid
Constructors in org.jline.builtins.telnet with parameters of type Terminal -
Uses of Terminal in org.jline.console
Methods in org.jline.console that return TerminalModifier and TypeMethodDescriptionCommandInput.terminal()
Returns the terminal instance for this command.CommandRegistry.CommandSession.terminal()
Returns the terminal for the command session.SystemRegistry.terminal()
Returns the terminal associated with this system registry.Constructors in org.jline.console with parameters of type TerminalModifierConstructorDescriptionCommandInput
(String command, Object[] args, Terminal terminal, InputStream in, PrintStream out, PrintStream err) Creates a new CommandInput with the specified command, arguments, terminal, and I/O streams.CommandSession
(Terminal terminal) Creates a new command session with the specified terminal.CommandSession
(Terminal terminal, InputStream in, PrintStream out, PrintStream err) Creates a new command session with the specified terminal and I/O streams. -
Uses of Terminal in org.jline.console.impl
Methods in org.jline.console.impl that return TerminalModifier and TypeMethodDescriptionprotected Terminal
DefaultPrinter.terminal()
SystemRegistryImpl.terminal()
Constructors in org.jline.console.impl with parameters of type TerminalModifierConstructorDescriptionSimpleSystemRegistryImpl
(Parser parser, Terminal terminal, Supplier<Path> workDir, ConfigurationPath configPath) SystemRegistryImpl
(Parser parser, Terminal terminal, Supplier<Path> workDir, ConfigurationPath configPath) -
Uses of Terminal in org.jline.jansi
Methods in org.jline.jansi that return TerminalMethods in org.jline.jansi with parameters of type Terminal -
Uses of Terminal in org.jline.keymap
Methods in org.jline.keymap with parameters of type TerminalModifier and TypeMethodDescriptionstatic String
KeyMap.key
(Terminal terminal, InfoCmp.Capability capability) Returns the escape sequence for a terminal capability. -
Uses of Terminal in org.jline.reader
Methods in org.jline.reader that return TerminalModifier and TypeMethodDescriptionLineReader.getTerminal()
Returns the terminal associated with this LineReader.Methods in org.jline.reader with parameters of type TerminalModifier and TypeMethodDescriptionSets the terminal to be used by the LineReader. -
Uses of Terminal in org.jline.reader.impl
Fields in org.jline.reader.impl declared as TerminalModifier and TypeFieldDescriptionprotected final Terminal
LineReaderImpl.terminal
The terminal to useMethods in org.jline.reader.impl that return TerminalConstructors in org.jline.reader.impl with parameters of type TerminalModifierConstructorDescriptionLineReaderImpl
(Terminal terminal) LineReaderImpl
(Terminal terminal, String appName) -
Uses of Terminal in org.jline.reader.impl.completer
Methods in org.jline.reader.impl.completer with parameters of type TerminalModifier and TypeMethodDescriptionprotected String
FileNameCompleter.getDisplay
(Terminal terminal, Path p) Deprecated. -
Uses of Terminal in org.jline.style
Constructors in org.jline.style with parameters of type TerminalModifierConstructorDescriptionStyledWriter
(OutputStream out, Terminal terminal, StyleResolver resolver, boolean autoFlush) Constructs a new StyledWriter that writes to an OutputStream.StyledWriter
(Writer out, Terminal terminal, StyleResolver resolver, boolean autoFlush) Constructs a new StyledWriter that writes to a Writer. -
Uses of Terminal in org.jline.terminal
Methods in org.jline.terminal that return TerminalModifier and TypeMethodDescriptionTerminalBuilder.build()
Builds the terminal.static Terminal
TerminalBuilder.terminal()
Returns the default system terminal with automatic configuration.Methods in org.jline.terminal with parameters of type TerminalModifier and TypeMethodDescriptionstatic void
TerminalBuilder.setTerminalOverride
(Terminal terminal) Deprecated. -
Uses of Terminal in org.jline.terminal.impl
Classes in org.jline.terminal.impl that implement TerminalModifier and TypeClassDescriptionclass
Base implementation for terminals on POSIX-compliant systems.class
Base implementation of the Terminal interface.class
AbstractWindowsTerminal<Console>
Base implementation for terminals on Windows systems.class
A minimal terminal implementation with limited capabilities.class
Terminal implementation designed for external connections with embedded line discipline.class
Abstract terminal with support for line discipline.class
Terminal implementation for POSIX systems using a pseudoterminal (PTY).class
Terminal implementation for POSIX systems using system streams.Methods in org.jline.terminal.impl that return TerminalModifier and TypeMethodDescriptionDumbTerminalProvider.newTerminal
(String name, String type, InputStream masterInput, OutputStream masterOutput, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) DumbTerminalProvider.sysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) Methods in org.jline.terminal.impl with parameters of type TerminalModifier and TypeMethodDescriptionstatic Cursor
CursorSupport.getCursorPosition
(Terminal terminal, IntConsumer discarded) Gets the current cursor position from the terminal.static boolean
MouseSupport.hasMouseSupport
(Terminal terminal) Checks if the terminal supports mouse tracking.static String[]
Returns a list of key sequences that could be used for mouse events, including the terminal's key_mouse capability if available.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 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 TerminalModifier and TypeMethodDescriptionExecTerminalProvider.newTerminal
(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) Creates a new terminal with custom input and output streams.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.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) ExecTerminalProvider.sysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) Creates a terminal connected to a system stream.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 on Windows.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) -
Uses of Terminal in org.jline.terminal.impl.jansi
Methods in org.jline.terminal.impl.jansi that return TerminalModifier and TypeMethodDescriptionJansiTerminalProvider.newTerminal
(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) JansiTerminalProvider.posixSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JansiTerminalProvider.posixSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JansiTerminalProvider.sysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JansiTerminalProvider.winSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JansiTerminalProvider.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.jansi.win
Classes in org.jline.terminal.impl.jansi.win that implement Terminal -
Uses of Terminal in org.jline.terminal.impl.jna
Methods in org.jline.terminal.impl.jna that return TerminalModifier and TypeMethodDescriptionJnaTerminalProvider.newTerminal
(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) JnaTerminalProvider.posixSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JnaTerminalProvider.posixSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JnaTerminalProvider.sysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JnaTerminalProvider.winSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JnaTerminalProvider.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.jna.win
Classes in org.jline.terminal.impl.jna.win that implement Terminal -
Uses of Terminal in org.jline.terminal.impl.jni
Methods in org.jline.terminal.impl.jni that return TerminalModifier and TypeMethodDescriptionJniTerminalProvider.newTerminal
(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) JniTerminalProvider.posixSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) 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) JniTerminalProvider.sysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) JniTerminalProvider.winSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) 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 -
Uses of Terminal in org.jline.terminal.spi
Subinterfaces of Terminal in org.jline.terminal.spiModifier and TypeInterfaceDescriptioninterface
Extended Terminal interface that provides access to internal implementation details.Methods in org.jline.terminal.spi that return TerminalModifier and TypeMethodDescriptionTerminalProvider.newTerminal
(String name, String type, InputStream masterInput, OutputStream masterOutput, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) Creates a new terminal with custom input and output streams.default Terminal
TerminalProvider.newTerminal
(String name, String type, InputStream masterInput, OutputStream masterOutput, Charset encoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) Deprecated.default Terminal
TerminalProvider.sysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) TerminalProvider.sysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, 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 TerminalModifier and TypeFieldDescriptionprotected final Terminal
Display.terminal
protected final Terminal
Status.terminal
Methods in org.jline.utils with parameters of type TerminalModifier and TypeMethodDescriptionstatic AttributedString
Creates an AttributedString from an ANSI-encoded string, using terminal capabilities.Status.getExistingStatus
(Terminal terminal) static Status
static Status
void
Prints this attributed string to the specified terminal.void
Prints this attributed string to the specified terminal, followed by a line break.Converts this attributed string to an ANSI escape sequence string appropriate for the specified terminal.Constructors in org.jline.utils with parameters of type TerminalModifierConstructorDescriptionColorPalette
(Terminal terminal) ColorPalette
(Terminal terminal, String distance)
TerminalProvider.newTerminal(String, String, InputStream, OutputStream, Charset, Charset, Charset, Charset, Terminal.SignalHandler, boolean, Attributes, Size)
instead