Package org.jline.console
JLine Console package provides a framework for building interactive command-line applications.
This package contains classes and interfaces for:
- Command registration and execution
- Command argument parsing and description
- Command output formatting and printing
- Script execution and variable management
- System registry for command execution
Key components include:
CommandRegistry
- Interface for registering and executing commandsConsoleEngine
- Interface for managing console variables, commands, and script executionSystemRegistry
- Interface for executing commands and managing the console environmentPrinter
- Interface for printing objects to the console with various formatting optionsCmdDesc
- Class for describing commands and their argumentsArgDesc
- Class for describing command argumentsCmdLine
- Class for representing a parsed command lineCommandInput
- Class for encapsulating command input and output streams
The console package is designed to be used with the JLine reader package to create interactive command-line applications with features like command completion, command history, and command help.
-
Interface Summary Interface Description CommandRegistry Interface for registering, describing, and executing commands in a console application.ConsoleEngine Interface for managing console variables, commands, and script execution in a console application.Printer Interface for printing objects to the console with various formatting options.ScriptEngine Interface for managing script engine variables, statements, and script execution.SystemRegistry Interface for aggregating command registries and dispatching command executions in a console application. -
Class Summary Class Description ArgDesc Represents a command argument description used for generating command help and documentation.CmdDesc Represents a command description used for generating command help and documentation.CmdLine Represents a command line with its parsed components.CommandInput Encapsulates the input and output streams for a command execution.CommandMethods Class that encapsulates the execution and completion methods for a command.CommandRegistry.CommandSession Class representing a command execution session.ConsoleEngine.ExecutionResult Class representing the result of executing a command.ConsoleEngine.WidgetCreator Class for creating widgets from console functions.SystemRegistry.Registeries Class for managing the system registry store. -
Enum Summary Enum Description CmdLine.DescriptionType Enumeration specifying the type of description that should be displayed for the command.Printer.TableRows Enumeration specifying which rows in a table should be highlighted.