All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
| Class |
Description |
| AbstractCommandRegistry |
Abstract base class implementing common methods for command registries.
|
| AbstractPosixTerminal |
Base implementation for terminals on POSIX-compliant systems.
|
| AbstractPty |
Base implementation of the Pty interface.
|
| AbstractTerminal |
Base implementation of the Terminal interface.
|
| AbstractWindowsConsoleWriter |
Base class for writing to Windows console.
|
| AbstractWindowsTerminal<Console> |
Base implementation for terminals on Windows systems.
|
| AggregateCompleter |
Completer which contains multiple completers and aggregates them together.
|
| Ansi |
|
| Ansi.Attribute |
|
| Ansi.Color |
|
| Ansi.Consumer |
|
| Ansi.Erase |
|
| AnsiColors |
Colors support.
|
| AnsiConsole |
|
| AnsiMain |
Main class for the library, providing executable jar to diagnose Jansi setup.
|
| AnsiMode |
Ansi mode.
|
| AnsiOutputStream |
A ANSI print stream extracts ANSI escape codes written to
an output stream and calls corresponding AnsiProcessor.process* methods.
|
| AnsiOutputStream.IoRunnable |
|
| AnsiOutputStream.WidthSupplier |
|
| AnsiOutputStream.ZeroWidthSupplier |
|
| AnsiPrintStream |
Simple PrintStream holding an AnsiOutputStream.
|
| AnsiProcessor |
ANSI processor providing process* corresponding to ANSI escape codes.
|
| AnsiRenderer |
Renders ANSI color escape-codes in strings by parsing out some special syntax to pick up the correct fluff to use.
|
| AnsiRenderer.Code |
|
| AnsiType |
Processor type.
|
| AnsiWriter |
A writer that processes ANSI escape sequences.
|
| ArgDesc |
Represents a command argument description used for generating command help and documentation.
|
| ArgumentCompleter |
A Completer implementation that invokes a child completer using the appropriate separator argument. |
| ArgumentCompleter.ArgumentLine |
A simple implementation of ParsedLine for argument completion.
|
| AttributedCharSequence |
A character sequence with ANSI style attributes.
|
| AttributedCharSequence.ForceMode |
Enum defining color mode forcing options for ANSI rendering.
|
| AttributedString |
An immutable character sequence with ANSI style attributes.
|
| AttributedStringBuilder |
A mutable builder for creating styled text strings with ANSI attributes.
|
| AttributedStyle |
Text styling for terminal output with support for colors, fonts, and other attributes.
|
| Attributes |
Encapsulates terminal attributes and settings that control terminal behavior.
|
| Attributes.ControlChar |
Control characters used for special terminal functions.
|
| Attributes.ControlFlag |
Control flags that manage hardware aspects of the terminal.
|
| Attributes.InputFlag |
Input flags that control how terminal input is processed.
|
| Attributes.LocalFlag |
Local flags that control various terminal behaviors.
|
| Attributes.OutputFlag |
Output flags that control how terminal output is processed.
|
| AutopairWidgets |
Creates and manages widgets that intelligently handle matching delimiters in the console.
|
| AutosuggestionWidgets |
Creates and manages widgets for as-you-type command line suggestions based on command history.
|
| Binding |
Marker interface for objects that can be bound to key sequences in a KeyMap.
|
| BindingReader |
The BindingReader transforms incoming characters into key bindings.
|
| Buffer |
Represents the editable text buffer in the LineReader.
|
| BufferImpl |
Default implementation of the Buffer interface. |
| Builtins |
Implementation of CommandRegistry that provides built-in commands for JLine.
|
| Builtins.Command |
Enumeration of built-in commands provided by this class.
|
| Candidate |
Represents a completion candidate for tab completion.
|
| ClasspathResourceUtil |
Utility class for working with classpath resources.
|
| CLibrary |
Interface to access some low level POSIX functions,.
|
| CLibrary |
|
| CLibrary |
|
| CLibrary |
|
| CLibrary |
|
| CLibrary.termios |
|
| CLibrary.termios |
|
| CLibrary.termios |
|
| CLibrary.termios |
|
| CLibrary.Termios |
termios structure for termios functions, describing a general terminal interface that is
provided to control asynchronous communications ports
|
| CLibrary.winsize |
|
| CLibrary.winsize |
|
| CLibrary.winsize |
|
| CLibrary.winsize |
|
| CLibrary.WinSize |
Window sizes.
|
| ClosedException |
Exception thrown when attempting to use a closed resource.
|
| CmdDesc |
Represents a command description used for generating command help and documentation.
|
| CmdLine |
Represents a command line with its parsed components.
|
| CmdLine.DescriptionType |
Enumeration specifying the type of description that should be displayed for the command.
|
| ColorPalette |
Color palette for terminal color management and conversion.
|
| Colors |
Helper class for dealing with color rounding.
|
| Colors |
Utility class for color-related operations and definitions.
|
| ColorsAnsiProcessor |
Ansi processor to process color conversion if needed.
|
| CommandInput |
Encapsulates the input and output streams for a command execution.
|
| CommandMethods |
Class that encapsulates the execution and completion methods for a command.
|
| CommandRegistry |
Interface for registering, describing, and executing commands in a console application.
|
| CommandRegistry.CommandSession |
Class representing a command execution session.
|
| Commands |
Provides built-in commands for JLine applications.
|
| Completer |
A completer is the mechanism by which tab-completion candidates will be resolved.
|
| Completers |
Provides a collection of completion-related classes and utilities for JLine applications.
|
| Completers.AnyCompleter |
A completer that accepts any input.
|
| Completers.Completer |
A completer implementation that provides command and argument completion.
|
| Completers.CompletionData |
Holds data for command completion.
|
| Completers.CompletionEnvironment |
Interface defining the environment for command completion.
|
| Completers.DirectoriesCompleter |
A completer for directory names.
|
| Completers.FileNameCompleter |
A file name completer takes the buffer and issues a list of
potential completions.
|
| Completers.FilesCompleter |
A completer for file names.
|
| Completers.OptDesc |
Describes a command-line option for completion.
|
| Completers.OptionCompleter |
A completer for command options and arguments.
|
| Completers.RegexCompleter |
A completer that uses regular expressions to match command patterns.
|
| Completers.RegexCompleter.ArgumentLine |
A simple implementation of ParsedLine for argument completion.
|
| Completers.TreeCompleter |
A completer that supports hierarchical command structures.
|
| Completers.TreeCompleter.Node |
Represents a node in the completion tree.
|
| CompletingParsedLine |
An extension of ParsedLine that, being aware of the quoting and escaping rules
of the Parser that produced it, knows if and how a completion candidate
should be escaped/quoted. |
| CompletionMatcher |
Interface for matching and filtering completion candidates.
|
| CompletionMatcherImpl |
|
| ConfigurationPath |
Manages configuration file paths for JLine applications.
|
| Connection |
Class that implements a connection with this telnet daemon.
|
| ConnectionData |
An utility class that is used to store and allow retrieval
of all data associated with a connection.
|
| ConnectionEvent |
Class implementing a ConnectionEvent.
These events are used to communicate things that are
supposed to be handled within the application context.
|
| ConnectionEvent.Type |
|
| ConnectionFilter |
Interface defining a generic IP level connection
filter.
Due to the fact that this task depends heavily on
application context, I chose a very generic way
of applying IP level connection filtering.
|
| ConnectionListener |
Interface to be implemented if a class wants to
qualify as a ConnectionListener.
Note that a Shell is per contract also forced to
implement this interface.
|
| ConnectionManager |
Class that takes care for active and queued connection.
|
| ConsoleEngine |
Interface for managing console variables, commands, and script execution in a console application.
|
| ConsoleEngine.ExecutionResult |
Class representing the result of executing a command.
|
| ConsoleEngine.WidgetCreator |
Class for creating widgets from console functions.
|
| ConsoleEngineImpl |
Manage console variables, commands and script execution.
|
| ConsoleEngineImpl.Command |
|
| ConsoleEngineImpl.VariableReferenceCompleter |
|
| ConsoleOptionGetter |
Interface for retrieving console options.
|
| Curses |
Utility class for terminal cursor and screen manipulation using ANSI escape sequences.
|
| Cursor |
Represents the position of the cursor within a terminal.
|
| CursorSupport |
Utility class for cursor position detection in terminals.
|
| DefaultExpander |
Default implementation of the Expander interface. |
| DefaultHighlighter |
|
| DefaultHistory |
Default implementation of History with file-based persistent storage. |
| DefaultHistory.EntryImpl |
|
| DefaultParser |
Default implementation of the Parser interface. |
| DefaultParser.BlockCommentDelims |
Class representing block comment delimiters.
|
| DefaultParser.Bracket |
Enumeration of bracket types that can be used for EOF detection on unclosed brackets.
|
| DefaultPrinter |
Default implementation of the Printer interface that provides syntax highlighting and formatting.
|
| Diag |
Diagnostic utility for JLine terminals.
|
| DiffHelper |
Utility class for computing differences between strings with ANSI attribute awareness.
|
| DiffHelper.Diff |
Class representing one diff operation.
|
| DiffHelper.Operation |
The data structure representing a diff is a Linked list of Diff objects:
{Diff(Operation.DELETE, "Hello"), Diff(Operation.INSERT, "Goodbye"),
Diff(Operation.EQUAL, " world.")}
which means: delete "Hello", add "Goodbye" and keep " world."
|
| Display |
Manages terminal display and efficient screen updates with cursor positioning.
|
| DumbTerminal |
A minimal terminal implementation with limited capabilities.
|
| DumbTerminalProvider |
Terminal provider implementation for dumb terminals.
|
| Editor |
Interface for launching external editors from within a JLine application.
|
| EndOfFileException |
|
| EnumCompleter |
|
| EOFError |
Exception thrown when parsing is incomplete due to unexpected end of input.
|
| ExecHelper |
Utility class for executing external commands and capturing their output.
|
| ExecPty |
A pseudoterminal implementation that uses external commands to interact with the terminal.
|
| ExecTerminalProvider |
A terminal provider implementation that uses external commands to interact with the terminal.
|
| Expander |
The Expander interface provides functionality for expanding special syntax in command lines.
|
| ExternalTerminal |
Terminal implementation designed for external connections with embedded line discipline.
|
| FastBufferedOutputStream |
A simple buffering output stream with no synchronization.
|
| FastBufferedOutputStream |
A simple, non-synchronized buffered output stream for improved performance.
|
| FileNameCompleter |
Deprecated.
|
| FreeBsdNativePty |
|
| FreeBsdNativePty |
|
| FreeBsdNativePty |
|
| FreeBsdNativePty.UtilLibrary |
|
| Highlighter |
The Highlighter interface provides syntax highlighting functionality for the LineReader.
|
| History |
Console command history management interface.
|
| History.Entry |
Represents a single history entry containing a command line and its metadata.
|
| InfoCmp |
Utility class for terminal capability handling and terminfo database access.
|
| InfoCmp.Capability |
|
| InputRC |
Utility class for configuring a LineReader from an inputrc file.
|
| InputRC |
Handles inputrc configuration files for JLine.
|
| InputStreamReader |
A specialized InputStreamReader that reads the minimal number of bytes needed.
|
| InterpolationHelper |
Interpolation.
|
| JansiNativePty |
|
| JansiTerminalProvider |
|
| JansiWinSysTerminal |
|
| JlineCommandRegistry |
CommandRegistry common methods for JLine commands that are using HelpException.
|
| JLineLibrary |
Native interface for JLine's low-level system operations.
|
| JLineNativeLoader |
Manages the loading of JLine's native libraries (*.dll, *.jnilib, *.so) according to the current
operating system (Windows, Linux, macOS) and architecture.
|
| JnaNativePty |
|
| JnaTerminalProvider |
|
| JnaWinSysTerminal |
|
| JniNativePty |
|
| JniTerminalProvider |
Terminal provider implementation that uses JNI (Java Native Interface) to access
native terminal functionality.
|
| Kernel32 |
Interface to access Win32 base APIs.
|
| Kernel32.CHAR_INFO |
see: https://msdn.microsoft.com/en-us/library/windows/desktop/ms682013(v=vs.85).aspx
|
| Kernel32.CONSOLE_SCREEN_BUFFER_INFO |
http://msdn.microsoft.com/en-us/library/ms682093%28VS.85%29.aspx
|
| Kernel32.COORD |
|
| Kernel32.FOCUS_EVENT_RECORD |
see: http://msdn.microsoft.com/en-us/library/ms683149(v=VS.85).aspx
|
| Kernel32.INPUT_RECORD |
see: http://msdn.microsoft.com/en-us/library/ms683499(v=VS.85).aspx
|
| Kernel32.KEY_EVENT_RECORD |
see: http://msdn.microsoft.com/en-us/library/ms684166(v=VS.85).aspx
|
| Kernel32.MENU_EVENT_RECORD |
see: http://msdn.microsoft.com/en-us/library/ms684213(v=VS.85).aspx
|
| Kernel32.MOUSE_EVENT_RECORD |
see: http://msdn.microsoft.com/en-us/library/ms684239(v=VS.85).aspx
|
| Kernel32.SMALL_RECT |
http://msdn.microsoft.com/en-us/library/ms686311%28VS.85%29.aspx
|
| Kernel32.WINDOW_BUFFER_SIZE_RECORD |
see: http://msdn.microsoft.com/en-us/library/ms687093(v=VS.85).aspx
|
| KeyMap<T> |
The KeyMap class maps keyboard input sequences to operations or actions.
|
| KillRing |
The kill ring class keeps killed text in a fixed size ring.
|
| Less |
A terminal pager similar to the 'less' Unix command.
|
| Less.Operation |
|
| Levenshtein |
Utility class for computing string similarity using the Damerau-Levenshtein algorithm.
|
| LineDisciplineTerminal |
Abstract terminal with support for line discipline.
|
| LineReader |
Read lines from the console, with input editing.
|
| LineReader.Option |
|
| LineReader.RegionType |
|
| LineReader.SuggestionType |
|
| LineReaderBuilder |
A builder for creating and configuring LineReader instances. |
| LineReaderImpl |
The default implementation of the LineReader interface. |
| LineReaderImpl.BellType |
|
| LineReaderImpl.CompletionType |
|
| LineReaderImpl.PostResult |
|
| LineReaderImpl.State |
Possible states in which the current readline operation may be in.
|
| LineReaderImpl.ViMoveMode |
|
| LinuxNativePty |
|
| LinuxNativePty |
|
| LinuxNativePty |
|
| LinuxNativePty.UtilLibrary |
|
| Log |
Internal logging utility for JLine components.
|
| Macro |
A macro that executes a sequence of keystrokes when invoked.
|
| MaskingCallback |
Callback used to mask parts of the line for sensitive input like passwords.
|
| MemoryStyleSource |
|
| MouseEvent |
Represents a mouse event in a terminal that supports mouse tracking.
|
| MouseEvent.Button |
Defines the mouse buttons that can be involved in a mouse event.
|
| MouseEvent.Modifier |
Defines the modifier keys that can be pressed during a mouse event.
|
| MouseEvent.Type |
Defines the types of mouse events that can occur.
|
| MouseSupport |
Utility class for mouse support in terminals.
|
| Nano |
A terminal text editor similar to the 'nano' Unix command.
|
| Nano.CursorMovement |
|
| Nano.Diagnostic |
Interface representing a diagnostic message for code in the editor.
|
| Nano.Operation |
|
| Nano.PatternHistory |
|
| Nano.WriteFormat |
|
| Nano.WriteMode |
|
| NativeSignalHandler |
Implementation of SignalHandler for native signal handling.
|
| NativeWinSysTerminal |
|
| NfaMatcher<T> |
Non-deterministic Finite Automaton (NFA) implementation for pattern matching.
|
| NonBlocking |
Factory class for creating non-blocking I/O components.
|
| NonBlockingInputStream |
An input stream that supports non-blocking read operations with timeouts.
|
| NonBlockingInputStreamImpl |
This class wraps a regular input stream and allows it to appear as if it
is non-blocking; that is, reads can be performed against it that timeout
if no data is seen for a period of time.
|
| NonBlockingPumpInputStream |
|
| NonBlockingPumpReader |
|
| NonBlockingReader |
A reader that provides non-blocking read operations.
|
| NonBlockingReaderImpl |
This class wraps a regular reader and allows it to appear as if it
is non-blocking; that is, reads can be performed against it that timeout
if no data is seen for a period of time.
|
| NopStyleSource |
A no-operation implementation of StyleSource that always returns null. |
| NullCompleter |
Null completer.
|
| Options |
A GNU-style long options parser that is configured by parsing its usage string.
|
| Options.HelpException |
Exception thrown when using the --help option on a built-in command.
|
| OSInfo |
Provides OS name and architecture name.
|
| OSUtils |
Utility class for operating system detection and OS-specific operations.
|
| OsXNativePty |
|
| OsXNativePty |
|
| OsXNativePty |
|
| ParsedLine |
ParsedLine objects are returned by the Parser
during completion or when accepting the line. |
| Parser |
The Parser interface is responsible for parsing command lines into tokens.
|
| Parser.ParseContext |
|
| PortListener |
Class that implements a PortListener.
If available, it accepts incoming connections and passes them
to an associated ConnectionManager.
|
| PosixCommands |
POSIX-like command implementations for JLine applications.
|
| PosixCommands.CommandExecutor |
Interface for executing shell commands in watch.
|
| PosixCommands.Context |
Context for command execution, providing I/O streams and current directory.
|
| PosixCommands.SortComparator |
Comparator for sorting strings with various options.
|
| PosixCommandsRegistry |
Registry for POSIX commands that provides a convenient way to register and execute
POSIX commands in JLine applications.
|
| PosixCommandsRegistry.CommandFunction |
Functional interface for command implementations that can throw exceptions.
|
| PosixPtyTerminal |
Terminal implementation for POSIX systems using a pseudoterminal (PTY).
|
| PosixSysTerminal |
Terminal implementation for POSIX systems using system streams.
|
| PrintAboveWriter |
|
| Printer |
Interface for printing objects to the console with various formatting options.
|
| Printer.TableRows |
Enumeration specifying which rows in a table should be highlighted.
|
| Pty |
Represents a pseudoterminal (PTY) that provides terminal emulation.
|
| PumpReader |
A reader implementation with an associated writer for buffered character transfer.
|
| ReaderUtils |
Utility methods for LineReader implementations.
|
| Reference |
A reference to a Widget by name. |
| ScreenTerminal |
A virtual terminal screen implementation.
|
| ScriptEngine |
Interface for managing script engine variables, statements, and script execution.
|
| ShutdownHooks |
Manages the JLine shutdown-hook thread and tasks to execute on shutdown.
|
| ShutdownHooks.Task |
Essentially a Runnable which allows running to throw an exception.
|
| Signals |
Signal handling utilities for terminal applications.
|
| SimpleMaskingCallback |
Simple MaskingCallback that will replace all the characters in the line with the given mask. |
| SimpleSystemRegistryImpl |
Simple SystemRegistry which stores variables in the LineReader.
|
| Size |
Represents the dimensions of a terminal in terms of rows and columns.
|
| SolarisNativePty |
|
| SolarisNativePty |
|
| SolarisNativePty |
|
| Source |
Interface representing a source of data that can be read.
|
| Source.InputStreamSource |
A Source implementation that reads from an InputStream.
|
| Source.PathSource |
A Source implementation that reads from a file system path.
|
| Source.ResourceSource |
A Source implementation that reads from a classpath resource.
|
| Source.StdInSource |
A Source implementation that reads from standard input.
|
| Source.URLSource |
A Source implementation that reads from a URL.
|
| Status |
Manages a status bar at the bottom of the terminal.
|
| StringsCompleter |
Completer for a set of strings.
|
| StyleBundle |
Marker interface for proxy-based style bundles.
|
| StyleBundle.DefaultStyle |
Annotation that provides a default style specification for a method in a StyleBundle interface.
|
| StyleBundle.StyleGroup |
Annotation that specifies the style group name for a StyleBundle interface.
|
| StyleBundle.StyleName |
Annotation that allows overriding the style name for a method in a StyleBundle interface.
|
| StyleColor |
Deprecated.
|
| StyledWriter |
A PrintWriter extension that understands and evaluates StyleExpression syntax. |
| StyleExpression |
Provides evaluation of style expressions in the format @{style value}.
|
| StyleFactory |
Factory for creating styled strings using a specific style group.
|
| Styler |
Style facade that provides static utility methods for working with styles.
|
| StyleResolver |
Resolves named (or source-referenced) AttributedStyle for a specific style group. |
| StyleResolver |
Resolves named styles and style expressions into AttributedStyle objects.
|
| Styles |
Provides styling utilities for JLine applications.
|
| Styles.StyleCompiler |
|
| StyleSource |
Interface for sources of style configuration.
|
| SyntaxError |
Exception thrown when a syntax error is encountered during parsing.
|
| SyntaxHighlighter |
Java implementation of a syntax highlighter based on nanorc format.
|
| SyntaxHighlighter.RuleSplitter |
|
| SystemCompleter |
Completer which contains multiple completers and aggregates them together.
|
| SystemHighlighter |
Highlighter implementation that provides syntax highlighting for commands and languages.
|
| SystemHighlighter.FileHighlightCommand |
|
| SystemRegistry |
Interface for aggregating command registries and dispatching command executions in a console application.
|
| SystemRegistry.Registeries |
Class for managing the system registry store.
|
| SystemRegistryImpl |
Aggregate command registries.
|
| SystemRegistryImpl.CommandData |
|
| SystemRegistryImpl.Pipe |
|
| SystemRegistryImpl.UnknownCommandException |
|
| SystemStream |
Represents the standard system streams available in a terminal environment.
|
| TailTipWidgets |
Creates and manages widgets for as-you-type command line suggestions.
|
| TailTipWidgets.TipType |
Enumeration specifying the type of suggestions to display.
|
| Telnet |
|
| Telnet.ShellProvider |
|
| TelnetIO |
Class that represents the TelnetIO implementation.
|
| Terminal |
A terminal representing a virtual terminal on the computer.
|
| Terminal.MouseTracking |
|
| Terminal.Signal |
Types of signals that can be handled by terminal applications.
|
| Terminal.SignalHandler |
Interface for handling terminal signals.
|
| TerminalBuilder |
Builder class to create Terminal instances with flexible configuration options. |
| TerminalBuilder.SystemOutput |
|
| TerminalExt |
Extended Terminal interface that provides access to internal implementation details.
|
| TerminalProvider |
Service provider interface for terminal implementations.
|
| Timeout |
Helper class for managing timeouts during I/O operations.
|
| Tmux |
A terminal multiplexer similar to the 'tmux' Unix command.
|
| TTop |
A terminal-based thread monitoring tool similar to the 'top' Unix command.
|
| TTop.Align |
|
| TTop.Operation |
|
| UndoTree<T> |
Provides undo/redo functionality for the LineReader.
|
| UserInterruptException |
This exception is thrown by LineReader.readLine() when
user interrupt handling is enabled and the user types the
interrupt character (ctrl-C). |
| WCWidth |
Utility class for determining the display width of Unicode characters.
|
| Widget |
A Widget represents an action that can be bound to a key sequence in the LineReader.
|
| Widgets |
Base class for creating custom widgets for JLine's LineReader.
|
| WindowsAnsiProcessor |
A Windows ANSI escape processor, that uses JNA to access native platform
API's to change the console attributes (see
Jansi native Kernel32). |
| WindowsAnsiWriter |
A Windows ANSI escape processor, that uses JNA to access native platform
API's to change the console attributes.
|
| WindowsAnsiWriter |
A Windows ANSI escape processor, uses JNA to access native platform
API's to change the console attributes.
|
| WindowsAnsiWriter |
A Windows ANSI escape processor, that uses JNA to access native platform
API's to change the console attributes.
|
| WindowsSupport |
Deprecated. |
| WriterOutputStream |
An OutputStream implementation that writes to a Writer, bridging byte and character streams.
|