com.redhat.thermostat.test.cli

Class TestCommand

java.lang.Object

com.redhat.thermostat.test.cli.TestCommand

All Implemented Interfaces:

Command

public class TestCommand
extends Object
implements Command

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestCommand.Handle

Field Summary

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

NAME

Constructor Summary

Constructors

Constructor and Description
TestCommand(String name)
TestCommand(String name, TestCommand.Handle r)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOptions(org.apache.commons.cli.Option... options)
String	getDescription() A short description for the command indicating what it does.
String	getName() Returns a name for this command.
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()
void	run(CommandContext ctx) Execute the command
void	setDescription(String desc)
void	setStorageRequired(boolean storageRequired)
void	setUsage(String usage)

Methods inherited from class java.lang.Object

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

Constructor Detail

TestCommand

public TestCommand(String name)

TestCommand

public TestCommand(String name,
           TestCommand.Handle r)

Method Detail

run

public void run(CommandContext ctx)
         throws CommandException

Description copied from interface: Command

Execute the command

Specified by:

run in interface Command

Throws:

CommandException

getName

public String getName()

Description copied from interface: Command

Returns a name for this command. This will be used by the user to select this command.

Specified by:

getName in interface Command

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

setDescription

public void setDescription(String desc)

getUsage

public String getUsage()

Description copied from interface: Command

How the user should invoke this command

Specified by:

getUsage in interface Command

setUsage

public void setUsage(String usage)

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

addOptions

public void addOptions(org.apache.commons.cli.Option... options)

isStorageRequired

public boolean isStorageRequired()

Specified by:

isStorageRequired in interface Command

setStorageRequired

public void setStorageRequired(boolean storageRequired)

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