Package org.jline.console.impl
Class AbstractCommandRegistry
- java.lang.Object
-
- org.jline.console.impl.AbstractCommandRegistry
-
- All Implemented Interfaces:
CommandRegistry
- Direct Known Subclasses:
JlineCommandRegistry
public abstract class AbstractCommandRegistry extends java.lang.Object implements CommandRegistry
CommandRegistry common methods.- Author:
- Matti Rinta-Nikkola
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.jline.console.CommandRegistry
CommandRegistry.CommandSession
-
-
Constructor Summary
Constructors Constructor Description AbstractCommandRegistry()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
alias(java.lang.String alias, java.lang.String command)
java.util.Map<java.lang.String,java.lang.String>
commandAliases()
Returns a map of alias-to-command names known by this registry.java.util.Set<java.lang.String>
commandNames()
Returns the command names known by this registry.SystemCompleter
compileCompleters()
Returns aSystemCompleter
that can provide detailed completion information for all registered commands.CmdDesc
doHelpDesc(java.lang.String command, java.util.List<java.lang.String> info, CmdDesc cmdDesc)
CommandMethods
getCommandMethods(java.lang.String command)
boolean
hasCommand(java.lang.String command)
Returns whether a command with the specified name is known to this registry.java.lang.Object
invoke(CommandRegistry.CommandSession session, java.lang.String command, java.lang.Object... args)
Execute a command.void
registerCommands(java.util.Map<java.lang.String,CommandMethods> commandExecute)
<T extends java.lang.Enum<T>>
voidregisterCommands(java.util.Map<T,java.lang.String> commandName, java.util.Map<T,CommandMethods> commandExecute)
java.lang.Object
registeredCommand(java.lang.String command)
<V extends java.lang.Enum<V>>
voidrename(V command, java.lang.String newName)
void
saveException(java.lang.Exception exception)
-
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
commandDescription, commandInfo, name
-
-
-
-
Method Detail
-
doHelpDesc
public CmdDesc doHelpDesc(java.lang.String command, java.util.List<java.lang.String> info, CmdDesc cmdDesc)
-
registerCommands
public <T extends java.lang.Enum<T>> void registerCommands(java.util.Map<T,java.lang.String> commandName, java.util.Map<T,CommandMethods> commandExecute)
-
registerCommands
public void registerCommands(java.util.Map<java.lang.String,CommandMethods> commandExecute)
-
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:CommandRegistry
Execute a command.- Specified by:
invoke
in 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
-
saveException
public void saveException(java.lang.Exception exception)
-
hasCommand
public boolean hasCommand(java.lang.String command)
Description copied from interface:CommandRegistry
Returns whether a command with the specified name is known to this registry.- Specified by:
hasCommand
in interfaceCommandRegistry
- Parameters:
command
- the command name to test- Returns:
- true if the specified command is registered
-
commandNames
public java.util.Set<java.lang.String> commandNames()
Description copied from interface:CommandRegistry
Returns the command names known by this registry.- Specified by:
commandNames
in 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:CommandRegistry
Returns a map of alias-to-command names known by this registry.- Specified by:
commandAliases
in interfaceCommandRegistry
- Returns:
- a map with alias keys and command name values
-
rename
public <V extends java.lang.Enum<V>> void rename(V command, java.lang.String newName)
-
alias
public void alias(java.lang.String alias, java.lang.String command)
-
compileCompleters
public SystemCompleter compileCompleters()
Description copied from interface:CommandRegistry
Returns aSystemCompleter
that can provide detailed completion information for all registered commands.- Specified by:
compileCompleters
in interfaceCommandRegistry
- Returns:
- a SystemCompleter that can provide command completion for all registered commands
-
getCommandMethods
public CommandMethods getCommandMethods(java.lang.String command)
-
registeredCommand
public java.lang.Object registeredCommand(java.lang.String command)
-
-