org.mbari.siam.utils.isiam
Class BaseCommand

java.lang.Object
  org.mbari.siam.utils.isiam.BaseCommand

public abstract class BaseCommand
extends java.lang.Object

A convenient base ICommand implementation.

Author:

carueda

Field Summary

protected java.lang.String	_name
protected java.lang.String	_nodeUrlArgument
protected java.lang.String	_portNameArgument

Method Summary

java.lang.String	getName() A short name to identify the command
java.lang.String	getNodeUrlArgument() Upon a successful completion of run, this will be called by iSiam to update an internal list of 'nodeUrl' arguments.
java.lang.String	getPortNameArgument() Upon a successful completion of run, this will be called by iSiam to update an internal list of 'portName' arguments.
void	run(java.lang.String[] args) Runs the command

Methods inherited from class java.lang.Object

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

Field Detail

_name

protected final java.lang.String _name

_nodeUrlArgument

protected java.lang.String _nodeUrlArgument

_portNameArgument

protected java.lang.String _portNameArgument

Method Detail

getName

public java.lang.String getName()

A short name to identify the command

getNodeUrlArgument

public java.lang.String getNodeUrlArgument()

Upon a successful completion of run, this will be called by iSiam to update an internal list of 'nodeUrl' arguments.

getPortNameArgument

public java.lang.String getPortNameArgument()

Upon a successful completion of run, this will be called by iSiam to update an internal list of 'portName' arguments.

run

public void run(java.lang.String[] args)
         throws java.lang.Exception

Runs the command

Throws:

java.lang.Exception