org.ow2.jasmine.monitoring.mbeancmd
Class AbstractCommand

java.lang.Object
  org.ow2.jasmine.monitoring.mbeancmd.AbstractCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

Dump, JDBCConnections, Mbean, MLoad, MonologJMX, Poll, Replay, Scan, Snap, Stat

public abstract class AbstractCommand
extends java.lang.Object
implements Command

A Command which has some methods implemented.

Field Summary

protected java.lang.String[]	arguments Command arguments.
protected org.ow2.util.log.Log	logger Logger.
protected java.lang.String	name Name of the command.
static java.text.SimpleDateFormat	SIMPLEDATEFORMAT Date format.

Constructor Summary

AbstractCommand()

Method Summary

abstract int	exec(CommandDispatcher cmdDispatcher) Abstract redefinition of inherited method.
protected java.lang.String	getHelpDoc() Gets the help document corresponding to this command.
java.lang.String	getName() Implementation of inherited method.
void	help() Implementation of inherited method.
void	setArgs(java.lang.String cmd, java.lang.String[] args) Implementation of inherited method.
abstract java.lang.String	summary() Abstract redefinition of inherited method.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

Name of the command.

arguments

protected java.lang.String[] arguments

Command arguments.

SIMPLEDATEFORMAT

public static final java.text.SimpleDateFormat SIMPLEDATEFORMAT

Date format.

logger

protected org.ow2.util.log.Log logger

Logger.

Constructor Detail

AbstractCommand

public AbstractCommand()

Method Detail

exec

public abstract int exec(CommandDispatcher cmdDispatcher)

Abstract redefinition of inherited method. Executes the command.

Specified by:

exec in interface Command

Returns:

0 if succeeded, an error code otherwise.

See Also:

org.ow2.jasmine.monitoring.mbeancmd.Command#exec()

getName

public final java.lang.String getName()

Implementation of inherited method. Retrieves the name of the command.

Specified by:

getName in interface Command

Returns:

Name of the command.

See Also:

Command.getName()

getHelpDoc

protected java.lang.String getHelpDoc()

Gets the help document corresponding to this command.

Returns:

Name of the help document corresponding to this command.

help

public void help()

Implementation of inherited method. Displays the help for this command.

Specified by:

help in interface Command

See Also:

Command.help(), getHelpDoc()

setArgs

public final void setArgs(java.lang.String cmd,
                          java.lang.String[] args)

Implementation of inherited method. Sets command name and arguments.

Specified by:

setArgs in interface Command

Parameters:

cmd - Command name.

args - Command arguments.

See Also:

Command.setArgs(java.lang.String, java.lang.String[])

summary

public abstract java.lang.String summary()

Abstract redefinition of inherited method. Retrieves the command's summary.

Specified by:

summary in interface Command

Returns:

Command's summary.

See Also:

Command.summary()