|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthenplus.AbstractCommand
henplus.commands.ConnectCommand
public class ConnectCommand
document me.
Field Summary |
---|
Fields inherited from interface henplus.Command |
---|
EXEC_FAILED, SUCCESS, SYNTAX_ERROR |
Constructor Summary | |
---|---|
ConnectCommand(HenPlus henplus,
SessionManager sessionManager)
|
Method Summary | |
---|---|
Iterator |
complete(CommandDispatcher disp,
String partialCommand,
String lastWord)
complete session names. |
int |
execute(SQLSession currentSession,
String cmd,
String param)
execute the command given. |
String[] |
getCommandList()
returns the command-strings this command can handle. |
String |
getLongDescription(String cmd)
returns a longer string describing this action. |
String |
getShortDescription()
return a descriptive string. |
String |
getSynopsis(String cmd)
retuns a synopsis-string. |
void |
handleCommandline(CommandLine line)
After parsing the parameters, this method is called. |
void |
registerOptions(Options r)
Override this method if you want to register command-specific options |
boolean |
requiresValidSession(String cmd)
we can connect, even if we don't have a running connection. |
void |
shutdown()
shutdown this command. |
Methods inherited from class henplus.AbstractCommand |
---|
argumentCount, getOption, getOptions, isComplete, participateInCommandCompletion, setOptions |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConnectCommand(HenPlus henplus, SessionManager sessionManager)
Method Detail |
---|
public String[] getCommandList()
public void handleCommandline(CommandLine line)
Command
handleCommandline
in interface Command
handleCommandline
in class AbstractCommand
line
- TODOpublic void registerOptions(Options r)
AbstractCommand
registerOptions
in interface Command
registerOptions
in class AbstractCommand
public void shutdown()
Command
shutdown
in interface Command
shutdown
in class AbstractCommand
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 int execute(SQLSession currentSession, String cmd, String param)
currentSession
- the SQLsession this command is executed from.cmd
- the command as string.param
- the rest parameters following the command.
public String getShortDescription()
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)
Command
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 |