|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthenplus.AbstractCommand
henplus.plugins.tablediff.TableDiffCommand
public final class TableDiffCommand
Field Summary | |
---|---|
protected static String |
_command
|
protected static String |
COMMAND_DELIMITER
|
protected static String |
OPTION_SINGLE_DB
|
Fields inherited from interface henplus.Command |
---|
EXEC_FAILED, SUCCESS, SYNTAX_ERROR |
Constructor Summary | |
---|---|
TableDiffCommand()
|
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 command,
String parameters)
execute the command given. |
String[] |
getCommandList()
returns the prefices of all command-strings this command can handle. |
String |
getLongDescription(String cmd)
returns a longer string describing this action. |
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. |
boolean |
isComplete(String command)
returns, whether the command is complete. |
boolean |
participateInCommandCompletion()
returns 'false', if the commands supported by this Commands should not be part of the toplevel command completion. |
boolean |
requiresValidSession(String cmd)
returns true, if this command requires a valid SQLSession, i.e. |
void |
shutdown()
shutdown this command. |
Methods inherited from class henplus.AbstractCommand |
---|
argumentCount, getOption, getOptions, handleCommandline, registerOptions, setOptions |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String _command
protected static final String COMMAND_DELIMITER
protected static final String OPTION_SINGLE_DB
Constructor Detail |
---|
public TableDiffCommand()
Method Detail |
---|
public String[] getCommandList()
Command
public boolean participateInCommandCompletion()
Command
participateInCommandCompletion
in interface Command
participateInCommandCompletion
in class AbstractCommand
public int execute(SQLSession session, String command, String parameters)
Command
Command.isComplete(String)
method, if this command is complete.
session
- the SQLsession this command is executed from.command
- the command as string.parameters
- the rest parameters following the command.
public Iterator complete(CommandDispatcher disp, String partialCommand, String lastWord)
Command
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 boolean isComplete(String command)
Command
This method is called, whenever the input encounters a newline or a semicolon to decide if this separator is to separate different commands or if it is part of the command itself.
The delimiter (newline or semicolon) is contained (at the end)
in the String passed to this method. This
method returns false
, if the delimiter is part of the
command and will not be regarded as delimiter between commands -- the
reading part of the command dispatcher will go on reading characters
and not execute the command.
This method will return true for most simple commands like 'help'. For commands that have a more complicated syntax, this might not be true.
isComplete
in interface Command
isComplete
in class AbstractCommand
command
- the partial command read so far given to decide by
the command whether it is complete or not.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 void shutdown()
Command
shutdown
in interface Command
shutdown
in class AbstractCommand
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)
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 |