|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ShellCommandHandler
Method Summary | |
---|---|
java.lang.String |
getSyntax()
Get a description of the syntax for how a command should be invoked. |
java.lang.String |
getUsageHelp(java.lang.String[] args)
Get some info on how to invoke this command. |
java.lang.String |
getUsageShort()
Get a very brief (40 character) description of the command |
void |
init(java.lang.String commandName,
ShellBase shell)
Initialize this command handler. |
void |
processCommand(java.lang.String[] args)
Handle a command. |
Method Detail |
---|
void init(java.lang.String commandName, ShellBase shell) throws ShellCommandInitException
commandName
- The name of the command.shell
- The shell. This is useful for command
that need to be able to interpret other commands, like the "help"
command, and for commands that need to get additional user input,
for example a login command that presents a password prompt.
ShellCommandInitException
void processCommand(java.lang.String[] args) throws ShellCommandUsageException, ShellCommandExecException
args
- The args to the command.
ShellCommandUsageException
- If the args are malformed.
ShellCommandExecException
- If an error occurred
executing the command.java.lang.String getUsageHelp(java.lang.String[] args)
java.lang.String getUsageShort()
java.lang.String getSyntax()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |