henplus.commands
Class ShellCommand

java.lang.Object
  extended by henplus.AbstractCommand
      extended by henplus.commands.ShellCommand
All Implemented Interfaces:
Command, Interruptable

public class ShellCommand
extends AbstractCommand
implements Interruptable

This command executes stuff on the shell. Supports the most common shell commands for convenience.


Field Summary
 
Fields inherited from interface henplus.Command
EXEC_FAILED, SUCCESS, SYNTAX_ERROR
 
Constructor Summary
ShellCommand()
           
 
Method Summary
 Iterator complete(CommandDispatcher disp, String partialCommand, String lastWord)
          filename completion by default.
 int execute(SQLSession session, String cmd, String param)
          execute the command given.
 String[] getCommandList()
          returns the command-strings this command can handle.
 String getLongDescription(String cmd)
          provide a long description just in case the user types 'help ls'.
 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.
 void interrupt()
           
 boolean requiresValidSession(String cmd)
          shell commands always have the semicolon as special character.
 
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

ShellCommand

public ShellCommand()
Method Detail

getCommandList

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

Specified by:
getCommandList in interface Command

requiresValidSession

public boolean requiresValidSession(String cmd)
shell commands always have the semicolon as special character.

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

complete

public Iterator complete(CommandDispatcher disp,
                         String partialCommand,
                         String lastWord)
filename completion by default.

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.

interrupt

public void interrupt()
Specified by:
interrupt in interface Interruptable

execute

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

Specified by:
execute in interface Command
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.

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

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)
provide a long description just in case the user types 'help ls'.

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