java.lang.Object
com.ibm.jvm.dtfjview.tools.Tool
com.ibm.jvm.dtfjview.tools.impl.HelpTool
- All Implemented Interfaces:
ITool
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines if a command is accepted by current tool.To gets the tool's argument description.To gets the tool's command name.To gets the tool's help description.void
To print the detailed help message.void
process
(String command, String[] args, PrintStream redirector) Processes the command.
-
Field Details
-
COMMAND
- See Also:
-
HELP_DESCRIPTION
- See Also:
-
USAGE
- See Also:
-
JDMPVIEW_HELP_COMMAND
- See Also:
-
COMMAND_FORMAT
- See Also:
-
-
Constructor Details
-
HelpTool
public HelpTool()
-
-
Method Details
-
accept
Determines if a command is accepted by current tool.- Parameters:
command
- The commandargs
- The arguments taken by the command.- Returns:
true
if this is the correct tool for this command;false
otherwise.
-
process
Processes the command.- Parameters:
command
- The command to be processed.args
- The arguments taken by the command.out
- The output channel.- Throws:
CommandException
-
printDetailedHelp
To print the detailed help message. -
getCommandName
To gets the tool's command name.- Returns:
- The tool's command name.
-
getArgumentDescription
To gets the tool's argument description.- Returns:
- The tool's argument description.
-
getHelpDescription
To gets the tool's help description.- Returns:
- The tool's help description.
-