Package org.jline.console.impl
Class CommandRegistryAdapter
- java.lang.Object
-
- org.jline.console.impl.CommandRegistryAdapter
-
- All Implemented Interfaces:
CommandRegistry
public class CommandRegistryAdapter extends java.lang.Object implements CommandRegistry
Adapts a newCommandGroupto the oldCommandRegistryinterface.This bridge allows new-style command groups to be used with the legacy
SystemRegistryImpland other old API consumers.- Since:
- 4.0
- See Also:
CommandGroupAdapter
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.jline.console.CommandRegistry
CommandRegistry.CommandSession
-
-
Constructor Summary
Constructors Constructor Description CommandRegistryAdapter(CommandGroup group)Creates an adapter wrapping the given command group.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.String>commandAliases()Returns a map of alias-to-command names known by this registry.CmdDesccommandDescription(java.util.List<java.lang.String> args)Returns a command description for use in the JLine Widgets framework.java.util.List<java.lang.String>commandInfo(java.lang.String command)Returns a short info about command known by this registry.java.util.Set<java.lang.String>commandNames()Returns the command names known by this registry.SystemCompletercompileCompleters()Returns aSystemCompleterthat can provide detailed completion information for all registered commands.booleanhasCommand(java.lang.String command)Returns whether a command with the specified name is known to this registry.java.lang.Objectinvoke(CommandRegistry.CommandSession session, java.lang.String command, java.lang.Object... args)Execute a command.java.lang.Stringname()Returns the name of this registry.
-
-
-
Constructor Detail
-
CommandRegistryAdapter
public CommandRegistryAdapter(CommandGroup group)
Creates an adapter wrapping the given command group.- Parameters:
group- the new command group to adapt
-
-
Method Detail
-
name
public java.lang.String name()
Description copied from interface:CommandRegistryReturns the name of this registry.- Specified by:
namein interfaceCommandRegistry- Returns:
- the name of the registry
-
commandNames
public java.util.Set<java.lang.String> commandNames()
Description copied from interface:CommandRegistryReturns the command names known by this registry.- Specified by:
commandNamesin interfaceCommandRegistry- Returns:
- the set of known command names, excluding aliases
-
commandAliases
public java.util.Map<java.lang.String,java.lang.String> commandAliases()
Description copied from interface:CommandRegistryReturns a map of alias-to-command names known by this registry.- Specified by:
commandAliasesin interfaceCommandRegistry- Returns:
- a map with alias keys and command name values
-
commandInfo
public java.util.List<java.lang.String> commandInfo(java.lang.String command)
Description copied from interface:CommandRegistryReturns a short info about command known by this registry.- Specified by:
commandInfoin interfaceCommandRegistry- Parameters:
command- the command name- Returns:
- a short info about command
-
hasCommand
public boolean hasCommand(java.lang.String command)
Description copied from interface:CommandRegistryReturns whether a command with the specified name is known to this registry.- Specified by:
hasCommandin interfaceCommandRegistry- Parameters:
command- the command name to test- Returns:
- true if the specified command is registered
-
compileCompleters
public SystemCompleter compileCompleters()
Description copied from interface:CommandRegistryReturns aSystemCompleterthat can provide detailed completion information for all registered commands.- Specified by:
compileCompletersin interfaceCommandRegistry- Returns:
- a SystemCompleter that can provide command completion for all registered commands
-
commandDescription
public CmdDesc commandDescription(java.util.List<java.lang.String> args)
Description copied from interface:CommandRegistryReturns a command description for use in the JLine Widgets framework. Default method must be overridden to return sub command descriptions.- Specified by:
commandDescriptionin interfaceCommandRegistry- Parameters:
args- command (args[0]) and its arguments- Returns:
- command description for JLine TailTipWidgets to be displayed in the terminal status bar.
-
invoke
public java.lang.Object invoke(CommandRegistry.CommandSession session, java.lang.String command, java.lang.Object... args) throws java.lang.Exception
Description copied from interface:CommandRegistryExecute a command.- Specified by:
invokein interfaceCommandRegistry- Parameters:
session- the data of the current command sessioncommand- the name of the commandargs- arguments of the command- Returns:
- result of the command execution
- Throws:
java.lang.Exception- in case of error
-
-