org.objectweb.cjdbc.console.text.module
Class ControllerConsole

java.lang.Object
  org.objectweb.cjdbc.console.text.module.AbstractConsoleModule
      org.objectweb.cjdbc.console.text.module.ControllerConsole

public class ControllerConsole

extends AbstractConsoleModule

This class defines a ControllerConsole

Version:

1.0

Author:

Nicolas Modrzyk

Nested Class Summary

Nested classes inherited from class org.objectweb.cjdbc.console.text.module.AbstractConsoleModule

AbstractConsoleModule.CommandDelimiter

Field Summary

Fields inherited from class org.objectweb.cjdbc.console.text.module.AbstractConsoleModule

commands, console, consoleCompletor, history, quit

Constructor Summary

ControllerConsole(Console console)
Creates a new ControllerConsole.java object

Method Summary

java.lang.String	getDescriptionString() Text description of this module
java.lang.String	getPromptString() Get the prompt string for this module
protected void	loadCommands() Loads the commands for this module
void	login(java.lang.String[] params) Handles login in this module
void	quit() Quit this module

Methods inherited from class org.objectweb.cjdbc.console.text.module.AbstractConsoleModule

findConsoleCommand, getCommands, getCompletor, getConsole, getHashCommands, getHistory, handleCommandLine, handlePrompt, help, loadCompletor, loadHistory, manageHistory, reloadCompletor, storeHistory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ControllerConsole

public ControllerConsole(Console console)

Creates a new ControllerConsole.java object

Parameters:

console - the controller console is attached to

Method Detail

loadCommands

protected void loadCommands()

Description copied from class: AbstractConsoleModule

Loads the commands for this module

Specified by:

loadCommands in class AbstractConsoleModule

See Also:

AbstractConsoleModule.loadCommands()

quit

public void quit()

Description copied from class: AbstractConsoleModule

Quit this module

Overrides:

quit in class AbstractConsoleModule

See Also:

AbstractConsoleModule.quit()

getPromptString

public java.lang.String getPromptString()

Description copied from class: AbstractConsoleModule

Get the prompt string for this module

Specified by:

getPromptString in class AbstractConsoleModule

Returns:

String to place before prompt

See Also:

AbstractConsoleModule.getPromptString()

login

public void login(java.lang.String[] params)

Description copied from class: AbstractConsoleModule

Handles login in this module

Specified by:

login in class AbstractConsoleModule

Parameters:

params - parameters to use to login in this module

See Also:

AbstractConsoleModule.login(String[])

getDescriptionString

public java.lang.String getDescriptionString()

Description copied from class: AbstractConsoleModule

Text description of this module

Specified by:

getDescriptionString in class AbstractConsoleModule

Returns:

String description to display

See Also:

AbstractConsoleModule.getDescriptionString()