org.cyclopsgroup.jmxterm

Class Command

java.lang.Object

org.cyclopsgroup.jmxterm.Command

All Implemented Interfaces:

org.cyclopsgroup.jcli.AutoCompletable

Direct Known Subclasses:

AboutCommand, BeanCommand, BeansCommand, CloseCommand, DomainCommand, DomainsCommand, GetCommand, HelpCommand, InfoCommand, JvmsCommand, OpenCommand, OptionCommand, QuitCommand, RunCommand, SetCommand, SubscribeCommand, UnsubscribeCommand, WatchCommand

public abstract class Command
extends Object
implements org.cyclopsgroup.jcli.AutoCompletable

Base class of all commands. Command is executed in single thread. Extending classes don't need to worry about concurrency. Command is transient, every command in console creates a new instance of Command object which is disposed after execution finishes.

Author:

Jiaqi Guo

Constructor Summary

Constructors

Constructor and Description
Command()

Method Summary

Modifier and Type	Method and Description
protected List<String>	doSuggestArgument() Provide a list of possible arguments for auto completion.
protected List<String>	doSuggestOption(String optionName) Provide a list of possible option values for auto completion
abstract void	execute() Execute command
Session	getSession()
boolean	isHelp()
void	setHelp(boolean help)
void	setSession(Session session)
List<String>	suggestArgument(String partialArg)
List<String>	suggestOption(String name, String partialValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command()

Method Detail

doSuggestArgument

protected List<String> doSuggestArgument()
                                  throws IOException,
                                         JMException

Provide a list of possible arguments for auto completion. This method returns list of arguments(not option) and is called when user presses tab key.

Returns:

List of possible arguments used by auto completion or NULL

Throws:

IOException - IO errors

JMException - JMX problemo

doSuggestOption

protected List<String> doSuggestOption(String optionName)
                                throws IOException,
                                       JMException

Provide a list of possible option values for auto completion

Parameters:

optionName - Name of option

Returns:

List of possible arguments used by auto completion or NULL

Throws:

IOException - Network communication errors

JMException - JMX errors

execute

public abstract void execute()
                      throws IOException,
                             JMException

Execute command

Throws:

IOException - IO errors

JMException - JMX errors

getSession

public final Session getSession()

Returns:

Session where command runs

isHelp

public final boolean isHelp()

Returns:

True if help option is on

setHelp

@Option(name="h",
        longName="help",
        description="Display usage")
public final void setHelp(boolean help)

Parameters:

help - True to display usage

setSession

public final void setSession(Session session)

Parameters:

session - Session where command runs

suggestArgument

public final List<String> suggestArgument(String partialArg)

Specified by:

suggestArgument in interface org.cyclopsgroup.jcli.AutoCompletable

suggestOption

public final List<String> suggestOption(String name,
                                        String partialValue)

Specified by:

suggestOption in interface org.cyclopsgroup.jcli.AutoCompletable