Module openj9.dtfjview

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

Class HistoryTool

java.lang.Object

com.ibm.jvm.dtfjview.tools.Tool

com.ibm.jvm.dtfjview.tools.impl.HistoryTool

All Implemented Interfaces:

ITool

public class HistoryTool
extends Tool

Field Summary

Fields

Modifier and Type	Field	Description
static String	ARGUMENT_DESCRIPTION
static String	COMMAND
static String	COMMAND_SHORT
static int	DEFAULT_DISPLAY_N
static String	HELP_DESCRIPTION
static String	USAGE

Constructor Summary

Constructors

Constructor	Description
HistoryTool()

Method Summary

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

COMMAND_SHORT

public static final String COMMAND_SHORT

See Also:

Constant Field Values

DEFAULT_DISPLAY_N

public static final int DEFAULT_DISPLAY_N

See Also:

Constant Field Values

ARGUMENT_DESCRIPTION

public static final String ARGUMENT_DESCRIPTION

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

Constructor Detail

HistoryTool

public HistoryTool()

Method Detail

record

public void record(String cmd)

To record a history command.

Parameters:

cmd - The command to be recorded.

process

public 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

accept

public boolean accept(String command,
                      String[] args)

Determines if a command is accepted by the 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.

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.