Class HelpTool

java.lang.Object
com.ibm.jvm.dtfjview.tools.Tool
com.ibm.jvm.dtfjview.tools.impl.HelpTool
All Implemented Interfaces:
ITool

public class HelpTool extends Tool
  • Field Details

  • Constructor Details

    • HelpTool

      public HelpTool()
  • Method Details

    • accept

      public boolean accept(String command, String[] args)
      Determines if a command is accepted by current tool.

      Parameters:
      command - The command
      args - The arguments taken by the command.

      Returns:
      true if this is the correct tool for this command; false otherwise.
    • process

      public void process(String command, String[] args, PrintStream redirector) throws CommandException
      Processes the command.

      Parameters:
      command - The command to be processed.
      args - The arguments taken by the command.
      out - The output channel.

      Throws:
      CommandException
    • printDetailedHelp

      public void printDetailedHelp(PrintStream out)
      To print the detailed help message.
    • getCommandName

      public String getCommandName()
      To gets the tool's command name.

      Returns:
      The tool's command name.
    • getArgumentDescription

      public String getArgumentDescription()
      To gets the tool's argument description.

      Returns:
      The tool's argument description.
    • getHelpDescription

      public String getHelpDescription()
      To gets the tool's help description.

      Returns:
      The tool's help description.