Package org.seedstack.seed.command

Interface CommandRegistry

public interface CommandRegistry

The command registry holds all command definitions and can be used to retrieve additional information on them.

Method Summary

Modifier and Type	Method	Description
Command	createCommand(String scope, String name, List<String> argValues, Map<String,String> optionValues)	Instantiates a Command object given a scope, a name and a list of arguments and options.
List<Argument>	getArgumentsInfo(String scope, String name)	Retrieves the argument list of a command.
CommandDefinition	getCommandInfo(String scope, String name)	Retrieves the command definition.
Set<String>	getCommandList()	Retrieves list of all registered commands.
List<Option>	getOptionsInfo(String scope, String name)	Retrieves the options list of a command.

Method Detail

getCommandList

Set<String> getCommandList()

Retrieves list of all registered commands.

Returns:

the list of fully qualified (scope:name) commands.

getOptionsInfo

List<Option> getOptionsInfo(String scope,
                            String name)

Retrieves the options list of a command.

Parameters:

scope - the command scope.

name - the command name.

Returns:

the list of Option.

getArgumentsInfo

List<Argument> getArgumentsInfo(String scope,
                                String name)

Retrieves the argument list of a command.

Parameters:

scope - the command scope.

name - the command name.

Returns:

the list of Argument.

getCommandInfo

CommandDefinition getCommandInfo(String scope,
                                 String name)

Retrieves the command definition.

Parameters:

scope - the command scope.

name - the command name.

Returns:

the CommandDefinition object.

createCommand

Command createCommand(String scope,
                      String name,
                      List<String> argValues,
                      Map<String,String> optionValues)

Instantiates a Command object given a scope, a name and a list of arguments and options.

Parameters:

scope - the command scope.

name - the command name.

argValues - the argument values.

optionValues - the option values.

Returns:

the Command object, already initialized and injected with corresponding values.