Package org.jline.builtins
JLine Builtins provides a collection of utility classes and implementations for common terminal
functionality.
This package contains various components that enhance the JLine library with built-in commands, completers, and utilities for terminal-based applications:
- Terminal commands like
Less
,Nano
, andTmux
- Completion utilities through
Completers
- Command-line option parsing with
Options
- Configuration management via
ConfigurationPath
- Syntax highlighting with
SyntaxHighlighter
- Terminal monitoring through
TTop
These built-in components can be used to quickly implement rich terminal applications with features like command completion, syntax highlighting, and file navigation.
-
Interface Summary Interface Description Completers.CompletionEnvironment Interface defining the environment for command completion.ConsoleOptionGetter Interface for retrieving console options.Nano.Diagnostic Interface representing a diagnostic message for code in the editor.Source Interface representing a source of data that can be read. -
Class Summary Class Description ClasspathResourceUtil Utility class for working with classpath resources.Commands Provides built-in commands for JLine applications.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.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.ConfigurationPath Manages configuration file paths for JLine applications.InputRC Utility class for configuring a LineReader from an inputrc file.Less A terminal pager similar to the 'less' Unix command.Nano A terminal text editor similar to the 'nano' Unix command.Nano.PatternHistory NfaMatcher<T> Non-deterministic Finite Automaton (NFA) implementation for pattern matching.Options A GNU-style long options parser that is configured by parsing its usage string.ScreenTerminal A virtual terminal screen implementation.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.Styles Provides styling utilities for JLine applications.Styles.StyleCompiler SyntaxHighlighter Java implementation of a syntax highlighter based on nanorc format.SyntaxHighlighter.RuleSplitter Tmux A terminal multiplexer similar to the 'tmux' Unix command.TTop A terminal-based thread monitoring tool similar to the 'top' Unix command. -
Enum Summary Enum Description Less.Operation Nano.CursorMovement Nano.Operation Nano.WriteFormat Nano.WriteMode TTop.Align TTop.Operation -
Exception Summary Exception Description Options.HelpException Exception thrown when using the--help
option on a built-in command.