Package org.jline.console.impl

Class Builtins

java.lang.Object

org.jline.console.impl.AbstractCommandRegistry

org.jline.console.impl.JlineCommandRegistry

org.jline.console.impl.Builtins

All Implemented Interfaces:

CommandRegistry

public class Builtins
extends JlineCommandRegistry
implements CommandRegistry

Implementation of CommandRegistry that provides built-in commands for JLine.

The Builtins class provides a set of common commands that are useful in any JLine-based console application, such as:

• File editing (nano)
• File viewing (less)
• Command history management
• Widget and keymap configuration
• Terminal and system information display

This class creates tab completers, executes commands, and provides descriptions for these built-in commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Builtins.Command	Enumeration of built-in commands provided by this class.

Nested classes/interfaces inherited from interface org.jline.console.CommandRegistry

CommandRegistry.CommandSession

Field Summary

Fields

Modifier and Type	Field	Description
private final ConfigurationPath	configPath
private LineReader	reader
private final Function<String,Widget>	widgetCreator
private final Supplier<Path>	workDir

Constructor Summary

Constructors

Constructor	Description
Builtins(Path workDir, ConfigurationPath configPath, Function<String,Widget> widgetCreator)
Builtins(Supplier<Path> workDir, ConfigurationPath configPath, Function<String,Widget> widgetCreator)
Builtins(Set<Builtins.Command> commands, Path workDir, ConfigurationPath configpath, Function<String,Widget> widgetCreator)
Builtins(Set<Builtins.Command> commands, Supplier<Path> workDir, ConfigurationPath configpath, Function<String,Widget> widgetCreator)

Method Summary

Modifier and Type	Method	Description
private Set<String>	allWidgets()
private void	colors(CommandInput input)
private void	highlighter(CommandInput input)
private List<Completer>	highlighterCompleter(String name)
private void	history(CommandInput input)
private List<Completer>	historyCompleter(String name)
private void	keymap(CommandInput input)
private void	less(CommandInput input)
private List<Completer>	lessCompleter(String name)
private void	nano(CommandInput input)
private List<Completer>	nanoCompleter(String name)
void	setLineReader(LineReader reader)
private void	setopt(CommandInput input)
private List<Completer>	setoptCompleter(String name)
private void	setvar(CommandInput input)
private List<Completer>	setvarCompleter(String name)
private void	ttop(CommandInput input)
private void	unsetopt(CommandInput input)
private List<Completer>	unsetoptCompleter(String name)
private List<String>	unsetOptions(boolean set)
private void	widget(CommandInput input)
private List<Completer>	widgetCompleter(String name)

Methods inherited from class org.jline.console.impl.JlineCommandRegistry

commandDescription, commandInfo, commandOptions, compileCommandDescription, compileCommandInfo, compileCommandOptions, defaultCompleter, parseOptions

Methods inherited from class org.jline.console.impl.AbstractCommandRegistry

alias, commandAliases, commandNames, compileCompleters, doHelpDesc, getCommandMethods, hasCommand, invoke, registerCommands, registerCommands, registeredCommand, rename, saveException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jline.console.CommandRegistry

commandAliases, commandDescription, commandInfo, commandNames, compileCompleters, hasCommand, invoke, name

Field Details

configPath

private final ConfigurationPath configPath

widgetCreator

private final Function<String,Widget> widgetCreator

workDir

private final Supplier<Path> workDir

reader

private LineReader reader

Constructor Details

Builtins

public Builtins(Path workDir,
 ConfigurationPath configPath,
 Function<String,Widget> widgetCreator)

Builtins

public Builtins(Set<Builtins.Command> commands,
 Path workDir,
 ConfigurationPath configpath,
 Function<String,Widget> widgetCreator)

Builtins

public Builtins(Supplier<Path> workDir,
 ConfigurationPath configPath,
 Function<String,Widget> widgetCreator)

Builtins

public Builtins(Set<Builtins.Command> commands,
 Supplier<Path> workDir,
 ConfigurationPath configpath,
 Function<String,Widget> widgetCreator)

Method Details

setLineReader

public void setLineReader(LineReader reader)

less

private void less(CommandInput input)

nano

private void nano(CommandInput input)

history

private void history(CommandInput input)

widget

private void widget(CommandInput input)

keymap

private void keymap(CommandInput input)

setopt

private void setopt(CommandInput input)

setvar

private void setvar(CommandInput input)

unsetopt

private void unsetopt(CommandInput input)

ttop

private void ttop(CommandInput input)

colors

private void colors(CommandInput input)

highlighter

private void highlighter(CommandInput input)

unsetOptions

private List<String> unsetOptions(boolean set)

highlighterCompleter

private List<Completer> highlighterCompleter(String name)

allWidgets

private Set<String> allWidgets()

nanoCompleter

private List<Completer> nanoCompleter(String name)

lessCompleter

private List<Completer> lessCompleter(String name)

historyCompleter

private List<Completer> historyCompleter(String name)

widgetCompleter

private List<Completer> widgetCompleter(String name)

setvarCompleter

private List<Completer> setvarCompleter(String name)

setoptCompleter

private List<Completer> setoptCompleter(String name)

unsetoptCompleter

private List<Completer> unsetoptCompleter(String name)