A B C D E F G H I J K L M N O P R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractCommandRegistry - Class in org.jline.console.impl
-
CommandRegistry common methods.
- AbstractCommandRegistry() - Constructor for class org.jline.console.impl.AbstractCommandRegistry
- add(SystemRegistry) - Static method in interface org.jline.console.SystemRegistry
-
Add systemRegistry to the thread map
- 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
-
Aggregate SystemCompleters of commandRegisteries
- alias(String, String) - Method in class org.jline.console.impl.AbstractCommandRegistry
- ALIAS - org.jline.console.impl.ConsoleEngineImpl.Command
- aliasWidget(String, String) - Method in class org.jline.widget.Widgets
-
Create alias to widget
- ALL - org.jline.console.Printer.TableRows
- ALL - Static variable in interface org.jline.console.Printer
-
Value: Boolean
Applies: TABLE
Ignore columnsOut configuration. - AND - 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
- ArgDesc - Class in org.jline.console
- ArgDesc(String) - Constructor for class org.jline.console.ArgDesc
- ArgDesc(String, List<AttributedString>) - Constructor for class org.jline.console.ArgDesc
- args() - Method in class org.jline.console.CommandInput
- 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 auto-closes, deletes and skips over matching delimiters intelligently.
- 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.
- 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
-
Builtins: create tab completers, execute and create descriptions for builtins commands.
- 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 in org.jline.console.impl
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
-
Delete temporary console variables and reset 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 close SystemRegistry.
- CmdDesc - Class in org.jline.console
- CmdDesc() - Constructor for class org.jline.console.CmdDesc
- CmdDesc(boolean) - Constructor for class org.jline.console.CmdDesc
- CmdDesc(List<ArgDesc>) - Constructor for class org.jline.console.CmdDesc
- CmdDesc(List<ArgDesc>, Map<String, List<AttributedString>>) - Constructor for class org.jline.console.CmdDesc
- CmdDesc(List<AttributedString>, List<ArgDesc>, Map<String, List<AttributedString>>) - Constructor for class org.jline.console.CmdDesc
- CmdLine - Class in org.jline.console
- CmdLine(String, String, String, List<String>, CmdLine.DescriptionType) - Constructor for class org.jline.console.CmdLine
-
CmdLine class constructor.
- CmdLine.DescriptionType - Enum in org.jline.console
- COLORS - 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 - org.jline.widget.TailTipWidgets.TipType
-
Prepare command line suggestions using either a command positional argument descriptions if exists or command completers data.
- command() - Method in class org.jline.console.CommandInput
- command() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- COMMAND - 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 command, method or syntax description 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
- CommandInput(String, Object[], CommandRegistry.CommandSession) - Constructor for class org.jline.console.CommandInput
- CommandInput(String, Object[], Terminal, InputStream, PrintStream, PrintStream) - Constructor for class org.jline.console.CommandInput
- CommandMethods - Class in org.jline.console
- CommandMethods(Consumer<CommandInput>, Function<String, List<Completer>>) - Constructor for class org.jline.console.CommandMethods
- CommandMethods(Function<CommandInput, ?>, Function<String, List<Completer>>) - Constructor for class org.jline.console.CommandMethods
- 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
-
Store command information, compile tab completers and execute registered commands.
- CommandRegistry.CommandSession - Class in org.jline.console
- CommandSession() - Constructor for class org.jline.console.CommandRegistry.CommandSession
- CommandSession(Terminal) - Constructor for class org.jline.console.CommandRegistry.CommandSession
- CommandSession(Terminal, InputStream, PrintStream, PrintStream) - Constructor for class org.jline.console.CommandRegistry.CommandSession
- 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
- 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
-
Aggregate and compile SystemCompleters of commandRegisteries
- 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 command completer that includes also console variable and script completion.
- COMPLETER - org.jline.widget.TailTipWidgets.TipType
-
Prepare command line suggestions using a command 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
-
Manage console variables, commands and script executions.
- ConsoleEngine.ExecutionResult - Class in org.jline.console
- ConsoleEngine.WidgetCreator - Class in org.jline.console
- 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 in org.jline.console.impl
- consoleOption(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- consoleOption(String) - Method in interface org.jline.console.SystemRegistry
-
Return console option value
- consoleOption(String, T) - Method in interface org.jline.console.ConsoleEngine
-
Read console option value
- 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
-
Return console option value
- createCandidate(CommandRegistry[], String) - Static method in interface org.jline.console.CommandRegistry
- 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
-
Print highlighted objects to console.
- 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.
- DEL - org.jline.console.impl.ConsoleEngineImpl.Command
- deserialize(String) - Method in interface org.jline.console.ScriptEngine
-
Deserialize value
- deserialize(String, String) - Method in interface org.jline.console.ScriptEngine
-
Deserialize value
- 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
- DOC - 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
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
- err() - Method in class org.jline.console.CommandRegistry.CommandSession
- EVEN - org.jline.console.Printer.TableRows
- 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
- execute(File) - Method in interface org.jline.console.ConsoleEngine
-
Executes either JLine or ScriptEngine script.
- execute(File) - Method in interface org.jline.console.ScriptEngine
-
Executes scriptEngine script
- execute(File, Object[]) - Method in interface org.jline.console.ScriptEngine
-
Executes scriptEngine script
- execute(File, String, String[]) - Method in interface org.jline.console.ConsoleEngine
-
Executes either JLine or ScriptEngine script.
- execute(Object, Object...) - Method in interface org.jline.console.ScriptEngine
-
Executes scriptEngine closure
- execute(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- execute(String) - Method in interface org.jline.console.ScriptEngine
-
Executes scriptEngine statement
- execute(String) - Method in interface org.jline.console.SystemRegistry
-
Execute a command, script or evaluate scriptEngine statement
- execute(String, String, String[]) - Method in interface org.jline.console.ConsoleEngine
-
Executes command line that does not contain known command by the system registry.
- execute(String, String, String[]) - Method in class org.jline.console.impl.ConsoleEngineImpl
- execute(Path, String, String[]) - Method in interface org.jline.console.ConsoleEngine
-
Executes either JLine or ScriptEngine script.
- execute(Path, String, String[]) - Method in class org.jline.console.impl.ConsoleEngineImpl
- executeWidget(Object) - Method in interface org.jline.console.ConsoleEngine
-
Execute 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
- existsWidget(String) - Method in class org.jline.widget.Widgets
-
Test if widget exists
- expandCommandLine(String) - Method in interface org.jline.console.ConsoleEngine
-
Substitutes command line with system registry invoke method call.
- expandCommandLine(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- expandParameters(String[]) - Method in interface org.jline.console.ConsoleEngine
-
Substituting args 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 parameter list to string
- 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 values
- find(String) - Method in interface org.jline.console.ScriptEngine
-
Gets all the variables that match the name.
- FLIP - org.jline.console.impl.SystemRegistryImpl.Pipe
G
- get() - Static method in interface org.jline.console.SystemRegistry
- get(String) - Method in interface org.jline.console.ScriptEngine
-
Gets variable value
- getAlias(String) - Method in interface org.jline.console.ConsoleEngine
-
Returns alias 'name' value
- getAlias(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- getArgs() - Method in class org.jline.console.CmdLine
- getArgsDesc() - Method in class org.jline.console.CmdDesc
- getCommandMethods(String) - Method in class org.jline.console.impl.AbstractCommandRegistry
- getDescription() - Method in class org.jline.console.ArgDesc
- getDescriptionSize() - Method in class org.jline.widget.TailTipWidgets
- getDescriptionType() - Method in class org.jline.console.CmdLine
- getDeserializationFormats() - Method in interface org.jline.console.ScriptEngine
- getEngineName() - Method in interface org.jline.console.ScriptEngine
- getErrorIndex() - Method in class org.jline.console.CmdDesc
- getErrorPattern() - Method in class org.jline.console.CmdDesc
- getExtensions() - Method in interface org.jline.console.ScriptEngine
- getFileOptions() - Method in class org.jline.console.impl.SystemHighlighter.FileHighlightCommand
- getHead() - Method in class org.jline.console.CmdLine
- 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
- getMainDesc() - Method in class org.jline.console.CmdDesc
- getName() - Method in class org.jline.console.ArgDesc
- getNamedPipes() - Method in interface org.jline.console.ConsoleEngine
-
Returns named pipe names
- getNamedPipes() - Method in class org.jline.console.impl.ConsoleEngineImpl
- getOptsDesc() - Method in class org.jline.console.CmdDesc
- getPipeNames() - Method in class org.jline.console.impl.SystemRegistryImpl
- getPipeNames() - Method in interface org.jline.console.SystemRegistry
- getPipes() - Method in interface org.jline.console.ConsoleEngine
-
Returns defined pipes
- getPipes() - Method in class org.jline.console.impl.ConsoleEngineImpl
- getScriptCompleter() - Method in interface org.jline.console.ScriptEngine
- getSerializationFormats() - Method in interface org.jline.console.ScriptEngine
- 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
- getTipType() - Method in class org.jline.widget.TailTipWidgets
- getVariable(String) - Method in interface org.jline.console.ConsoleEngine
-
Get variable value
- 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
-
Returns true if alias '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
-
Test if variable with name exists
- hasVariable(String) - Method in class org.jline.console.impl.ConsoleEngineImpl
- hasVariable(String) - Method in interface org.jline.console.ScriptEngine
-
Tests if console variable exists
- 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 - org.jline.console.impl.Builtins.Command
- HISTORY - org.jline.console.impl.Builtins.Command
I
- in() - Method in class org.jline.console.CommandInput
- in() - Method in class org.jline.console.CommandRegistry.CommandSession
- 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
-
Initialize consoleEngine environment by executing console script
- invoke(String, Object...) - Method in class org.jline.console.impl.SystemRegistryImpl
- invoke(String, Object...) - Method in interface org.jline.console.SystemRegistry
-
Execute command with 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
- isCommandAlias(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- isCommandAlias(String) - Method in interface org.jline.console.SystemRegistry
-
Returns whether alias is known command alias.
- isCommandOrScript(String) - Method in class org.jline.console.impl.SystemRegistryImpl
- isCommandOrScript(String) - Method in interface org.jline.console.SystemRegistry
-
Returns whether command is known to this registry.
- isCommandOrScript(ParsedLine) - Method in class org.jline.console.impl.SystemRegistryImpl
- isCommandOrScript(ParsedLine) - Method in interface org.jline.console.SystemRegistry
-
Returns whether a line contains command/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 consoleEngine is executing script
- isExecuting() - Method in class org.jline.console.impl.ConsoleEngineImpl
- isHighlighted() - Method in class org.jline.console.CmdDesc
- isSubcommand() - Method in class org.jline.console.CmdDesc
- isSubcommand() - Method in class org.jline.console.impl.SystemHighlighter.FileHighlightCommand
- isValid() - Method in class org.jline.console.CmdDesc
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 - 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 - org.jline.console.impl.Builtins.Command
M
- mainDesc(List<AttributedString>) - Method in class org.jline.console.CmdDesc
- 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 - 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 - org.jline.console.impl.SystemRegistryImpl.Pipe
- NANO - 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 - org.jline.console.Printer.TableRows
- 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
- optionWithValue(String) - Method in class org.jline.console.CmdDesc
- OR - org.jline.console.impl.SystemRegistryImpl.Pipe
- org.jline.console - package org.jline.console
- org.jline.console.impl - package org.jline.console.impl
- org.jline.widget - package org.jline.widget
- out() - Method in class org.jline.console.CommandInput
- out() - Method in class org.jline.console.CommandRegistry.CommandSession
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
-
Persist object to file
- persist(Path, Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
- persist(Path, Object) - Method in interface org.jline.console.ScriptEngine
-
Persists object value to file.
- persist(Path, Object, String) - Method in interface org.jline.console.ScriptEngine
-
Persists object value to file.
- pipe() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- PIPE - org.jline.console.impl.ConsoleEngineImpl.Command
- plainCommand(String) - Static method in interface org.jline.console.ConsoleEngine
-
Removes the command name first character if it is colon
- postProcess(Object) - Method in interface org.jline.console.ConsoleEngine
-
Post processes execution result.
- postProcess(Object) - Method in class org.jline.console.impl.ConsoleEngineImpl
- postProcess(String, Object, String) - Method in interface org.jline.console.ConsoleEngine
-
Post processes execution result.
- 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
-
Print object to the console.
- Printer.TableRows - Enum in org.jline.console
- println(Object) - Method in interface org.jline.console.ConsoleEngine
-
Print object.
- 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
- 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
- PRNT - 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
- purge() - Method in interface org.jline.console.ConsoleEngine
-
Delete temporary console variables
- purge() - Method in class org.jline.console.impl.ConsoleEngineImpl
- put(String, Object) - Method in interface org.jline.console.ScriptEngine
-
Creates variable
- 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
-
Create 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
- refresh() - Method in class org.jline.console.impl.DefaultPrinter
- refresh() - Method in interface org.jline.console.Printer
-
Clear printer syntax highlighter cache
- 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
-
Register subcommand registry
- 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
-
Remove systemRegistry of the current thread from the thread map
- 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
- 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 script and variable completers
- scriptCompleters() - Method in class org.jline.console.impl.ConsoleEngineImpl
- ScriptEngine - Interface in org.jline.console
-
Manage scriptEngine variables, statements and script execution.
- scripts() - Method in interface org.jline.console.ConsoleEngine
-
Returns all scripts found from PATH
- scripts() - Method in class org.jline.console.impl.ConsoleEngineImpl
- session() - Method in class org.jline.console.CommandInput
- setCommandRegistries(CommandRegistry...) - Method in class org.jline.console.impl.SystemRegistryImpl
- setCommandRegistries(CommandRegistry...) - Method in interface org.jline.console.SystemRegistry
-
Set command registries
- setConsoleOption(String, Object) - Method in interface org.jline.console.ConsoleEngine
-
Set 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
-
Set console option value
- 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
- 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
- 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
- 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 lineReader
- 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
- 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 - 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 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
- 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 systemRegistry
- 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 - 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 - 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
-
Read object from file
- slurp(Path) - Method in class org.jline.console.impl.ConsoleEngineImpl
- SLURP - org.jline.console.impl.ConsoleEngineImpl.Command
- specificHighlighter - Variable in class org.jline.console.impl.SystemHighlighter
- status() - Method in class org.jline.console.ConsoleEngine.ExecutionResult
- 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 - 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
-
Highlight command and language syntax using nanorc highlighter.
- 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
-
Aggregate command registries and dispatch command executions.
- SystemRegistry.Registeries - Class in org.jline.console
-
Manage systemRegistry 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 in org.jline.console.impl
- SystemRegistryImpl.UnknownCommandException - Exception in org.jline.console.impl
T
- TAIL_TIP - org.jline.widget.TailTipWidgets.TipType
-
Prepare command line suggestions using a command 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.
- TailTipWidgets(LineReader, Map<String, CmdDesc>, int, TailTipWidgets.TipType) - Constructor for class org.jline.widget.TailTipWidgets
-
Creates tailtip widgets used in command line suggestions.
- TailTipWidgets(LineReader, Map<String, CmdDesc>, TailTipWidgets.TipType) - Constructor for class org.jline.widget.TailTipWidgets
-
Creates tailtip widgets used in command line suggestions.
- TailTipWidgets.TipType - Enum in org.jline.widget
- terminal() - Method in class org.jline.console.CommandInput
- terminal() - Method in class org.jline.console.CommandRegistry.CommandSession
- 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
- 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
-
Serialize object to JSON string.
- toMap(Object) - Method in interface org.jline.console.ScriptEngine
-
Converts object fields to map.
- toString() - Method in class org.jline.console.ConsoleEngine.WidgetCreator
- toString() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
- toString(Object) - Method in interface org.jline.console.ScriptEngine
-
Converts object to string.
- trace(boolean, Throwable) - Method in class org.jline.console.impl.SystemRegistryImpl
- trace(boolean, Throwable) - Method in interface org.jline.console.SystemRegistry
-
Print exception on terminal
- trace(Object) - Method in interface org.jline.console.ConsoleEngine
-
Print object if trace 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
-
Print exception on terminal
- TT_ACCEPT_LINE - Static variable in class org.jline.widget.Widgets
- TTOP - org.jline.console.impl.Builtins.Command
U
- UNALIAS - org.jline.console.impl.ConsoleEngineImpl.Command
- UnknownCommandException(String) - Constructor for exception org.jline.console.impl.SystemRegistryImpl.UnknownCommandException
- UNSETOPT - 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 org.jline.console.CmdLine.DescriptionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.jline.console.impl.Builtins.Command
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.jline.console.impl.ConsoleEngineImpl.Command
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.jline.console.impl.SystemRegistryImpl.Pipe
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.jline.console.Printer.TableRows
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.jline.widget.TailTipWidgets.TipType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.jline.console.CmdLine.DescriptionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.jline.console.impl.Builtins.Command
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.jline.console.impl.ConsoleEngineImpl.Command
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.jline.console.impl.SystemRegistryImpl.Pipe
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.jline.console.Printer.TableRows
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.jline.widget.TailTipWidgets.TipType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VAR_NANORC - Static variable in interface org.jline.console.ConsoleEngine
-
Console string variable of nanorc file full path
- VAR_PRNT_OPTIONS - Static variable in class org.jline.console.impl.DefaultPrinter
- variable() - Method in class org.jline.console.impl.SystemRegistryImpl.CommandData
W
- WIDGET - org.jline.console.impl.Builtins.Command
- WidgetCreator(ConsoleEngine, String) - Constructor for class org.jline.console.ConsoleEngine.WidgetCreator
- Widgets - Class in org.jline.widget
-
Create custom widgets by extending Widgets class
- Widgets(LineReader) - Constructor for class org.jline.widget.Widgets
- 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
All Classes All Packages