- All Known Implementing Classes:
CharsFromTool
,CharsToTool
,CmdFileTool
,GrepTool
,HelpTool
,HistoryTool
,OutFileTool
,TokensTool
,Tool
public interface ITool
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines if a command is accepted by current tool.void
close()
Closes the 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 out) Processes the command.boolean
start
(String[] args, PrintStream out) Starts the tool.
-
Method Details
-
start
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
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
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.
-