|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Command
The interface that any commands added to the slush shell must implement.
com.dalsemi.slush.CommandInterpreter#addCommand(String, SlushCommand)
Method Summary | |
---|---|
void |
execute(SystemInputStream in,
SystemPrintStream out,
SystemPrintStream err,
java.lang.String[] args,
java.util.Map<java.lang.String,java.lang.Object> env)
Executes this command. |
java.lang.String |
getCommandName()
Get the command name to be used to execute the command on the command line. |
java.lang.String |
getUsageString()
Returns a string describing the usage of the command and its arguments if any. |
Method Detail |
---|
java.lang.String getUsageString()
java.lang.String getCommandName()
void execute(SystemInputStream in, SystemPrintStream out, SystemPrintStream err, java.lang.String[] args, java.util.Map<java.lang.String,java.lang.Object> env) throws java.lang.Exception
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.
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |