henplus
Class SamplePlugin

java.lang.Object
  extended by henplus.AbstractCommand
      extended by henplus.SamplePlugin
All Implemented Interfaces:
Command

public class SamplePlugin
extends AbstractCommand

This is a Sample plugin. Its simple: just implement the Command interface and a public default constructor. Thats it.


Field Summary
 
Fields inherited from interface henplus.Command
EXEC_FAILED, SUCCESS, SYNTAX_ERROR
 
Constructor Summary
SamplePlugin()
           
 
Method Summary
 int execute(SQLSession session, String cmd, String param)
          execute the command given.
 String[] getCommandList()
          returns the command-strings this plug-in 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 requiresValidSession(String cmd)
          returns true, if this command requires a valid SQLSession, i.e.
 
Methods inherited from class henplus.AbstractCommand
argumentCount, complete, 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

SamplePlugin

public SamplePlugin()
Method Detail

getCommandList

public String[] getCommandList()
returns the command-strings this plug-in can handle


execute

public int execute(SQLSession session,
                   String cmd,
                   String param)
Description copied from interface: Command
execute the command given. The command is given completely without the final delimiter (which would be newline or semicolon). Before this method is called, the CommandDispatcher checks with the Command.isComplete(String) method, if this command is complete.

Parameters:
session - the SQLsession this command is executed from.
cmd - the command as string.
param - the rest parameters following the command.
Returns:
one of SUCCESS, SYNTAX_ERROR, EXEC_FAILED to indicate the exit status of this command. On SYNTAX_ERROR, the CommandDispatcher displays a synopsis if available.

requiresValidSession

public boolean requiresValidSession(String cmd)
Description copied from interface: Command
returns true, if this command requires a valid SQLSession, i.e. if the 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.

Specified by:
requiresValidSession in interface Command
Overrides:
requiresValidSession in class AbstractCommand
Parameters:
cmd - the subcommand this is requested for; one of the commands returned by Command.getCommandList().

getShortDescription

public String getShortDescription()
Description copied from interface: Command
return a short string describing the purpose of the commands handled by this Command-implementation. This is the string listed in the bare 'help' overview (like 'describe a database object') Should contain no newline, no leading spaces.

Specified by:
getShortDescription in interface Command
Overrides:
getShortDescription in class AbstractCommand

getLongDescription

public String getLongDescription(String cmd)
Description copied from interface: Command
returns a longer string describing this action. This should return a String describing details of the given command. This String should start with a TAB-character in each new line (the first line is a new line). The last line should not end with newline.

Specified by:
getLongDescription in interface Command
Overrides:
getLongDescription in class AbstractCommand
Parameters:
cmd - The command the long description is asked for. This is one of the possible commands returned by Command.getCommandList().

getSynopsis

public String getSynopsis(String cmd)
Description copied from interface: Command
retuns a synopsis-string. The synopsis string returned should follow the following conventions:

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.

Specified by:
getSynopsis in interface Command
Overrides:
getSynopsis in class AbstractCommand
Parameters:
cmd - the command the synopsis is for. This is one of the possible commands returned by Command.getCommandList().


? 1997..2006 Henner Zeller