|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthenplus.AbstractCommand
henplus.commands.HelpCommand
public class HelpCommand
document me.
Field Summary |
---|
Fields inherited from interface henplus.Command |
---|
EXEC_FAILED, SUCCESS, SYNTAX_ERROR |
Constructor Summary | |
---|---|
HelpCommand()
|
Method Summary | |
---|---|
Iterator |
complete(CommandDispatcher disp,
String partialCommand,
String lastWord)
Returns a list of strings that are possible at this stage. |
int |
execute(SQLSession session,
String cmdstr,
String param)
execute the command given. |
String[] |
getCommandList()
returns the command-string 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. |
boolean |
requiresValidSession(String cmd)
returns true, if this command requires a valid SQLSession, i.e. |
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 HelpCommand()
Method Detail |
---|
public String[] getCommandList()
public boolean requiresValidSession(String cmd)
Command
Command.execute(SQLSession,String,String)
method makes use of the
session (e.g. to get some Database connection) or not. Return 'true'
if unsure (you should be sure..). This is to thwart attempts to
execute a command without session.
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 session, String cmdstr, String param)
session
- the SQLsession this command is executed from.cmdstr
- 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 |