henplus.commands.properties
Class AbstractPropertyCommand

java.lang.Object
  extended by henplus.AbstractCommand
      extended by henplus.commands.properties.AbstractPropertyCommand
All Implemented Interfaces:
Command
Direct Known Subclasses:
PropertyCommand, SessionPropertyCommand

public abstract class AbstractPropertyCommand
extends AbstractCommand

The command, that allows to set properties. This abstract command is used for the session specific and global properties.


Field Summary
 
Fields inherited from interface henplus.Command
EXEC_FAILED, SUCCESS, SYNTAX_ERROR
 
Constructor Summary
AbstractPropertyCommand()
           
 
Method Summary
 Iterator complete(CommandDispatcher disp, String partialCommand, String lastWord)
          complete property names.
 int execute(SQLSession currentSession, String cmd, String param)
          execute the command given.
 String[] getCommandList()
          returns the command-strings this command can handle.
protected abstract  String getHelpHeader()
           
 String getLongDescription(String cmd)
          returns a longer string describing this action.
protected abstract  PropertyRegistry getRegistry()
          the PropertyRegistry associcaed with the current
protected abstract  String getSetCommand()
          returns the name of the command this command reacts on.
 String getShortDescription()
          return a descriptive string.
 String getSynopsis(String cmd)
          retuns a synopsis-string.
 
Methods inherited from class henplus.AbstractCommand
argumentCount, getOption, getOptions, handleCommandline, isComplete, participateInCommandCompletion, registerOptions, requiresValidSession, setOptions, shutdown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractPropertyCommand

public AbstractPropertyCommand()
Method Detail

getCommandList

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


getSetCommand

protected abstract String getSetCommand()
returns the name of the command this command reacts on.


getRegistry

protected abstract PropertyRegistry getRegistry()
the PropertyRegistry associcaed with the current


execute

public int execute(SQLSession currentSession,
                   String cmd,
                   String param)
execute the command given.

Parameters:
currentSession - 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.

complete

public Iterator complete(CommandDispatcher disp,
                         String partialCommand,
                         String lastWord)
complete property names.

Specified by:
complete in interface Command
Overrides:
complete in class AbstractCommand
Parameters:
disp - the CommandDispatcher - you might want to access other values through it.
partialCommand - The command typed so far
lastWord - the last word returned by readline.

getHelpHeader

protected abstract String getHelpHeader()

getShortDescription

public String getShortDescription()
return a descriptive string.

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

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().

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().


? 1997..2006 Henner Zeller