Interface IJEMHCommandSetProvider
-
- All Superinterfaces:
IJEMHModuleProvider
public interface IJEMHCommandSetProvider extends IJEMHModuleProvider
Implementing classes can be used to contribute to the pool of commands available
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
canHandle(String commandString)
For an entire command , determine if the provider can handle itString
getCommandDescription(String command)
provides text description for the commands returned by getCommands()Set<String>
getCommands()
provide the keywords to activate the command, for informationCommandResult
invokeCommand(com.atlassian.jira.user.ApplicationUser user, String commandString)
run the given command with arguments-
Methods inherited from interface com.javahollic.jira.emh.api.extension.IJEMHModuleProvider
getDescription, getKey, getName, getStatus, getVendor, getVendorUrl, isUsable
-
-
-
-
Method Detail
-
getCommands
Set<String> getCommands()
provide the keywords to activate the command, for information- Returns:
- simple set of commands indicating capabilities of the CommandSet
-
getCommandDescription
String getCommandDescription(String command)
provides text description for the commands returned by getCommands()- Parameters:
command
- to lookup- Returns:
- description
-
canHandle
boolean canHandle(String commandString)
For an entire command , determine if the provider can handle it- Parameters:
commandString
- to send- Returns:
- true if can handle comment
-
invokeCommand
CommandResult invokeCommand(com.atlassian.jira.user.ApplicationUser user, String commandString) throws CommandHandlingException
run the given command with arguments- Parameters:
user
- for operation contextcommandString
- to invoke- Returns:
- result
- Throws:
CommandHandlingException
- if it breaks
-
-