Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractCommandRegistry - Class in org.jline.console.impl
-
Abstract base class implementing common methods for command registries.
- AbstractCommandRegistry() - Constructor for class org.jline.console.impl.AbstractCommandRegistry
-
Creates a new AbstractCommandRegistry.
- add(SystemRegistry) - Static method in interface org.jline.console.SystemRegistry
-
Associates a system registry with the current thread.
- addCompleter(Completer) - Method in class org.jline.console.impl.SystemRegistryImpl
- addExternalHighlighterRefresh(Supplier<Boolean>) - Method in class org.jline.console.impl.SystemHighlighter
- addFileHighlight(String...) - Method in class org.jline.console.impl.SystemHighlighter
- addFileHighlight(String, String, Collection<String>) - Method in class org.jline.console.impl.SystemHighlighter
- addRegistry(SystemRegistry) - Method in class org.jline.console.SystemRegistry.Registeries
- addWidget(String, Widget) - Method in class org.jline.widget.Widgets
-
Add widget to the LineReader
- aggregateCompleters(CommandRegistry...) - Static method in interface org.jline.console.CommandRegistry
-
Aggregates SystemCompleters from multiple command registries into a single completer.
- alias(String, String) - Method in class org.jline.console.impl.AbstractCommandRegistry
- ALIAS - Enum constant in enum class org.jline.console.impl.ConsoleEngineImpl.Command
- aliasWidget(String, String) - Method in class org.jline.widget.Widgets
-
Create alias to widget
- ALL - Enum constant in enum class org.jline.console.Printer.TableRows
-
Highlight all rows in the table.
- ALL - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: TABLE
Ignore columnsOut configuration. - AND - Enum constant in enum class org.jline.console.impl.SystemRegistryImpl.Pipe
- AP_BACKWARD_DELETE_CHAR - Static variable in class org.jline.widget.Widgets
- AP_INSERT - Static variable in class org.jline.widget.Widgets
- append() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- appendUsage(String[]) - Method in class org.jline.console.impl.DefaultPrinter
- apply() - Method in class org.jline.console.ConsoleEngine.WidgetCreator
-
Executes the function when the widget is applied.
- ArgDesc - Class in org.jline.console
-
Represents a command argument description used for generating command help and documentation.
- ArgDesc(String) - Constructor for class org.jline.console.ArgDesc
-
Creates a new argument description with the specified name and an empty description.
- ArgDesc(String, List<AttributedString>) - Constructor for class org.jline.console.ArgDesc
-
Creates a new argument description with the specified name and description.
- args() - Method in class org.jline.console.CommandInput
-
Returns the command arguments as strings.
- args() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- args() - Method in class org.jline.widget.Widgets
-
Parse lineReader buffer and returns its arguments
- argsHighlighter - Variable in class org.jline.console.impl.SystemHighlighter
- AUTOPAIR_TOGGLE - Static variable in class org.jline.widget.Widgets
- autopairClose() - Method in class org.jline.widget.AutopairWidgets
- autopairDelete() - Method in class org.jline.widget.AutopairWidgets
- autopairInsert() - Method in class org.jline.widget.AutopairWidgets
- AutopairWidgets - Class in org.jline.widget
-
Creates and manages widgets that intelligently handle matching delimiters in the console.
- AutopairWidgets(LineReader) - Constructor for class org.jline.widget.AutopairWidgets
- AutopairWidgets(LineReader, boolean) - Constructor for class org.jline.widget.AutopairWidgets
- AUTOSUGGEST_TOGGLE - Static variable in class org.jline.widget.Widgets
- autosuggestEndOfLine() - Method in class org.jline.widget.AutosuggestionWidgets
- autosuggestForwardChar() - Method in class org.jline.widget.AutosuggestionWidgets
- AutosuggestionWidgets - Class in org.jline.widget
-
Creates and manages widgets for as-you-type command line suggestions based on command history.
- AutosuggestionWidgets(LineReader) - Constructor for class org.jline.widget.AutosuggestionWidgets
B
- BOOLEAN_KEYS - Static variable in interface org.jline.console.Printer
- BORDER - Static variable in interface org.jline.console.Printer
-
Value: String
Applies: TABLE
Table cell vertical border character. - buffer() - Method in class org.jline.widget.Widgets
-
Get lineReader's buffer
- Builtins - Class in org.jline.console.impl
-
Implementation of CommandRegistry that provides built-in commands for JLine.
- Builtins(Path, ConfigurationPath, Function<String, Widget>) - Constructor for class org.jline.console.impl.Builtins
- Builtins(Supplier<Path>, ConfigurationPath, Function<String, Widget>) - Constructor for class org.jline.console.impl.Builtins
- Builtins(Set<Builtins.Command>, Path, ConfigurationPath, Function<String, Widget>) - Constructor for class org.jline.console.impl.Builtins
- Builtins(Set<Builtins.Command>, Supplier<Path>, ConfigurationPath, Function<String, Widget>) - Constructor for class org.jline.console.impl.Builtins
- Builtins.Command - Enum Class in org.jline.console.impl
-
Enumeration of built-in commands provided by this class.
C
- callWidget(String) - Method in class org.jline.widget.Widgets
-
Call widget.
- cleanUp() - Method in class org.jline.console.impl.SystemRegistryImpl
- cleanUp() - Method in interface org.jline.console.SystemRegistry
-
Deletes temporary console variables and resets output streams.
- clearDescription() - Method in class org.jline.widget.TailTipWidgets
- clearDescription() - Method in class org.jline.widget.Widgets
-
Clears terminal status bar
- clearTailTip() - Method in class org.jline.widget.Widgets
-
Clears command line command hint
- close() - Method in class org.jline.console.impl.SystemRegistryImpl
- close() - Method in interface org.jline.console.SystemRegistry
-
Orderly closes this system registry.
- CmdDesc - Class in org.jline.console
-
Represents a command description used for generating command help and documentation.
- CmdDesc() - Constructor for class org.jline.console.CmdDesc
-
Creates a new command description that is not a command.
- CmdDesc(boolean) - Constructor for class org.jline.console.CmdDesc
-
Creates a new command description with the specified validity.
- CmdDesc(List<ArgDesc>) - Constructor for class org.jline.console.CmdDesc
-
Creates a new command description with the specified argument descriptions.
- CmdDesc(List<ArgDesc>, Map<String, List<AttributedString>>) - Constructor for class org.jline.console.CmdDesc
-
Creates a new command description with the specified argument and option descriptions.
- CmdDesc(List<AttributedString>, List<ArgDesc>, Map<String, List<AttributedString>>) - Constructor for class org.jline.console.CmdDesc
-
Creates a new command description with the specified main description, argument descriptions, and option descriptions.
- CmdLine - Class in org.jline.console
-
Represents a command line with its parsed components.
- CmdLine(String, String, String, List<String>, CmdLine.DescriptionType) - Constructor for class org.jline.console.CmdLine
-
Creates a new command line with the specified components.
- CmdLine.DescriptionType - Enum Class in org.jline.console
-
Enumeration specifying the type of description that should be displayed for the command.
- COLORS - Enum constant in enum class org.jline.console.impl.Builtins.Command
- COLUMNS - Static variable in interface org.jline.console.Printer
-
Value:
List<String>
Applies: MAP and TABLE
Display given keys/columns on map/table. - COLUMNS_IN - Static variable in interface org.jline.console.Printer
-
Value:
List<String>
Applies: TABLE
These map values will be added to the table before all the other keys. - COLUMNS_OUT - Static variable in interface org.jline.console.Printer
-
Value:
List<String>
Applies: TABLE
These map values will not be inserted to the table. - COMBINED - Enum constant in enum class org.jline.widget.TailTipWidgets.TipType
-
Prepare command line suggestions using either a command's positional argument descriptions if they exist, or command completer data if no argument descriptions are available.
- command() - Method in class org.jline.console.CommandInput
-
Returns the command name.
- command() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- COMMAND - Enum constant in enum class org.jline.console.CmdLine.DescriptionType
-
Cursor is at the end of line.
- commandAliases() - Method in interface org.jline.console.CommandRegistry
-
Returns a map of alias-to-command names known by this registry.
- commandAliases() - Method in class org.jline.console.impl.AbstractCommandRegistry
- commandAliases() - Method in class org.jline.console.impl.SystemRegistryImpl
- CommandData(SystemRegistryImpl.ArgsParser, boolean, String, String, File, boolean, String) - Constructor for class org.jline.console.impl.SystemRegistryImpl.CommandData
- commandDescription(List<String>) - Method in interface org.jline.console.CommandRegistry
-
Returns a command description for use in the JLine Widgets framework.
- commandDescription(List<String>) - Method in class org.jline.console.impl.JlineCommandRegistry
- commandDescription(List<String>) - Method in class org.jline.console.impl.SystemRegistryImpl
- commandDescription(CmdLine) - Method in class org.jline.console.impl.SystemRegistryImpl
- commandDescription(CmdLine) - Method in interface org.jline.console.SystemRegistry
-
Returns a description for a command, method, or syntax for use in the JLine Widgets framework.
- commandHighlighter - Variable in class org.jline.console.impl.SystemHighlighter
- commandIndex - Variable in class org.jline.console.impl.SystemHighlighter
- commandInfo(String) - Method in interface org.jline.console.CommandRegistry
-
Returns a short info about command known by this registry.
- commandInfo(String) - Method in class org.jline.console.impl.JlineCommandRegistry
- commandInfo(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- CommandInput - Class in org.jline.console
-
Encapsulates the input and output streams for a command execution.
- CommandInput(String, Object[], CommandRegistry.CommandSession) - Constructor for class org.jline.console.CommandInput
-
Creates a new CommandInput with the specified command, arguments, and session.
- CommandInput(String, Object[], Terminal, InputStream, PrintStream, PrintStream) - Constructor for class org.jline.console.CommandInput
-
Creates a new CommandInput with the specified command, arguments, terminal, and I/O streams.
- CommandMethods - Class in org.jline.console
-
Class that encapsulates the execution and completion methods for a command.
- CommandMethods(Consumer<CommandInput>, Function<String, List<Completer>>) - Constructor for class org.jline.console.CommandMethods
-
Creates a new CommandMethods with the specified execution and completer compilation functions.
- CommandMethods(Function<CommandInput, ?>, Function<String, List<Completer>>) - Constructor for class org.jline.console.CommandMethods
-
Creates a new CommandMethods with the specified execution and completer compilation functions.
- commandNames() - Method in interface org.jline.console.CommandRegistry
-
Returns the command names known by this registry.
- commandNames() - Method in class org.jline.console.impl.AbstractCommandRegistry
- commandNames() - Method in class org.jline.console.impl.SystemRegistryImpl
- commandOptions(String) - Method in class org.jline.console.impl.JlineCommandRegistry
- CommandRegistry - Interface in org.jline.console
-
Interface for registering, describing, and executing commands in a console application.
- CommandRegistry.CommandSession - Class in org.jline.console
-
Class representing a command execution session.
- CommandSession() - Constructor for class org.jline.console.CommandRegistry.CommandSession
-
Creates a new command session with the system's standard I/O streams.
- CommandSession(Terminal) - Constructor for class org.jline.console.CommandRegistry.CommandSession
-
Creates a new command session with the specified terminal.
- CommandSession(Terminal, InputStream, PrintStream, PrintStream) - Constructor for class org.jline.console.CommandRegistry.CommandSession
-
Creates a new command session with the specified terminal and I/O streams.
- compileCommandDescription(String) - Static method in class org.jline.console.impl.JlineCommandRegistry
- compileCommandInfo(String) - Static method in class org.jline.console.impl.JlineCommandRegistry
- compileCommandOptions(String) - Static method in class org.jline.console.impl.JlineCommandRegistry
- compileCompleter() - Method in class org.jline.console.CommandMethods
-
Returns the function that compiles completers for the command.
- compileCompleters() - Method in interface org.jline.console.CommandRegistry
-
Returns a
SystemCompleter
that can provide detailed completion information for all registered commands. - compileCompleters() - Method in class org.jline.console.impl.AbstractCommandRegistry
- compileCompleters() - Method in class org.jline.console.impl.SystemRegistryImpl
- compileCompleters(CommandRegistry...) - Static method in interface org.jline.console.CommandRegistry
-
Aggregates and compiles SystemCompleters from multiple command registries into a single completer.
- compileOptions(Options) - Method in class org.jline.console.impl.DefaultPrinter
- completer() - Method in class org.jline.console.impl.SystemRegistryImpl
- completer() - Method in interface org.jline.console.SystemRegistry
-
Returns a command completer that includes console variable and script completion.
- COMPLETER - Enum constant in enum class org.jline.widget.TailTipWidgets.TipType
-
Prepare command line suggestions using a command's completer data.
- configPath - Variable in class org.jline.console.impl.SystemRegistryImpl
- consoleEngine() - Method in class org.jline.console.impl.SystemRegistryImpl
- ConsoleEngine - Interface in org.jline.console
-
Interface for managing console variables, commands, and script execution in a console application.
- ConsoleEngine.ExecutionResult - Class in org.jline.console
-
Class representing the result of executing a command.
- ConsoleEngine.WidgetCreator - Class in org.jline.console
-
Class for creating widgets from console functions.
- ConsoleEngineImpl - Class in org.jline.console.impl
-
Manage console variables, commands and script execution.
- ConsoleEngineImpl(Set<ConsoleEngineImpl.Command>, ScriptEngine, Printer, Supplier<Path>, ConfigurationPath) - Constructor for class org.jline.console.impl.ConsoleEngineImpl
- ConsoleEngineImpl(ScriptEngine, Printer, Supplier<Path>, ConfigurationPath) - Constructor for class org.jline.console.impl.ConsoleEngineImpl
- ConsoleEngineImpl.Command - Enum Class in org.jline.console.impl
- consoleOption(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- consoleOption(String) - Method in interface org.jline.console.SystemRegistry
-
Returns the value of a console option.
- consoleOption(String, T) - Method in interface org.jline.console.ConsoleEngine
-
Reads a console option value with a default value if the option doesn't exist.
- consoleOption(String, T) - Method in class org.jline.console.impl.ConsoleEngineImpl
- consoleOption(String, T) - Method in class org.jline.console.impl.SimpleSystemRegistryImpl
- consoleOption(String, T) - Method in class org.jline.console.impl.SystemRegistryImpl
- consoleOption(String, T) - Method in interface org.jline.console.SystemRegistry
-
Returns the value of a console option with a default value if the option doesn't exist.
- createCandidate(CommandRegistry[], String) - Static method in interface org.jline.console.CommandRegistry
-
Creates a completion candidate for the specified command.
- currChar() - Method in class org.jline.widget.Widgets
-
Access lineReader's buffer and return its current character
D
- defaultCompleter(String) - Method in class org.jline.console.impl.JlineCommandRegistry
- DefaultPrinter - Class in org.jline.console.impl
-
Default implementation of the Printer interface that provides syntax highlighting and formatting.
- DefaultPrinter(ConfigurationPath) - Constructor for class org.jline.console.impl.DefaultPrinter
- DefaultPrinter(ScriptEngine, ConfigurationPath) - Constructor for class org.jline.console.impl.DefaultPrinter
- defaultPrntOptions(boolean) - Method in class org.jline.console.impl.DefaultPrinter
-
Set default and mandatory printing options.
- del(String...) - Method in interface org.jline.console.ScriptEngine
-
Deletes variables from the script engine's context.
- DEL - Enum constant in enum class org.jline.console.impl.ConsoleEngineImpl.Command
- deserialize(String) - Method in interface org.jline.console.ScriptEngine
-
Deserializes a value from its string representation.
- deserialize(String, String) - Method in interface org.jline.console.ScriptEngine
-
Deserializes a value from its string representation using the specified format.
- destroyDescription() - Method in class org.jline.widget.Widgets
-
Remove terminal status bar
- disable() - Method in class org.jline.widget.AutopairWidgets
- disable() - Method in class org.jline.widget.AutosuggestionWidgets
- disable() - Method in class org.jline.widget.TailTipWidgets
- doArgNames(List<String>) - Static method in class org.jline.console.ArgDesc
-
Creates a list of argument descriptions from a list of argument names.
- DOC - Enum constant in enum class org.jline.console.impl.ConsoleEngineImpl.Command
- doCommandHighlight(String) - Method in class org.jline.console.impl.SystemHighlighter
- doFileArgsHighlight(LineReader, String, List<String>, SystemHighlighter.FileHighlightCommand) - Method in class org.jline.console.impl.SystemHighlighter
- doFileOptsHighlight(LineReader, String, List<String>, SystemHighlighter.FileHighlightCommand) - Method in class org.jline.console.impl.SystemHighlighter
- doHelpDesc(String, List<String>, CmdDesc) - Method in class org.jline.console.impl.AbstractCommandRegistry
-
Creates a command description for a help command.
E
- enable() - Method in class org.jline.widget.AutopairWidgets
- enable() - Method in class org.jline.widget.AutosuggestionWidgets
- enable() - Method in class org.jline.widget.TailTipWidgets
- err() - Method in class org.jline.console.CommandInput
-
Returns the error stream for this command.
- err() - Method in class org.jline.console.CommandRegistry.CommandSession
-
Returns the error stream for the command session.
- EVEN - Enum constant in enum class org.jline.console.Printer.TableRows
-
Highlight only even-numbered rows in the table.
- EXCLUDE - Static variable in interface org.jline.console.Printer
-
Value:
List<String>
Applies: TABLE
Exclude given columns on table. - execute() - Method in class org.jline.console.CommandMethods
-
Returns the function that executes the command.
- execute(File) - Method in interface org.jline.console.ConsoleEngine
-
Executes either a JLine script or a ScriptEngine script.
- execute(File) - Method in interface org.jline.console.ScriptEngine
-
Executes a script from a file.
- execute(File, Object[]) - Method in interface org.jline.console.ScriptEngine
-
Executes a script from a file with the specified arguments.
- execute(File, String, String[]) - Method in interface org.jline.console.ConsoleEngine
-
Executes either a JLine script or a ScriptEngine script with the specified arguments.
- execute(Object, Object...) - Method in interface org.jline.console.ScriptEngine
-
Executes a script engine closure with the specified arguments.
- execute(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- execute(String) - Method in interface org.jline.console.ScriptEngine
-
Executes a script engine statement.
- execute(String) - Method in interface org.jline.console.SystemRegistry
-
Executes a command, script, or evaluates a script engine statement.
- execute(String, String, String[]) - Method in interface org.jline.console.ConsoleEngine
-
Executes a command line that does not contain a command known by the system registry.
- execute(String, String, String[]) - Method in class org.jline.console.impl.ConsoleEngineImpl
- execute(Path) - Method in interface org.jline.console.ScriptEngine
-
Executes a script from a file.
- execute(Path, Object[]) - Method in interface org.jline.console.ScriptEngine
-
Executes a script from a file with the specified arguments.
- execute(Path, String, String[]) - Method in interface org.jline.console.ConsoleEngine
-
Executes either a JLine script or a ScriptEngine script with the specified arguments.
- execute(Path, String, String[]) - Method in class org.jline.console.impl.ConsoleEngineImpl
- executeWidget(Object) - Method in interface org.jline.console.ConsoleEngine
-
Executes a widget function.
- executeWidget(Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
- executeWidget(String) - Method in class org.jline.widget.Widgets
-
Bind widget to ctrl-alt-x and execute it
- ExecutionResult(int, Object) - Constructor for class org.jline.console.ConsoleEngine.ExecutionResult
-
Creates a new execution result with the specified status code and result value.
- existsWidget(String) - Method in class org.jline.widget.Widgets
-
Test if widget exists
- expandCommandLine(String) - Method in interface org.jline.console.ConsoleEngine
-
Substitutes a command line with a system registry invoke method call.
- expandCommandLine(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- expandParameters(String[]) - Method in interface org.jline.console.ConsoleEngine
-
Substitutes argument references with their values.
- expandParameters(String[]) - Method in class org.jline.console.impl.ConsoleEngineImpl
- expandToList(List<String>) - Method in interface org.jline.console.ConsoleEngine
-
Expands a list of script parameters to a string representation.
- expandToList(List<String>) - Method in class org.jline.console.impl.ConsoleEngineImpl
F
- file() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- fileHighlight - Variable in class org.jline.console.impl.SystemHighlighter
- FileHighlightCommand() - Constructor for class org.jline.console.impl.SystemHighlighter.FileHighlightCommand
- FileHighlightCommand(String, Collection<String>) - Constructor for class org.jline.console.impl.SystemHighlighter.FileHighlightCommand
- find() - Method in interface org.jline.console.ScriptEngine
-
Gets all variables with their values from the script engine's context.
- find(String) - Method in interface org.jline.console.ScriptEngine
-
Gets all variables that match the specified pattern.
- FLIP - Enum constant in enum class org.jline.console.impl.SystemRegistryImpl.Pipe
G
- get() - Static method in interface org.jline.console.SystemRegistry
-
Returns the system registry associated with the current thread.
- get(String) - Method in interface org.jline.console.ScriptEngine
-
Gets the value of a variable from the script engine's context.
- getAlias(String) - Method in interface org.jline.console.ConsoleEngine
-
Returns the value of the alias with the specified name.
- getAlias(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- getArgs() - Method in class org.jline.console.CmdLine
-
Returns the parsed command line arguments.
- getArgsDesc() - Method in class org.jline.console.CmdDesc
-
Returns the descriptions of the command's arguments.
- getCommandMethods(String) - Method in class org.jline.console.impl.AbstractCommandRegistry
- getDescription() - Method in class org.jline.console.ArgDesc
-
Returns the description of the argument as a list of attributed strings.
- getDescriptionSize() - Method in class org.jline.widget.TailTipWidgets
- getDescriptionType() - Method in class org.jline.console.CmdLine
-
Returns the type of description that should be displayed for the command.
- getDeserializationFormats() - Method in interface org.jline.console.ScriptEngine
-
Returns the deserialization formats supported by this script engine.
- getEngineName() - Method in interface org.jline.console.ScriptEngine
-
Returns the name of the underlying script engine.
- getErrorIndex() - Method in class org.jline.console.CmdDesc
-
Returns the index of the error in the command.
- getErrorPattern() - Method in class org.jline.console.CmdDesc
-
Returns the pattern used to identify errors in the command.
- getExtensions() - Method in interface org.jline.console.ScriptEngine
-
Returns the file name extensions associated with this script engine.
- getFileOptions() - Method in class org.jline.console.impl.SystemHighlighter.FileHighlightCommand
- getHead() - Method in class org.jline.console.CmdLine
-
Returns the part of the command line before the cursor, with method parameters and opening parenthesis removed.
- getInstance() - Static method in class org.jline.console.SystemRegistry.Registeries
- getKeyMap() - Method in class org.jline.widget.Widgets
-
Get lineReader's Main KeyMap
- getLine() - Method in class org.jline.console.CmdLine
-
Returns the original command line.
- getMainDesc() - Method in class org.jline.console.CmdDesc
-
Returns the main description of the command.
- getName() - Method in class org.jline.console.ArgDesc
-
Returns the name of the argument.
- getNamedPipes() - Method in interface org.jline.console.ConsoleEngine
-
Returns the names of all named pipes.
- getNamedPipes() - Method in class org.jline.console.impl.ConsoleEngineImpl
- getOptsDesc() - Method in class org.jline.console.CmdDesc
-
Returns the descriptions of the command's options.
- getPipeNames() - Method in class org.jline.console.impl.SystemRegistryImpl
- getPipeNames() - Method in interface org.jline.console.SystemRegistry
-
Returns the names of all pipes defined in this system registry.
- getPipes() - Method in interface org.jline.console.ConsoleEngine
-
Returns all defined pipes.
- getPipes() - Method in class org.jline.console.impl.ConsoleEngineImpl
- getScriptCompleter() - Method in interface org.jline.console.ScriptEngine
-
Returns a completer for script-specific syntax.
- getSerializationFormats() - Method in interface org.jline.console.ScriptEngine
-
Returns the serialization formats supported by this script engine.
- getSubcommand() - Method in class org.jline.console.impl.SystemHighlighter.FileHighlightCommand
- getSystemRegistry() - Method in class org.jline.console.SystemRegistry.Registeries
- getTail() - Method in class org.jline.console.CmdLine
-
Returns the part of the command line after the cursor, with method parameters and closing parenthesis removed.
- getTipType() - Method in class org.jline.widget.TailTipWidgets
- getVariable(String) - Method in interface org.jline.console.ConsoleEngine
-
Gets the value of a console variable.
- getVariable(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- getWidget(String) - Method in class org.jline.widget.Widgets
-
Resolve widget name if its alias is given as method parameter.
- groupCommandsInHelp(boolean) - Method in class org.jline.console.impl.SystemRegistryImpl
H
- hasAlias(String) - Method in interface org.jline.console.ConsoleEngine
-
Checks if an alias with the specified name exists.
- hasAlias(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- hasCommand(String) - Method in interface org.jline.console.CommandRegistry
-
Returns whether a command with the specified name is known to this registry.
- hasCommand(String) - Method in class org.jline.console.impl.AbstractCommandRegistry
- hasCommand(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- hasFileOptions() - Method in class org.jline.console.impl.SystemHighlighter.FileHighlightCommand
- hasVariable(String) - Method in interface org.jline.console.ConsoleEngine
-
Tests if a variable with the specified name exists.
- hasVariable(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- hasVariable(String) - Method in interface org.jline.console.ScriptEngine
-
Tests if a variable exists in the script engine's context.
- highlight(LineReader, String) - Method in class org.jline.console.impl.SystemHighlighter
- HIGHLIGHT_VALUE - Static variable in interface org.jline.console.Printer
-
Value:
Map<regex, function>
.
Applies: TABLE
If command result map key matches with regex the highlight function is applied to the corresponding map value. - highlightAndPrint(Map<String, Object>, Throwable) - Method in class org.jline.console.impl.DefaultPrinter
-
Highlight and print an exception
- HIGHLIGHTER - Enum constant in enum class org.jline.console.impl.Builtins.Command
- HISTORY - Enum constant in enum class org.jline.console.impl.Builtins.Command
I
- in() - Method in class org.jline.console.CommandInput
-
Returns the input stream for this command.
- in() - Method in class org.jline.console.CommandRegistry.CommandSession
-
Returns the input stream for the command session.
- INCLUDE - Static variable in interface org.jline.console.Printer
-
Value:
List<String>
Applies: TABLE
Include given columns on table. - INDENTION - Static variable in interface org.jline.console.Printer
-
Value: Integer
Applies: MAP
Indention size. - initDescription() - Method in class org.jline.widget.TailTipWidgets
-
Initialize terminal status bar
- initialize(File) - Method in class org.jline.console.impl.SystemRegistryImpl
- initialize(File) - Method in interface org.jline.console.SystemRegistry
-
Initializes the console engine environment by executing a console script.
- invoke(String, Object...) - Method in class org.jline.console.impl.SystemRegistryImpl
- invoke(String, Object...) - Method in interface org.jline.console.SystemRegistry
-
Executes a command with the specified arguments.
- invoke(CommandRegistry.CommandSession, String, Object...) - Method in interface org.jline.console.CommandRegistry
-
Execute a command.
- invoke(CommandRegistry.CommandSession, String, Object...) - Method in class org.jline.console.impl.AbstractCommandRegistry
- invoke(CommandRegistry.CommandSession, String, Object...) - Method in class org.jline.console.impl.ConsoleEngineImpl
- isCommand() - Method in class org.jline.console.CmdDesc
-
Returns whether this is a command (as opposed to a method or syntax).
- isCommandAlias(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- isCommandAlias(String) - Method in interface org.jline.console.SystemRegistry
-
Checks if an alias is a known command alias.
- isCommandOrScript(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- isCommandOrScript(String) - Method in interface org.jline.console.SystemRegistry
-
Checks if a command or script is known to this registry.
- isCommandOrScript(ParsedLine) - Method in class org.jline.console.impl.SystemRegistryImpl
- isCommandOrScript(ParsedLine) - Method in interface org.jline.console.SystemRegistry
-
Checks if a parsed line contains a command or script that is known to this registry.
- isEnabled() - Method in class org.jline.widget.TailTipWidgets
- isExecuting() - Method in interface org.jline.console.ConsoleEngine
-
Checks if the console engine is currently executing a script.
- isExecuting() - Method in class org.jline.console.impl.ConsoleEngineImpl
- isHighlighted() - Method in class org.jline.console.CmdDesc
-
Returns whether the command should be highlighted.
- isSubcommand() - Method in class org.jline.console.CmdDesc
-
Returns whether this is a subcommand.
- isSubcommand() - Method in class org.jline.console.impl.SystemHighlighter.FileHighlightCommand
- isValid() - Method in class org.jline.console.CmdDesc
-
Returns whether the command is valid.
J
- JlineCommandRegistry - Class in org.jline.console.impl
-
CommandRegistry common methods for JLine commands that are using HelpException.
- JlineCommandRegistry() - Constructor for class org.jline.console.impl.JlineCommandRegistry
K
- KEYMAP - Enum constant in enum class org.jline.console.impl.Builtins.Command
L
- langHighlighter - Variable in class org.jline.console.impl.SystemHighlighter
- lastBinding() - Method in class org.jline.widget.Widgets
-
Get lineReader's last binding
- LESS - Enum constant in enum class org.jline.console.impl.Builtins.Command
M
- mainDesc(List<AttributedString>) - Method in class org.jline.console.CmdDesc
-
Sets the main description of the command and returns this command description.
- manageBooleanOptions(Map<String, Object>) - Method in class org.jline.console.impl.DefaultPrinter
-
Boolean printing options Printer checks only if key is present.
- MAP_SIMILARITY - Static variable in interface org.jline.console.Printer
-
Value: Double
Applies: MAP and TABLE
default value 0.8 i.e. - MAX_COLUMN_WIDTH - Static variable in interface org.jline.console.Printer
-
Value: Integer
Applies: MAP and TABLE
Maximum column width. - MAX_DEPTH - Static variable in interface org.jline.console.Printer
-
Value: Integer
Applies: MAP
Maximum depth objects are resolved. - MAXROWS - Static variable in interface org.jline.console.Printer
-
Value: Integer
Applies: MAP and TABLE
Maximum number of lines to display. - METHOD - Enum constant in enum class org.jline.console.CmdLine.DescriptionType
-
The part of the line from beginning till cursor has unclosed opening parenthesis.
- MULTI_COLUMNS - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: TABLE
List the collection of simple values in multiple columns DEFAULT: list values in one column
N
- name() - Method in interface org.jline.console.CommandRegistry
-
Returns the name of this registry.
- NAMED - Enum constant in enum class org.jline.console.impl.SystemRegistryImpl.Pipe
- NANO - Enum constant in enum class org.jline.console.impl.Builtins.Command
O
- OBJECT_TO_MAP - Static variable in interface org.jline.console.Printer
-
Value:
Map<class, function>
Applies: MAP and TABLE
Overrides the ScriptEngine toMap() method. - OBJECT_TO_STRING - Static variable in interface org.jline.console.Printer
-
Value:
Map<class, function>
Applies: MAP and TABLE
Overrides the ScriptEngine toString() method. - ODD - Enum constant in enum class org.jline.console.Printer.TableRows
-
Highlight only odd-numbered rows in the table.
- ONE_ROW_TABLE - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: TABLE
Display one row data on table. - optionDescription(String) - Method in class org.jline.console.CmdDesc
-
Returns the description of the specified option.
- optionWithValue(String) - Method in class org.jline.console.CmdDesc
-
Returns whether the specified option takes a value.
- OR - Enum constant in enum class org.jline.console.impl.SystemRegistryImpl.Pipe
- org.jline.console - package org.jline.console
-
JLine Console package provides a framework for building interactive command-line applications.
- org.jline.console.impl - package org.jline.console.impl
- org.jline.widget - package org.jline.widget
-
JLine Widget package provides a framework for creating and managing widgets for JLine's LineReader.
- out() - Method in class org.jline.console.CommandInput
-
Returns the output stream for this command.
- out() - Method in class org.jline.console.CommandRegistry.CommandSession
-
Returns the output stream for the command session.
P
- parseOptions(String[], Object[]) - Method in class org.jline.console.impl.JlineCommandRegistry
- parser - Variable in class org.jline.console.impl.SystemRegistryImpl
- parser() - Method in class org.jline.widget.Widgets
-
Get lineReader's parser
- partialAccept() - Method in class org.jline.widget.AutosuggestionWidgets
- persist(Path, Object) - Method in interface org.jline.console.ConsoleEngine
-
Persists an object to a file.
- persist(Path, Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
- persist(Path, Object) - Method in interface org.jline.console.ScriptEngine
-
Persists an object to a file.
- persist(Path, Object, String) - Method in interface org.jline.console.ScriptEngine
-
Persists an object to a file using the specified serialization format.
- pipe() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- PIPE - Enum constant in enum class org.jline.console.impl.ConsoleEngineImpl.Command
- plainCommand(String) - Static method in interface org.jline.console.ConsoleEngine
-
Removes the first character of the command name if it is a colon.
- postProcess(Object) - Method in interface org.jline.console.ConsoleEngine
-
Post-processes the result of executing a command.
- postProcess(Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
- postProcess(String, Object, String) - Method in interface org.jline.console.ConsoleEngine
-
Post-processes the result of executing a command.
- postProcess(String, Object, String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- prevChar() - Method in class org.jline.widget.Widgets
-
Access lineReader buffer and return its previous character
- Printer - Interface in org.jline.console
-
Interface for printing objects to the console with various formatting options.
- Printer.TableRows - Enum Class in org.jline.console
-
Enumeration specifying which rows in a table should be highlighted.
- println(Object) - Method in interface org.jline.console.ConsoleEngine
-
Prints an object to the console.
- println(Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
- println(Object) - Method in class org.jline.console.impl.DefaultPrinter
- println(Object) - Method in interface org.jline.console.Printer
-
Prints an object to the console using default formatting options.
- println(Map<String, Object>, Object) - Method in class org.jline.console.impl.DefaultPrinter
- println(Map<String, Object>, Object) - Method in interface org.jline.console.Printer
-
Prints an object to the console with the specified formatting options.
- PRNT - Enum constant in enum class org.jline.console.impl.ConsoleEngineImpl.Command
- PRNT_INDENTION - Static variable in class org.jline.console.impl.DefaultPrinter
- PRNT_MAX_DEPTH - Static variable in class org.jline.console.impl.DefaultPrinter
- PRNT_MAX_ROWS - Static variable in class org.jline.console.impl.DefaultPrinter
- prntCommand(CommandInput) - Method in class org.jline.console.impl.DefaultPrinter
- prntCommand(CommandInput) - Method in interface org.jline.console.Printer
-
Executes a print command with the given input.
- purge() - Method in interface org.jline.console.ConsoleEngine
-
Deletes temporary console variables.
- purge() - Method in class org.jline.console.impl.ConsoleEngineImpl
- put(String, Object) - Method in interface org.jline.console.ScriptEngine
-
Creates or updates a variable in the script engine's context.
- putString(String) - Method in class org.jline.widget.Widgets
-
Write the string parameter to the lineReader's buffer
- putVariable(String, Object) - Method in interface org.jline.console.ConsoleEngine
-
Creates or updates a console variable.
- putVariable(String, Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
R
- rawLine() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- reader - Variable in class org.jline.widget.Widgets
-
The LineReader instance associated with these widgets
- refresh() - Method in class org.jline.console.impl.DefaultPrinter
- refresh() - Method in interface org.jline.console.Printer
-
Clears the printer's syntax highlighter cache and refreshes internal state.
- refresh(LineReader) - Method in class org.jline.console.impl.SystemHighlighter
- register(String, CommandRegistry) - Method in class org.jline.console.impl.SystemRegistryImpl
-
Register subcommand registry
- register(String, CommandRegistry) - Method in interface org.jline.console.SystemRegistry
-
Registers a subcommand registry for a main command.
- registerCommands(Map<String, CommandMethods>) - Method in class org.jline.console.impl.AbstractCommandRegistry
- registerCommands(Map<T, String>, Map<T, CommandMethods>) - Method in class org.jline.console.impl.AbstractCommandRegistry
- registeredCommand(String) - Method in class org.jline.console.impl.AbstractCommandRegistry
- remove() - Static method in interface org.jline.console.SystemRegistry
-
Removes the system registry association from the current thread.
- removeRegistry() - Method in class org.jline.console.SystemRegistry.Registeries
- rename(SystemRegistryImpl.Pipe, String) - Method in class org.jline.console.impl.SystemRegistryImpl
- rename(V, String) - Method in class org.jline.console.impl.AbstractCommandRegistry
- replaceBuffer(Buffer) - Method in class org.jline.widget.Widgets
-
Replace lineReader buffer
- result() - Method in class org.jline.console.ConsoleEngine.ExecutionResult
-
Returns the result value of the command execution.
- ROW_HIGHLIGHT - Static variable in interface org.jline.console.Printer
-
Value: TableRows
Applies: TABLE
Highlight table rows. - ROWNUM - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: TABLE
Display table row numbers.
S
- saveException(Exception) - Method in class org.jline.console.impl.AbstractCommandRegistry
- scriptCompleters() - Method in interface org.jline.console.ConsoleEngine
-
Returns completers for scripts and variables.
- scriptCompleters() - Method in class org.jline.console.impl.ConsoleEngineImpl
- ScriptEngine - Interface in org.jline.console
-
Interface for managing script engine variables, statements, and script execution.
- scripts() - Method in interface org.jline.console.ConsoleEngine
-
Returns all scripts found in the PATH environment variable.
- scripts() - Method in class org.jline.console.impl.ConsoleEngineImpl
- session() - Method in class org.jline.console.CommandInput
-
Creates and returns a new CommandSession using this command's terminal and I/O streams.
- setCommandRegistries(CommandRegistry...) - Method in class org.jline.console.impl.SystemRegistryImpl
- setCommandRegistries(CommandRegistry...) - Method in interface org.jline.console.SystemRegistry
-
Sets the command registries to be used by this system registry.
- setConsoleOption(String, Object) - Method in interface org.jline.console.ConsoleEngine
-
Sets a console option value.
- setConsoleOption(String, Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
- setConsoleOption(String, Object) - Method in class org.jline.console.impl.SimpleSystemRegistryImpl
- setConsoleOption(String, Object) - Method in class org.jline.console.impl.SystemRegistryImpl
- setConsoleOption(String, Object) - Method in interface org.jline.console.SystemRegistry
-
Sets the value of a console option.
- setDescription(List<AttributedString>) - Method in class org.jline.widget.Widgets
-
Set description text to the terminal status bar
- setDescriptionCache(boolean) - Method in class org.jline.widget.TailTipWidgets
- setDescriptionSize(int) - Method in class org.jline.widget.TailTipWidgets
- setErrorIndex(int) - Method in class org.jline.console.CmdDesc
-
Sets the index of the error in the command.
- setErrorIndex(int) - Method in class org.jline.widget.Widgets
-
Set errorIndex to the lineReader's highlighter
- setErrorPattern(Pattern) - Method in class org.jline.console.CmdDesc
-
Sets the pattern used to identify errors in the command.
- setErrorPattern(Pattern) - Method in class org.jline.widget.Widgets
-
Set errorPattern to the lineReader's highlighter
- setGroupCommandsInHelp(boolean) - Method in class org.jline.console.impl.SystemRegistryImpl
- setHighlighted(boolean) - Method in class org.jline.console.CmdDesc
-
Sets whether the command should be highlighted.
- setHighlightValue(Map<String, Function<Object, AttributedString>>) - Method in class org.jline.console.impl.DefaultPrinter
-
Highlight column value
- setLineReader(LineReader) - Method in interface org.jline.console.ConsoleEngine
-
Sets the LineReader instance to be used by this console engine.
- setLineReader(LineReader) - Method in class org.jline.console.impl.Builtins
- setLineReader(LineReader) - Method in class org.jline.console.impl.ConsoleEngineImpl
- setLineReader(LineReader) - Method in class org.jline.console.impl.SimpleSystemRegistryImpl
- setMainDesc(List<AttributedString>) - Method in class org.jline.console.CmdDesc
-
Sets the main description of the command.
- setObjectToMap(Map<Class<?>, Function<Object, Map<String, Object>>>) - Method in class org.jline.console.impl.DefaultPrinter
-
Override ScriptEngine toMap() method
- setObjectToString(Map<Class<?>, Function<Object, String>>) - Method in class org.jline.console.impl.DefaultPrinter
-
Override ScriptEngine toString() method
- SETOPT - Enum constant in enum class org.jline.console.impl.Builtins.Command
- setPipe(String) - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- setScriptDescription(Function<CmdLine, CmdDesc>) - Method in class org.jline.console.impl.SystemRegistryImpl
- setScriptExtension(String) - Method in interface org.jline.console.ConsoleEngine
-
Sets the file name extension used by console scripts.
- setScriptExtension(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- setSpecificHighlighter(String, SyntaxHighlighter) - Method in class org.jline.console.impl.SystemHighlighter
- setSubcommand(boolean) - Method in class org.jline.console.CmdDesc
-
Sets whether this is a subcommand.
- setSuggestionType(LineReader.SuggestionType) - Method in class org.jline.widget.Widgets
-
Set lineReader's autosuggestion type
- setSystemRegistry(SystemRegistry) - Method in interface org.jline.console.ConsoleEngine
-
Sets the SystemRegistry instance to be used by this console engine.
- setSystemRegistry(SystemRegistry) - Method in class org.jline.console.impl.ConsoleEngineImpl
- setTailTip(String) - Method in class org.jline.widget.Widgets
-
Set lineReader's command hint to be added in the command line
- setTailTips(Map<String, CmdDesc>) - Method in class org.jline.widget.TailTipWidgets
- setTipType(TailTipWidgets.TipType) - Method in class org.jline.widget.TailTipWidgets
- SETVAR - Enum constant in enum class org.jline.console.impl.Builtins.Command
- SHORT_NAMES - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: TABLE
Truncate table column names: property.field to field. - SHOW - Enum constant in enum class org.jline.console.impl.ConsoleEngineImpl.Command
- SimpleSystemRegistryImpl - Class in org.jline.console.impl
-
Simple SystemRegistry which stores variables in the LineReader.
- SimpleSystemRegistryImpl(Parser, Terminal, Supplier<Path>, ConfigurationPath) - Constructor for class org.jline.console.impl.SimpleSystemRegistryImpl
- SKIP_DEFAULT_OPTIONS - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: MAP and TABLE
Ignore all options defined in PRNT_OPTIONS. - slurp(Path) - Method in interface org.jline.console.ConsoleEngine
-
Reads an object from a file.
- slurp(Path) - Method in class org.jline.console.impl.ConsoleEngineImpl
- SLURP - Enum constant in enum class org.jline.console.impl.ConsoleEngineImpl.Command
- specificHighlighter - Variable in class org.jline.console.impl.SystemHighlighter
- status() - Method in class org.jline.console.ConsoleEngine.ExecutionResult
-
Returns the status code of the command execution.
- STRUCT_ON_TABLE - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: TABLE
Display object structures and lists on table. - STYLE - Static variable in interface org.jline.console.Printer
-
Value: String
Use nanorc STYLE - SYNTAX - Enum constant in enum class org.jline.console.CmdLine.DescriptionType
-
The part of the line from beginning till cursor ends to the closing parenthesis.
- systemHighlight(LineReader, String) - Method in class org.jline.console.impl.SystemHighlighter
- SystemHighlighter - Class in org.jline.console.impl
-
Highlighter implementation that provides syntax highlighting for commands and languages.
- SystemHighlighter(SyntaxHighlighter, SyntaxHighlighter, SyntaxHighlighter) - Constructor for class org.jline.console.impl.SystemHighlighter
- SystemHighlighter.FileHighlightCommand - Class in org.jline.console.impl
- systemRegistry - Variable in class org.jline.console.impl.SystemHighlighter
- SystemRegistry - Interface in org.jline.console
-
Interface for aggregating command registries and dispatching command executions in a console application.
- SystemRegistry.Registeries - Class in org.jline.console
-
Class for managing the system registry store.
- SystemRegistryImpl - Class in org.jline.console.impl
-
Aggregate command registries.
- SystemRegistryImpl(Parser, Terminal, Supplier<Path>, ConfigurationPath) - Constructor for class org.jline.console.impl.SystemRegistryImpl
- SystemRegistryImpl.CommandData - Class in org.jline.console.impl
- SystemRegistryImpl.Pipe - Enum Class in org.jline.console.impl
- SystemRegistryImpl.UnknownCommandException - Exception Class in org.jline.console.impl
T
- TAIL_TIP - Enum constant in enum class org.jline.widget.TailTipWidgets.TipType
-
Prepare command line suggestions using a command's positional argument descriptions.
- tailTip() - Method in class org.jline.widget.Widgets
-
Get lineReader's command hint
- TAILTIP_PANE - Static variable in class org.jline.widget.Widgets
- TAILTIP_TOGGLE - Static variable in class org.jline.widget.Widgets
- tailtipAcceptLine() - Method in class org.jline.widget.TailTipWidgets
- tailtipBackwardDelete() - Method in class org.jline.widget.TailTipWidgets
- tailtipComplete() - Method in class org.jline.widget.TailTipWidgets
- tailtipDelete() - Method in class org.jline.widget.TailTipWidgets
- tailtipInsert() - Method in class org.jline.widget.TailTipWidgets
- tailtipKillLine() - Method in class org.jline.widget.TailTipWidgets
- tailtipKillWholeLine() - Method in class org.jline.widget.TailTipWidgets
- tailtipUpdateStatus() - Method in class org.jline.widget.TailTipWidgets
- TailTipWidgets - Class in org.jline.widget
-
Creates and manages widgets for as-you-type command line suggestions.
- TailTipWidgets(LineReader, Function<CmdLine, CmdDesc>, int, TailTipWidgets.TipType) - Constructor for class org.jline.widget.TailTipWidgets
-
Creates tailtip widgets used in command line suggestions.
- TailTipWidgets(LineReader, Map<String, CmdDesc>) - Constructor for class org.jline.widget.TailTipWidgets
-
Creates tailtip widgets used in command line suggestions.
- TailTipWidgets(LineReader, Map<String, CmdDesc>, int) - Constructor for class org.jline.widget.TailTipWidgets
-
Creates tailtip widgets used in command line suggestions with a status bar.
- TailTipWidgets(LineReader, Map<String, CmdDesc>, int, TailTipWidgets.TipType) - Constructor for class org.jline.widget.TailTipWidgets
-
Creates tailtip widgets used in command line suggestions with a status bar and specific tip type.
- TailTipWidgets(LineReader, Map<String, CmdDesc>, TailTipWidgets.TipType) - Constructor for class org.jline.widget.TailTipWidgets
-
Creates tailtip widgets used in command line suggestions with a specific tip type.
- TailTipWidgets.TipType - Enum Class in org.jline.widget
-
Enumeration specifying the type of suggestions to display.
- terminal() - Method in class org.jline.console.CommandInput
-
Returns the terminal instance for this command.
- terminal() - Method in class org.jline.console.CommandRegistry.CommandSession
-
Returns the terminal for the command session.
- terminal() - Method in class org.jline.console.impl.DefaultPrinter
- terminal() - Method in class org.jline.console.impl.SystemRegistryImpl
- terminal() - Method in interface org.jline.console.SystemRegistry
-
Returns the terminal associated with this system registry.
- TO_STRING - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: MAP and TABLE
Use object's toString() method to get print value DEFAULT: object's fields are put to property map before printing - toggle() - Method in class org.jline.widget.AutopairWidgets
- toggleKeyBindings() - Method in class org.jline.widget.AutopairWidgets
- toggleKeyBindings() - Method in class org.jline.widget.AutosuggestionWidgets
- toggleKeyBindings() - Method in class org.jline.widget.TailTipWidgets
- toggleWindow() - Method in class org.jline.widget.TailTipWidgets
- toJson(Object) - Method in interface org.jline.console.ScriptEngine
-
Serializes an object to a JSON string.
- toMap(Object) - Method in interface org.jline.console.ScriptEngine
-
Converts an object's fields to a map.
- toString() - Method in class org.jline.console.ConsoleEngine.WidgetCreator
-
Returns the name of the function.
- toString() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- toString(Object) - Method in interface org.jline.console.ScriptEngine
-
Converts an object to its string representation.
- trace(boolean, Throwable) - Method in class org.jline.console.impl.SystemRegistryImpl
- trace(boolean, Throwable) - Method in interface org.jline.console.SystemRegistry
-
Prints an exception on the terminal with control over stack trace display.
- trace(Object) - Method in interface org.jline.console.ConsoleEngine
-
Prints an object if tracing is enabled.
- trace(Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
- trace(Throwable) - Method in class org.jline.console.impl.SystemRegistryImpl
- trace(Throwable) - Method in interface org.jline.console.SystemRegistry
-
Prints an exception on the terminal.
- TT_ACCEPT_LINE - Static variable in class org.jline.widget.Widgets
- TTOP - Enum constant in enum class org.jline.console.impl.Builtins.Command
U
- UNALIAS - Enum constant in enum class org.jline.console.impl.ConsoleEngineImpl.Command
- UnknownCommandException(String) - Constructor for exception class org.jline.console.impl.SystemRegistryImpl.UnknownCommandException
- UNSETOPT - Enum constant in enum class org.jline.console.impl.Builtins.Command
V
- VALUE_STYLE - Static variable in interface org.jline.console.Printer
-
Value: String
Applies: MAP and TABLE
Nanorc syntax style used to highlight values. - VALUE_STYLE_ALL - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: MAP and TABLE
Highlight everything also strings with spaces DEFAULT: highlight only strings without spaces or enclosed by quotes or brackets - valueOf(String) - Static method in enum class org.jline.console.CmdLine.DescriptionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.jline.console.impl.Builtins.Command
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.jline.console.impl.ConsoleEngineImpl.Command
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.jline.console.impl.SystemRegistryImpl.Pipe
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.jline.console.Printer.TableRows
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.jline.widget.TailTipWidgets.TipType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.jline.console.CmdLine.DescriptionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.jline.console.impl.Builtins.Command
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.jline.console.impl.ConsoleEngineImpl.Command
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.jline.console.impl.SystemRegistryImpl.Pipe
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.jline.console.Printer.TableRows
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.jline.widget.TailTipWidgets.TipType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VAR_NANORC - Static variable in interface org.jline.console.ConsoleEngine
-
Console string variable containing the full path to the nanorc configuration file.
- VAR_PRNT_OPTIONS - Static variable in class org.jline.console.impl.DefaultPrinter
- variable() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
W
- WIDGET - Enum constant in enum class org.jline.console.impl.Builtins.Command
- WidgetCreator(ConsoleEngine, String) - Constructor for class org.jline.console.ConsoleEngine.WidgetCreator
-
Creates a new widget creator for the specified function.
- Widgets - Class in org.jline.widget
-
Base class for creating custom widgets for JLine's LineReader.
- Widgets(LineReader) - Constructor for class org.jline.widget.Widgets
-
Creates a new Widgets instance for the specified LineReader.
- WIDTH - Static variable in interface org.jline.console.Printer
-
Value: Integer
Applies: MAP and TABLE
Display width (default terminal width). - workDir - Variable in class org.jline.console.impl.SystemRegistryImpl
X
- xargs() - Method in class org.jline.console.CommandInput
-
Returns the original command arguments as objects.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form