org.jline.builtins

Class Builtins

java.lang.Object

org.jline.builtins.Builtins

All Implemented Interfaces:

CommandRegistry

public class Builtins
extends Object
implements CommandRegistry

Builtins: create tab completers, execute and create descriptions for builtins commands.

Author:

Matti Rinta-Nikkola

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Builtins.Command
static class	Builtins.CommandInput
static class	Builtins.CommandMethods

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

CommandRegistry.CommandSession

Constructor Summary

Constructors

Constructor and Description
Builtins(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)
Builtins(Supplier<Path> workDir, ConfigurationPath configPath, Function<String,Widget> widgetCreator)

Method Summary

Modifier and Type	Method and Description
void	alias(String alias, String command)
Map<String,String>	commandAliases() Returns a map of alias-to-command names known by this registry.
Set<String>	commandNames() Returns the command names known by this registry.
static Widgets.CmdDesc	compileCommandDescription(String helpMessage)
static List<String>	compileCommandInfo(String helpMessage)
static List<Completers.OptDesc>	compileCommandOptions(String helpMessage)
Completers.SystemCompleter	compileCompleters() Returns a SystemCompleter that can provide detailed completion information for all registered commands.
Object	execute(CommandRegistry.CommandSession session, String command, String[] args) Execute a command that have only string parameters and options.
boolean	hasCommand(String name) Returns whether a command with the specified name is known to this registry.
void	rename(Builtins.Command command, String newName)
void	setLineReader(LineReader reader)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.builtins.CommandRegistry

aggregateCompleters, commandDescription, commandInfo, compileCompleters, invoke, name

Constructor Detail

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 Detail

commandNames

public Set<String> commandNames()

Description copied from interface: CommandRegistry

Returns the command names known by this registry.

Specified by:

commandNames in interface CommandRegistry

Returns:

the set of known command names, excluding aliases

commandAliases

public Map<String,String> commandAliases()

Description copied from interface: CommandRegistry

Returns a map of alias-to-command names known by this registry.

Specified by:

commandAliases in interface CommandRegistry

Returns:

a map with alias keys and command name values

setLineReader

public void setLineReader(LineReader reader)

rename

public void rename(Builtins.Command command,
                   String newName)

alias

public void alias(String alias,
                  String command)

hasCommand

public boolean hasCommand(String name)

Description copied from interface: CommandRegistry

Returns whether a command with the specified name is known to this registry.

Specified by:

hasCommand in interface CommandRegistry

Parameters:

name - the command name to test

Returns:

true if the specified command is registered

compileCompleters

public Completers.SystemCompleter compileCompleters()

Description copied from interface: CommandRegistry

Returns a SystemCompleter that can provide detailed completion information for all registered commands.

Specified by:

compileCompleters in interface CommandRegistry

Returns:

a SystemCompleter that can provide command completion for all registered commands

execute

public Object execute(CommandRegistry.CommandSession session,
                      String command,
                      String[] args)
               throws Exception

Description copied from interface: CommandRegistry

Execute a command that have only string parameters and options. Implementation of the method is required when aggregating command registries using SystemRegistry.

Specified by:

execute in interface CommandRegistry

Parameters:

session - the data of the current command session

command - the name of the command

args - arguments of the command

Returns:

result of the command execution

Throws:

Exception - in case of error

compileCommandDescription

public static Widgets.CmdDesc compileCommandDescription(String helpMessage)

compileCommandOptions

public static List<Completers.OptDesc> compileCommandOptions(String helpMessage)

compileCommandInfo

public static List<String> compileCommandInfo(String helpMessage)