Class PluginCommand

java.lang.Object

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

com.ibm.java.diagnostics.utils.commands.PluginCommand

All Implemented Interfaces:

ICommand

public class PluginCommand
extends BaseCommand

Command which allows control of the loaded plugins

Field Summary

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
PluginCommand()

Method Summary

Modifier and Type	Method	Description
void	run(String command, String[] args, IContext context, PrintStream out)	Executes the command

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

PluginCommand

public PluginCommand()

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.)