jhomenet.shell.command
Interface SlushCommand

All Known Implementing Classes:

GetCurrentValueCommand, GetRegisteredHardwareCommand, GetUnregisteredHardwareCommand, HelpCommand, HistoryCommand, RegisterCommand, SetenvCommand, SetNorthOffsetCommand, SetPollingFreqCommand, ShutDownServersCommand, StartResponsiveEditorCommand, StartUpServersCommand, StoreCurrentValueCommand, StoreNorthOffsetCommand, SwitchCommand

public interface SlushCommand

The interface that any commands added to the slush shell must implement.

Version:

1.0

Author:

Lorne Smith, Stephen Hess

See Also:

com.dalsemi.slush.CommandInterpreter#addCommand(String, SlushCommand)

Method Summary

void	execute(SystemInputStream in, SystemPrintStream out, SystemPrintStream err, java.lang.String[] args, java.util.HashMap env) Executes this command.
java.lang.String	getUsageString() Returns a string describing the usage of the command and its arguments if any.

Method Detail

getUsageString

java.lang.String getUsageString()

Returns a string describing the usage of the command and its arguments if any.

Returns:

the usage.

execute

void execute(SystemInputStream in,
             SystemPrintStream out,
             SystemPrintStream err,
             java.lang.String[] args,
             java.util.HashMap env)
             throws java.lang.Exception

Executes this command.

Parameters:

in - The input stream this command will use to receive input.

out - The print stream this command should use to report any non-critical messages.

err - The print stream this command should use to report any critical messages.

args - The list of arguments given when this command was invoked. This does not include the command location itself.

env - A windDirectionTable of properties variables.

Throws:

java.lang.Exception - Any exception raised by the underlying command. The getMessage() method of this exception should be as descriptive as possible since the SLUSH shell will use it to report the exception back to the user.