|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthenplus.AbstractCommand
henplus.commands.ShellCommand
public class ShellCommand
This command executes stuff on the shell. Supports the most common shell commands for convenience.
Field Summary |
---|
Fields inherited from interface henplus.Command |
---|
EXEC_FAILED, SUCCESS, SYNTAX_ERROR |
Constructor Summary | |
---|---|
ShellCommand()
|
Method Summary | |
---|---|
Iterator |
complete(CommandDispatcher disp,
String partialCommand,
String lastWord)
filename completion by default. |
int |
execute(SQLSession session,
String cmd,
String param)
execute the command given. |
String[] |
getCommandList()
returns the command-strings this command can handle. |
String |
getLongDescription(String cmd)
provide a long description just in case the user types 'help ls'. |
String |
getShortDescription()
return a short string describing the purpose of the commands handled by this Command-implementation. |
String |
getSynopsis(String cmd)
retuns a synopsis-string. |
void |
interrupt()
|
boolean |
requiresValidSession(String cmd)
shell commands always have the semicolon as special character. |
Methods inherited from class henplus.AbstractCommand |
---|
argumentCount, getOption, getOptions, handleCommandline, isComplete, participateInCommandCompletion, registerOptions, setOptions, shutdown |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ShellCommand()
Method Detail |
---|
public String[] getCommandList()
getCommandList
in interface Command
public boolean requiresValidSession(String cmd)
requiresValidSession
in interface Command
requiresValidSession
in class AbstractCommand
cmd
- the subcommand this is requested for; one of the
commands returned by Command.getCommandList()
.public Iterator complete(CommandDispatcher disp, String partialCommand, String lastWord)
complete
in interface Command
complete
in class AbstractCommand
disp
- the CommandDispatcher - you might want to access
other values through it.partialCommand
- The command typed so farlastWord
- the last word returned by readline.public void interrupt()
interrupt
in interface Interruptable
public int execute(SQLSession session, String cmd, String param)
execute
in interface Command
session
- the SQLsession this command is executed from.cmd
- the command as string.param
- the rest parameters following the command.
public String getShortDescription()
Command
'describe a database object'
)
Should contain no newline, no leading spaces.
getShortDescription
in interface Command
getShortDescription
in class AbstractCommand
public String getSynopsis(String cmd)
Command
export-xml <table> <filename>
help [command]
Should contain no newline, no leading spaces. This synopsis is printed in the detailed help of a command or if the execute()-method returned a SYNTAX_ERROR.
getSynopsis
in interface Command
getSynopsis
in class AbstractCommand
cmd
- the command the synopsis is for. This is one of the possible
commands returned by Command.getCommandList()
.public String getLongDescription(String cmd)
getLongDescription
in interface Command
getLongDescription
in class AbstractCommand
cmd
- The command the long description is asked for. This
is one of the possible commands returned by
Command.getCommandList()
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |