Class Tool

java.lang.Object

com.ibm.jvm.dtfjview.tools.Tool

All Implemented Interfaces:

ITool

Direct Known Subclasses:

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

public abstract class Tool
extends Object
implements ITool

Constructor Summary

Constructors

Constructor	Description
Tool()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the tool.
boolean	start(String[] args, PrintStream out)	Starts the tool.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods declared in interface ITool

accept, getArgumentDescription, getCommandName, getHelpDescription, printDetailedHelp, process

Modifier and Type	Method	Description
boolean	accept(String command, String[] args)	Determines if a command is accepted by current 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.

Constructor Details

Tool

public Tool()

Method Details

start

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

Starts the tool.

Specified by:

start in interface ITool

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

public void close()

Closes the tool.

Specified by:

close in interface ITool