Uses of Interface
org.jline.reader.LineReader

Packages that use LineReader

Package	Description
org.jline.builtins	JLine Builtins provides a collection of utility classes and implementations for common terminal functionality.
org.jline.builtins.ssh
org.jline.console	JLine Console package provides a framework for building interactive command-line applications.
org.jline.console.impl
org.jline.reader	JLine 3 Reader Package - Core components for building interactive command-line interfaces.
org.jline.reader.impl	JLine 3 Reader Implementation Package.
org.jline.reader.impl.completer	JLine 3 Completer Implementations.
org.jline.reader.impl.history	JLine 3 History Implementation Package.
org.jline.shell	Clean shell API for building interactive command-line applications with JLine.
org.jline.shell.impl	Default implementations of the shell API interfaces.
org.jline.shell.widget	Widgets for the JLine shell API.
org.jline.widget	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 LineReader

Modifier and Type	Method	Description
static 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 lineReader)	Configures a LineReader using the default inputrc files.
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.
static void	InputRC.configure(LineReader lineReader, Path path)	Configures a LineReader from an inputrc file located at the specified file path, if that's an existing readable file.
Object	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.builtins.ssh

Methods in org.jline.builtins.ssh with parameters of type LineReader

Modifier and Type	Method	Description
void	Ssh.ssh(Terminal terminal, LineReader reader, String user, InputStream stdin, PrintStream stdout, PrintStream stderr, String[] argv)	Connects to an SSH server and either executes a remote command or opens an interactive shell.

Uses of LineReader in org.jline.console

Methods in org.jline.console with parameters of type LineReader

Modifier and Type	Method	Description
void	ConsoleEngine.setLineReader(LineReader reader)	Deprecated. 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 LineReader

Modifier and Type	Method	Description
void	ConsoleEngineImpl.VariableReferenceCompleter.complete(LineReader reader, ParsedLine commandLine, List<Candidate> candidates)
protected 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)
AttributedString	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 LineReader

Modifier and Type	Method	Description
LineReader	LineReaderBuilder.build()	Builds and returns a LineReader instance with the configured options.
LineReader	LineReader.option(LineReader.Option option, boolean value)	Sets an option in the LineReader and returns the LineReader for method chaining.
LineReader	LineReader.variable(String name, Object value)	Sets a variable in the LineReader and returns the LineReader for method chaining.

Methods in org.jline.reader with parameters of type LineReader

Modifier and Type	Method	Description
void	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.
AttributedString	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

Modifier	Constructor	Description
	PrintAboveWriter(LineReader reader)

Uses of LineReader in org.jline.reader.impl

Classes in org.jline.reader.impl that implement LineReader

Modifier and Type	Class	Description
class	LineReaderImpl	The default implementation of the LineReader interface.

Methods in org.jline.reader.impl that return LineReader

Modifier and Type	Method	Description
LineReader	LineReaderImpl.option(LineReader.Option option, boolean value)
LineReader	LineReaderImpl.variable(String name, Object value)

Methods in org.jline.reader.impl with parameters of type LineReader

Modifier and Type	Method	Description
protected 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.
AttributedString	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 LineReader

Modifier and Type	Method	Description
void	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	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 LineReader

Modifier and Type	Method	Description
void	DefaultHistory.attach(LineReader reader)	Attaches this history to a LineReader.

Constructors in org.jline.reader.impl.history with parameters of type LineReader

Modifier	Constructor	Description
	DefaultHistory(LineReader reader)	Creates a new DefaultHistory instance and attaches it to the specified LineReader.

Uses of LineReader in org.jline.shell

Methods in org.jline.shell that return LineReader

Modifier and Type	Method	Description
LineReader	Shell.reader()	Returns the line reader used by this shell.

Method parameters in org.jline.shell with type arguments of type LineReader

Modifier and Type	Method	Description
ShellBuilder	ShellBuilder.onReaderReady(BiConsumer<LineReader,CommandDispatcher> onReaderReady)	Sets a callback invoked after the LineReader is created but before Shell.run().
ShellBuilder	ShellBuilder.onReaderReady(Consumer<LineReader> onReaderReady)	Sets a callback invoked after the LineReader is created but before Shell.run().

Uses of LineReader in org.jline.shell.impl

Methods in org.jline.shell.impl with parameters of type LineReader

Modifier and Type	Method	Description
AttributedString	CommandHighlighter.highlight(LineReader reader, String buffer)

Constructors in org.jline.shell.impl with parameters of type LineReader

Modifier	Constructor	Description
	DefaultCommandDispatcher(LineReader reader)	Creates a new dispatcher for the given reader.
	HistoryCommands(LineReader reader)	Creates history commands using the given line reader's history.
	OptionCommands(LineReader reader)	Creates option commands for the given line reader.

Uses of LineReader in org.jline.shell.widget

Fields in org.jline.shell.widget declared as LineReader

Modifier and Type	Field	Description
protected final LineReader	AutopairWidgets.reader
protected final LineReader	CommandTailTipWidgets.reader

Constructors in org.jline.shell.widget with parameters of type LineReader

Modifier	Constructor	Description
	AutopairWidgets(LineReader reader)	Creates autopair widgets without curly brace support.
	AutopairWidgets(LineReader reader, boolean addCurlyBrackets)	Creates autopair widgets with optional curly brace support.
	CommandTailTipWidgets(LineReader reader, Function<CommandLine,CommandDescription> descFun, int descriptionSize, CommandTailTipWidgets.TipType tipType)	Creates widgets using a dynamic description function.
	CommandTailTipWidgets(LineReader reader, Map<String,CommandDescription> tailTips)	Creates widgets using a static map of command descriptions.
	CommandTailTipWidgets(LineReader reader, Map<String,CommandDescription> tailTips, int descriptionSize)	Creates widgets using a static map with a status bar.
	CommandTailTipWidgets(LineReader reader, Map<String,CommandDescription> tailTips, int descriptionSize, CommandTailTipWidgets.TipType tipType)	Creates widgets using a static map with full configuration.
	CommandTailTipWidgets(LineReader reader, Map<String,CommandDescription> tailTips, CommandTailTipWidgets.TipType tipType)	Creates widgets using a static map with a specific tip type.
	CommandTailTipWidgets(LineReader reader, CommandDispatcher dispatcher)	Creates widgets using a CommandDispatcher for dynamic description lookup.
	CommandTailTipWidgets(LineReader reader, CommandDispatcher dispatcher, int descriptionSize)	Creates widgets using a CommandDispatcher with a status bar.
	CommandTailTipWidgets(LineReader reader, CommandDispatcher dispatcher, int descriptionSize, CommandTailTipWidgets.TipType tipType)	Creates widgets using a CommandDispatcher with full configuration.

Uses of LineReader in org.jline.widget

Fields in org.jline.widget declared as LineReader

Modifier and Type	Field	Description
protected final LineReader	Widgets.reader	The LineReader instance associated with these widgets

Constructors in org.jline.widget with parameters of type LineReader

Modifier	Constructor	Description
	AutopairWidgets(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.