Module openj9.dtfjview

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

Class OutFileTool

java.lang.Object

com.ibm.jvm.dtfjview.tools.Tool

com.ibm.jvm.dtfjview.tools.impl.OutFileTool

All Implemented Interfaces:

IPipe, ITool

public class OutFileTool
extends Tool
implements IPipe

Note, this class copied some logic from class com.ibm.java.diagnostics.utils.commands.CommandParser

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARGUMENT_DESCRIPTION
static final String	COMMAND_APPEND
static final String	COMMAND_OVERWRITE
static final String	HELP_DESCRIPTION
static final String	USAGE

Constructor Summary

Constructors

Constructor	Description
OutFileTool()

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 Details

COMMAND_OVERWRITE

public static final String COMMAND_OVERWRITE

See Also:

• Constant Field Values

COMMAND_APPEND

public static final String COMMAND_APPEND

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 Details

OutFileTool

public OutFileTool()

Method Details

accept

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

Determines if a command is accepted by current tool.

Specified by:

accept in interface ITool

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.

Specified by:

process in interface ITool

Parameters:

command - The command to be processed.

args - The arguments taken by the command.

redirector - The output channel.

out - The output channel.

Throws:

CommandException

printDetailedHelp

public void printDetailedHelp(PrintStream out)

To print the detailed help message.

Specified by:

printDetailedHelp in interface ITool

getCommandName

public String getCommandName()

To gets the tool's command name.

Specified by:

getCommandName in interface ITool

Returns:

The tool's command name.

getArgumentDescription

public String getArgumentDescription()

To gets the tool's argument description.

Specified by:

getArgumentDescription in interface ITool

Returns:

The tool's argument description.

getHelpDescription

public String getHelpDescription()

To gets the tool's help description.

Specified by:

getHelpDescription in interface ITool

Returns:

The tool's help description.