com.redhat.thermostat.common.cli

Class CommandWithInfo

java.lang.Object

com.redhat.thermostat.common.cli.CommandWithInfo

All Implemented Interfaces:

Command

Direct Known Subclasses:

BasicCommand, SimpleCommand

public abstract class CommandWithInfo
extends Object
implements Command

Field Summary

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

NAME

Constructor Summary

Constructors

Constructor and Description
CommandWithInfo()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() A short description for the command indicating what it does.
org.apache.commons.cli.Options	getOptions() Returns the Options that the command is prepared to handle.
String	getUsage() How the user should invoke this command
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 (from the main command line).
boolean	isStorageRequired()

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

getName, run

Constructor Detail

CommandWithInfo

public CommandWithInfo()

Method Detail

getDescription

public String getDescription()

Description copied from interface: Command

A short description for the command indicating what it does.

Specified by:

getDescription in interface Command

getUsage

public String getUsage()

Description copied from interface: Command

How the user should invoke this command

Specified by:

getUsage in interface Command

getOptions

public org.apache.commons.cli.Options getOptions()

Description copied from interface: Command

Returns the Options that the command is prepared to handle. If the user provides unknown or malformed arguments, this command will not be invoked.

Specified by:

getOptions in interface Command

isStorageRequired

public boolean isStorageRequired()

Specified by:

isStorageRequired in interface Command

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 (from the main command line).

Specified by:

isAvailableOutsideShell in interface Command

Returns:

true if can command can be invoked from the command line