Module openj9.dtfjview

Package com.ibm.jvm.dtfjview.tools.impl

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 Summary

Fields

Modifier and Type	Field	Description
static String	COMMAND
static String	COMMAND_FORMAT
static String	HELP_DESCRIPTION
static String	JDMPVIEW_HELP_COMMAND
static String	USAGE

Constructor Summary

Constructors

Constructor	Description
HelpTool()

Method Summary

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 redirector)	Processes the command.

Methods declared in class com.ibm.jvm.dtfjview.tools.Tool

close, start

Methods declared in class java.lang.Object

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

Field Detail

COMMAND

public static final String COMMAND

See Also:

Constant Field Values

HELP_DESCRIPTION

public static final String HELP_DESCRIPTION

See Also:

Constant Field Values

USAGE

public static final String USAGE

See Also:

Constant Field Values

JDMPVIEW_HELP_COMMAND

public static final String JDMPVIEW_HELP_COMMAND

See Also:

Constant Field Values

COMMAND_FORMAT

public static final String COMMAND_FORMAT

See Also:

Constant Field Values

Constructor Detail

HelpTool

public HelpTool()

Method Detail

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.