com.redhat.thermostat.common.cli

Class AbstractCommand

java.lang.Object

com.redhat.thermostat.common.cli.AbstractCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AbstractStateNotifyingCommand, ConnectCommand, DisconnectCommand, DumpHeapCommand, FindObjectsCommand, FindRootCommand, GUIClientCommand, HelpCommand, ListHeapDumpsCommand, ListVMsCommand, ObjectInfoCommand, PingCommand, SaveHeapDumpToFileCommand, ServiceCommand, ShellCommand, ShowHeapHistogramCommand, VMInfoCommand, VMStatCommand

public abstract class AbstractCommand
extends Object
implements Command

A partial implementation of Command that most implementations should extend. By default, any extension of this class will require Storage, and be available both in and out of the Thermostat shell.

Concrete implementations must be registered as OSGi services with Command as the class. This may be done through a CommandRegistry.

Field Summary

Fields inherited from interface com.redhat.thermostat.common.cli.Command

NAME

Constructor Summary

Constructors

Constructor and Description
AbstractCommand()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAvailableInShell() Whether the command is available to be invoked from within the shell.
boolean	isAvailableOutsideShell() Indicates if the command is available to be invoked from outside the shell (as an argument to the main thermostat program).
boolean	isStorageRequired() Whether the command depends on Storage

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.redhat.thermostat.common.cli.Command

run

Constructor Detail

AbstractCommand

public AbstractCommand()

Method Detail

isStorageRequired

public boolean isStorageRequired()

Description copied from interface: Command

Whether the command depends on Storage

Specified by:

isStorageRequired in interface Command

Returns:

true if Storage is required.

isAvailableInShell

public boolean isAvailableInShell()

Description copied from interface: Command

Whether the command is available to be invoked from within the shell.

Specified by:

isAvailableInShell in interface Command

Returns:

true if the command can be invoked from within the shell

isAvailableOutsideShell

public boolean isAvailableOutsideShell()

Description copied from interface: Command

Indicates if the command is available to be invoked from outside the shell (as an argument to the main thermostat program).

Specified by:

isAvailableOutsideShell in interface Command

Returns:

true if can command can be invoked from the command line