org.jline.builtins

Interface CommandRegistry

All Known Subinterfaces:

ConsoleEngine, SystemRegistry

All Known Implementing Classes:

Builtins, ConsoleEngineImpl, SystemRegistryImpl

public interface CommandRegistry

Store command information, compile tab completers and execute registered commands.

Author:

Matti Rinta-Nikkola

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CommandRegistry.CommandSession

Method Summary

Modifier and Type	Method and Description
static Completers.SystemCompleter	aggregateCompleters(CommandRegistry... commandRegistries) Aggregate SystemCompleters of commandRegisteries
Map<String,String>	commandAliases() Returns a map of alias-to-command names known by this registry.
default Widgets.CmdDesc	commandDescription(String command) Returns a command description for use in the JLine Widgets framework.
default List<String>	commandInfo(String command) Returns a short info about command known by this registry.
Set<String>	commandNames() Returns the command names known by this registry.
Completers.SystemCompleter	compileCompleters() Returns a SystemCompleter that can provide detailed completion information for all registered commands.
static Completers.SystemCompleter	compileCompleters(CommandRegistry... commandRegistries) Aggregate and compile SystemCompleters of commandRegisteries
default Object	execute(CommandRegistry.CommandSession session, String command, String[] args) Execute a command that have only string parameters and options.
boolean	hasCommand(String command) Returns whether a command with the specified name is known to this registry.
default Object	invoke(CommandRegistry.CommandSession session, String command, Object... args) Execute a command.
default String	name() Returns the name of this registry.

Method Detail

aggregateCompleters

static Completers.SystemCompleter aggregateCompleters(CommandRegistry... commandRegistries)

Aggregate SystemCompleters of commandRegisteries

Parameters:

commandRegistries - command registeries which completers is to be aggregated

Returns:

uncompiled SystemCompleter

compileCompleters

static Completers.SystemCompleter compileCompleters(CommandRegistry... commandRegistries)

Aggregate and compile SystemCompleters of commandRegisteries

Parameters:

commandRegistries - command registeries which completers is to be aggregated and compile

Returns:

compiled SystemCompleter

name

default String name()

Returns the name of this registry.

Returns:

the name of the registry

commandNames

Set<String> commandNames()

Returns the command names known by this registry.

Returns:

the set of known command names, excluding aliases

commandAliases

Map<String,String> commandAliases()

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

Returns:

a map with alias keys and command name values

commandInfo

default List<String> commandInfo(String command)

Returns a short info about command known by this registry.

Returns:

a short info about command

hasCommand

boolean hasCommand(String command)

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

Parameters:

command - the command name to test

Returns:

true if the specified command is registered

compileCompleters

Completers.SystemCompleter compileCompleters()

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

Returns:

a SystemCompleter that can provide command completion for all registered commands

commandDescription

default Widgets.CmdDesc commandDescription(String command)

Returns a command description for use in the JLine Widgets framework.

Parameters:

command - name of the command whose description to return

Returns:

command description for JLine TailTipWidgets to be displayed in the terminal status bar.

execute

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

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

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

invoke

default Object invoke(CommandRegistry.CommandSession session,
                      String command,
                      Object... args)
               throws Exception

Execute a command. If command has other than string parameters a custom implementation is required. This method will be called only when we have ConsoleEngine in SystemRegistry.

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