Uses of Interface
org.jline.reader.LineReader
Packages that use LineReader
Package
Description
JLine Builtins provides a collection of utility classes and implementations for common terminal
functionality.
JLine Console package provides a framework for building interactive command-line applications.
JLine 3 Reader Package - Core components for building interactive command-line interfaces.
JLine 3 Reader Implementation Package.
JLine 3 Completer Implementations.
JLine 3 History Implementation Package.
JLine Widget package provides a framework for creating and managing widgets for JLine's LineReader.
-
Uses of LineReader in org.jline.builtins
Methods in org.jline.builtins with parameters of type LineReaderModifier and TypeMethodDescriptionstatic void
Commands.complete
(LineReader reader, PrintStream out, PrintStream err, Map<String, List<Completers.CompletionData>> completions, String[] argv) Edits command-specific tab completions.void
Completers.AnyCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) Completes the current word by returning it as a candidate.void
Completers.Completer.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Completes the current input line.void
Completers.FileNameCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) void
Completers.OptionCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) Completes command options and arguments.void
Completers.RegexCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Completes the current input line using the regex pattern.void
Completers.TreeCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Completes the current input line using the tree structure.protected void
Completers.Completer.completeCommandArguments
(LineReader reader, ParsedLine line, List<Candidate> candidates, List<Completers.CompletionData> completions) Completes command arguments based on completion data.protected void
Completers.OptDesc.completeOption
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates, boolean longOpt) Completes an option based on whether it's a short or long option.protected boolean
Completers.OptDesc.completeValue
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates, String curBuf, String partialValue) Completes the value for an option.static void
InputRC.configure
(LineReader reader, InputStream is) Configures a LineReader from an inputrc file provided as an InputStream.static void
InputRC.configure
(LineReader reader, Reader r) Configures a LineReader from an inputrc file provided as a Reader.static void
InputRC.configure
(LineReader reader, URL url) Configures a LineReader from an inputrc file at the specified URL.Completers.CompletionEnvironment.evaluate
(LineReader reader, ParsedLine line, String func) Evaluates a function in the current environment context.static void
Commands.highlighter
(LineReader lineReader, Terminal terminal, PrintStream out, PrintStream err, String[] argv, ConfigurationPath configPath) Manages syntax highlighting themes.static void
Commands.history
(LineReader reader, PrintStream out, PrintStream err, Path currentDir, String[] argv) Displays or manipulates the command history.static void
Commands.keymap
(LineReader reader, PrintStream out, PrintStream err, String[] argv) Manipulates line reader keymaps.static void
Commands.setopt
(LineReader reader, PrintStream out, PrintStream err, String[] argv) Sets line reader options.static void
Commands.setvar
(LineReader lineReader, PrintStream out, PrintStream err, String[] argv) Sets or displays line reader variables.protected void
Completers.Completer.tryCompleteArguments
(LineReader reader, ParsedLine line, List<Candidate> candidates) Attempts to complete command arguments.static void
Commands.unsetopt
(LineReader reader, PrintStream out, PrintStream err, String[] argv) Unsets line reader options.static void
Commands.widget
(LineReader reader, PrintStream out, PrintStream err, Function<String, Widget> widgetCreator, String[] argv) Manipulates line reader widgets. -
Uses of LineReader in org.jline.console
Methods in org.jline.console with parameters of type LineReaderModifier and TypeMethodDescriptionvoid
ConsoleEngine.setLineReader
(LineReader reader) Sets the LineReader instance to be used by this console engine. -
Uses of LineReader in org.jline.console.impl
Methods in org.jline.console.impl with parameters of type LineReaderModifier and TypeMethodDescriptionprotected AttributedString
SystemHighlighter.doFileArgsHighlight
(LineReader reader, String buffer, List<String> words, SystemHighlighter.FileHighlightCommand fhc) protected AttributedString
SystemHighlighter.doFileOptsHighlight
(LineReader reader, String buffer, List<String> words, SystemHighlighter.FileHighlightCommand fhc) SystemHighlighter.highlight
(LineReader reader, String buffer) void
SystemHighlighter.refresh
(LineReader lineReader) void
Builtins.setLineReader
(LineReader reader) void
ConsoleEngineImpl.setLineReader
(LineReader reader) void
SimpleSystemRegistryImpl.setLineReader
(LineReader lineReader) protected AttributedString
SystemHighlighter.systemHighlight
(LineReader reader, String buffer) -
Uses of LineReader in org.jline.reader
Methods in org.jline.reader that return LineReaderModifier and TypeMethodDescriptionLineReaderBuilder.build()
Builds and returns a LineReader instance with the configured options.LineReader.option
(LineReader.Option option, boolean value) Sets an option in the LineReader and returns the LineReader for method chaining.Sets a variable in the LineReader and returns the LineReader for method chaining.Methods in org.jline.reader with parameters of type LineReaderModifier and TypeMethodDescriptionvoid
History.attach
(LineReader reader) Initialize the history for the given reader.void
Completer.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Populates candidates with a list of possible completions for the command line.Highlighter.highlight
(LineReader reader, String buffer) Highlights the provided text buffer with appropriate styling.default void
Highlighter.refresh
(LineReader reader) Refreshes the highlighter's configuration.Constructors in org.jline.reader with parameters of type LineReader -
Uses of LineReader in org.jline.reader.impl
Classes in org.jline.reader.impl that implement LineReaderMethods in org.jline.reader.impl that return LineReaderMethods in org.jline.reader.impl with parameters of type LineReaderModifier and TypeMethodDescriptionprotected void
DefaultHighlighter.commandStyle
(LineReader reader, AttributedStringBuilder sb, boolean enable) static void
InputRC.configure
(LineReader reader, InputStream is) Configures a LineReader from an inputrc file.static void
InputRC.configure
(LineReader reader, Reader r) Configures a LineReader from an inputrc file.static void
InputRC.configure
(LineReader reader, URL url) Configures a LineReader from an inputrc file at the specified URL.static boolean
ReaderUtils.getBoolean
(LineReader reader, String name, boolean def) Gets a boolean variable from a LineReader with a default value.static int
ReaderUtils.getInt
(LineReader reader, String name, int def) Gets an integer variable from a LineReader with a default value.static long
ReaderUtils.getLong
(LineReader reader, String name, long def) Gets a long variable from a LineReader with a default value.static String
ReaderUtils.getString
(LineReader reader, String name, String def) Gets a string variable from a LineReader with a default value.DefaultHighlighter.highlight
(LineReader reader, String buffer) static boolean
ReaderUtils.isSet
(LineReader reader, LineReader.Option option) Checks if a LineReader option is set. -
Uses of LineReader in org.jline.reader.impl.completer
Methods in org.jline.reader.impl.completer with parameters of type LineReaderModifier and TypeMethodDescriptionvoid
AggregateCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) Perform a completion operation across all aggregated completers.void
ArgumentCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) void
FileNameCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) Deprecated.void
NullCompleter.complete
(LineReader reader, ParsedLine line, List<Candidate> candidates) void
StringsCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) void
SystemCompleter.complete
(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) -
Uses of LineReader in org.jline.reader.impl.history
Methods in org.jline.reader.impl.history with parameters of type LineReaderModifier and TypeMethodDescriptionvoid
DefaultHistory.attach
(LineReader reader) Attaches this history to a LineReader.Constructors in org.jline.reader.impl.history with parameters of type LineReaderModifierConstructorDescriptionDefaultHistory
(LineReader reader) Creates a new DefaultHistory instance and attaches it to the specified LineReader. -
Uses of LineReader in org.jline.widget
Fields in org.jline.widget declared as LineReaderModifier and TypeFieldDescriptionprotected final LineReader
Widgets.reader
The LineReader instance associated with these widgetsConstructors in org.jline.widget with parameters of type LineReaderModifierConstructorDescriptionAutopairWidgets
(LineReader reader) AutopairWidgets
(LineReader reader, boolean addCurlyBrackets) AutosuggestionWidgets
(LineReader reader) TailTipWidgets
(LineReader reader, Function<CmdLine, CmdDesc> descFun, int descriptionSize, TailTipWidgets.TipType tipType) Creates tailtip widgets used in command line suggestions.TailTipWidgets
(LineReader reader, Map<String, CmdDesc> tailTips) Creates tailtip widgets used in command line suggestions.TailTipWidgets
(LineReader reader, Map<String, CmdDesc> tailTips, int descriptionSize) Creates tailtip widgets used in command line suggestions with a status bar.TailTipWidgets
(LineReader reader, Map<String, CmdDesc> tailTips, int descriptionSize, TailTipWidgets.TipType tipType) Creates tailtip widgets used in command line suggestions with a status bar and specific tip type.TailTipWidgets
(LineReader reader, Map<String, CmdDesc> tailTips, TailTipWidgets.TipType tipType) Creates tailtip widgets used in command line suggestions with a specific tip type.Widgets
(LineReader reader) Creates a new Widgets instance for the specified LineReader.