org.objectweb.cjdbc.console.text.commands
Class Help

java.lang.Object
  org.objectweb.cjdbc.console.text.commands.ConsoleCommand
      org.objectweb.cjdbc.console.text.commands.Help

All Implemented Interfaces:

java.lang.Comparable

public class Help

extends ConsoleCommand

This class defines a Help

Version:

1.0

Author:

Nicolas Modrzyk

Field Summary

Fields inherited from class org.objectweb.cjdbc.console.text.commands.ConsoleCommand

console, jmxClient, module

Constructor Summary

Help(AbstractConsoleModule module)
Creates a new Help.java object

Method Summary

void	execute(java.lang.String commandText) Check if the JMX connection is still valid.
java.lang.String	getCommandDescription() Get the description of the command
java.lang.String	getCommandName() Get the name of the command
void	parse(java.lang.String commandText) Parse the text of the command

Methods inherited from class org.objectweb.cjdbc.console.text.commands.ConsoleCommand

compareTo, getCommandParameters, getUsage

Methods inherited from class java.lang.Object

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

Constructor Detail

Help

public Help(AbstractConsoleModule module)

Creates a new Help.java object

Parameters:

module - the command is attached to

Method Detail

parse

public void parse(java.lang.String commandText)
           throws java.io.IOException,
                  ConsoleException

Description copied from class: ConsoleCommand

Parse the text of the command

Specified by:

parse in class ConsoleCommand

Parameters:

commandText - the command text

Throws:

java.io.IOException

ConsoleException

See Also:

ConsoleCommand.parse(java.lang.String)

getCommandName

public java.lang.String getCommandName()

Description copied from class: ConsoleCommand

Get the name of the command

Specified by:

getCommandName in class ConsoleCommand

Returns:

String of the command name

See Also:

ConsoleCommand.getCommandName()

getCommandDescription

public java.lang.String getCommandDescription()

Description copied from class: ConsoleCommand

Get the description of the command

Specified by:

getCommandDescription in class ConsoleCommand

Returns:

String of the command description

See Also:

ConsoleCommand.getCommandDescription()

execute

public void execute(java.lang.String commandText)
             throws java.lang.Exception

Description copied from class: ConsoleCommand

Check if the JMX connection is still valid. Otherwise reconnect.

Overrides:

execute in class ConsoleCommand

Parameters:

commandText - the parameters to execute the command with

Throws:

java.lang.Exception - if fails

See Also:

ConsoleCommand.execute(java.lang.String)