Package de.hsh.graja.gui.cli
Class GuiCommandProvider
- java.lang.Object
-
- de.hsh.graja.util.cli.CommandProvider
-
- de.hsh.graja.gui.cli.GuiCommandProvider
-
- All Implemented Interfaces:
Comparable<CommandProvider>
public class GuiCommandProvider extends CommandProvider
This class provides a command on the command line for the JavaFX GUI client.
-
-
Constructor Summary
Constructors Constructor Description GuiCommandProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
executeCommand(Logging log, String command, TreeMap<String,Object> options)
This is themain
method of a command.protected String
getAdditionalAddModulesOption(String command)
For usage printout this method should return a comma-separated list of modules that need to be added on the command line to get thecommand
running.protected String
getAdditionalModulePathOptionExample(String command)
For usage printout this method should return a path-delimiter-separated list of module paths that need to be added on the --module-path command line option to get thecommand
running.protected String
getAdditionalModulePathOptionTemplate(String command)
For usage printout this method should return a path-delimiter-separated list of module paths that need to be added on the --module-path command line option to get thecommand
running.protected String[]
getCommands(Logging log)
-
Methods inherited from class de.hsh.graja.util.cli.CommandProvider
compareTo, equals, getName, hashCode, provideCommands, validateCommand
-
-
-
-
Method Detail
-
getCommands
protected String[] getCommands(Logging log)
- Specified by:
getCommands
in classCommandProvider
-
getAdditionalAddModulesOption
protected String getAdditionalAddModulesOption(String command)
Description copied from class:CommandProvider
For usage printout this method should return a comma-separated list of modules that need to be added on the command line to get thecommand
running.- Overrides:
getAdditionalAddModulesOption
in classCommandProvider
- Returns:
- Default: ""
-
getAdditionalModulePathOptionTemplate
protected String getAdditionalModulePathOptionTemplate(String command)
Description copied from class:CommandProvider
For usage printout this method should return a path-delimiter-separated list of module paths that need to be added on the --module-path command line option to get thecommand
running.- Overrides:
getAdditionalModulePathOptionTemplate
in classCommandProvider
- Returns:
- Default: ""
-
getAdditionalModulePathOptionExample
protected String getAdditionalModulePathOptionExample(String command)
Description copied from class:CommandProvider
For usage printout this method should return a path-delimiter-separated list of module paths that need to be added on the --module-path command line option to get thecommand
running.- Overrides:
getAdditionalModulePathOptionExample
in classCommandProvider
- Returns:
- Default: ""
-
executeCommand
public void executeCommand(Logging log, String command, TreeMap<String,Object> options) throws CommandException
Description copied from class:CommandProvider
This is themain
method of a command. It is called byCommand.execute(Logging, String[])
.- Specified by:
executeCommand
in classCommandProvider
- Parameters:
log
- All output should go to this Logging instance- Throws:
CommandException
-
-