org.apache.activemq.console.command
Class AbstractCommand

java.lang.Object
  org.apache.activemq.console.command.AbstractCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AbstractAmqCommand, AbstractJmxCommand, CreateCommand, EncryptCommand, ShellCommand, StartCommand

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

Field Summary

static java.lang.String	COMMAND_OPTION_DELIMETER
protected CommandContext	context

Constructor Summary

AbstractCommand()

Method Summary

void	execute(java.util.List<java.lang.String> tokens) Execute a generic command, which includes parsing the options for the command and running the specific task.
protected void	handleOption(java.lang.String token, java.util.List<java.lang.String> tokens) Handle the general options for each command, which includes -h, -?, --help, -D, --version.
protected void	parseOptions(java.util.List<java.lang.String> tokens) Parse any option parameters in the command arguments specified by a '-' as the first character of the token.
protected abstract void	printHelp() Print the help messages for the specific task
protected abstract void	runTask(java.util.List<java.lang.String> tokens) Run the specific task.
void	setCommandContext(CommandContext context)

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_OPTION_DELIMETER

public static final java.lang.String COMMAND_OPTION_DELIMETER

See Also:

Constant Field Values

context

protected CommandContext context

Constructor Detail

AbstractCommand

public AbstractCommand()

Method Detail

setCommandContext

public void setCommandContext(CommandContext context)

Specified by:

setCommandContext in interface Command

execute

public void execute(java.util.List<java.lang.String> tokens)
             throws java.lang.Exception

Execute a generic command, which includes parsing the options for the command and running the specific task.

Specified by:

execute in interface Command

Parameters:

tokens - - command arguments

Throws:

java.lang.Exception

parseOptions

protected void parseOptions(java.util.List<java.lang.String> tokens)
                     throws java.lang.Exception

Parse any option parameters in the command arguments specified by a '-' as the first character of the token.

Parameters:

tokens - - command arguments

Throws:

java.lang.Exception

handleOption

protected void handleOption(java.lang.String token,
                            java.util.List<java.lang.String> tokens)
                     throws java.lang.Exception

Handle the general options for each command, which includes -h, -?, --help, -D, --version.

Parameters:

token - - option token to handle

tokens - - succeeding command arguments

Throws:

java.lang.Exception

runTask

protected abstract void runTask(java.util.List<java.lang.String> tokens)
                         throws java.lang.Exception

Run the specific task.

Parameters:

tokens - - command arguments

Throws:

java.lang.Exception

printHelp

protected abstract void printHelp()

Print the help messages for the specific task