Class WhatisCommand

java.lang.Object

com.ibm.java.diagnostics.utils.commands.BaseCommand

com.ibm.jvm.dtfjview.commands.BaseJdmpviewCommand

com.ibm.jvm.dtfjview.commands.WhatisCommand

All Implemented Interfaces:

ICommand

public class WhatisCommand
extends BaseJdmpviewCommand

Nested Class Summary

Nested classes/interfaces declared in class BaseJdmpviewCommand

BaseJdmpviewCommand.ArtifactType

Modifier and Type	Class	Description
protected static enum	BaseJdmpviewCommand.ArtifactType	Enum for identifying the type of artifact that is currently being analyzed.

Field Summary

Fields declared in class BaseJdmpviewCommand

ctx, hexfmt, logger, out

Modifier and Type	Field	Description
protected IDTFJContext	ctx
protected String	hexfmt
protected Logger	logger
protected PrintStream	out

Fields declared in class BaseCommand

COMMAND_FORMAT, config, nl, SUBCOMMAND_FORMAT

Modifier and Type	Field	Description
protected static final String	COMMAND_FORMAT
protected PluginConfig	config
protected static final String	nl
protected static final String	SUBCOMMAND_FORMAT

Constructor Summary

Constructors

Constructor	Description
WhatisCommand()

Method Summary

Modifier and Type	Method	Description
void	printDetailedHelp(PrintStream out)	Print detailed help for a given command
void	run(String command, String[] args, IContext context, PrintStream out)	Executes the command

Methods declared in class BaseJdmpviewCommand

decodeThreadState, getArtifactType, handleException, initCommand, toHexString, toHexString, toHexString, toHexString, toHexStringAddr, toLong, toString, toString

Modifier and Type	Method	Description
String	decodeThreadState(int state)	Textual description of a thread state.
protected BaseJdmpviewCommand.ArtifactType	getArtifactType()	Determine the type of artifact currently being operated on.
String	handleException(Throwable cause)	Lots of DTFJ methods will throw a standard set of exceptions such as corrupt data or data unavailable.
final boolean	initCommand(String command, String[] args, IContext context, PrintStream out)	Common processing to initialize the command and make the porting of existing jdmpview commands easier.
String	toHexString(byte num)	Format a number with the correct number of zeros as padding according to the data type passed in.
String	toHexString(int num)	Format a number with the correct number of zeros as padding according to the data type passed in.
String	toHexString(long num)	Format a number with the correct number of zeros as padding according to the data type passed in.
String	toHexString(short num)	Format a number with the correct number of zeros as padding according to the data type passed in.
String	toHexStringAddr(long num)	Format an address as hex padded with zeros according to the size of the process. e.g. 17 would be formatted as 0x00000011 for 32 bit and 0x0000000000000011 for 64 bit
long	toLong(String number)	Typically used when an extension takes a numeric argument, and wants to accept a variety of formats.
String	toString(double num)	Convenience method to convert a number into a String to display.
String	toString(float num)	Convenience method to convert a number into a String to display.

Methods declared in class BaseCommand

addCommand, addSubCommand, getCommandDescriptions, getCommandNames, getConfig, recognises, setConfig

Modifier and Type	Method	Description
CommandDescription	addCommand(String name, String argDescription, String helpDescription)
void	addSubCommand(String cmdname, String subname, String argDescription, String help)
Collection<String>	getCommandDescriptions()
Collection<String>	getCommandNames()
PluginConfig	getConfig()	Identifies the configuration from which this command was created.
boolean	recognises(String command, IContext context)	Method used by an interactive engine to decide whether this command matches the command passed in by the user
void	setConfig(PluginConfig config)

Methods declared in class Object

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

Constructor Details

WhatisCommand

public WhatisCommand()

Method Details

run

public void run(String command,
 String[] args,
 IContext context,
 PrintStream out)
         throws CommandException

Description copied from interface: ICommand

Executes the command

Parameters:

command - Command string e.g. !j9x

args - Arguments for command

context - Context to work in

out - PrintStream to write command output on

Throws:

CommandException - If there is any problem running the command (incorrect usage, CorruptData etc.)

printDetailedHelp

public void printDetailedHelp(PrintStream out)

Description copied from class: BaseJdmpviewCommand

Print detailed help for a given command

Specified by:

printDetailedHelp in class BaseJdmpviewCommand

Parameters:

out - stream to write the output to