org.jline.builtins

Interface CommandRegistry

All Known Implementing Classes:

Builtins

public interface CommandRegistry

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.
Widgets.CmdDesc	commandDescription(String command) Returns a command description for use in the JLine Widgets framework.
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
boolean	hasCommand(String command) Returns whether a command with the specified name is known to this registry.

Method Detail

aggregateCompleters

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

Aggregate SystemCompleters of commandRegisteries

Returns:

uncompiled SystemCompleter

compileCompleters

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

Aggregate and compile SystemCompleters of commandRegisteries

Returns:

compiled SystemCompleter

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

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

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.