Module openj9.dtfjview

Package com.ibm.jvm.dtfjview.tools

Interface ITool

All Known Implementing Classes:

CharsFromTool, CharsToTool, CmdFileTool, GrepTool, HelpTool, HistoryTool, OutFileTool, TokensTool, Tool

public interface ITool

Method Summary

Modifier and Type	Method	Description
boolean	accept(String command, String[] args)	Determines if a command is accepted by current tool.
void	close()	Closes the tool.
String	getArgumentDescription()	To gets the tool's argument description.
String	getCommandName()	To gets the tool's command name.
String	getHelpDescription()	To gets the tool's help description.
void	printDetailedHelp(PrintStream out)	To print the detailed help message.
void	process(String command, String[] args, PrintStream out)	Processes the command.
boolean	start(String[] args, PrintStream out)	Starts the tool.

Method Detail

start

boolean start(String[] args,
              PrintStream out)
       throws CommandException

Starts the tool.

Parameters:

args - The arguments required to start the tool.

out - The output channel.

Returns:

true if the tool has been started up successfully; false otherwise.

Throws:

CommandException

close

void close()

Closes the tool.

accept

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

void process(String command,
             String[] args,
             PrintStream out)
      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

void printDetailedHelp(PrintStream out)

To print the detailed help message.

getCommandName

String getCommandName()

To gets the tool's command name.

Returns:

The tool's command name.

getArgumentDescription

String getArgumentDescription()

To gets the tool's argument description.

Returns:

The tool's argument description.

getHelpDescription

String getHelpDescription()

To gets the tool's help description.

Returns:

The tool's help description.