KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > cjdbc > console > text > commands > Help


1 /**
2  * C-JDBC: Clustered JDBC.
3  * Copyright (C) 2002-2004 French National Institute For Research In Computer
4  * Science And Control (INRIA).
5  * Contact: c-jdbc@objectweb.org
6  *
7  * This library is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as published by the
9  * Free Software Foundation; either version 2.1 of the License, or any later
10  * version.
11  *
12  * This library is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public License
18  * along with this library; if not, write to the Free Software Foundation,
19  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
20  *
21  * Initial developer(s): Nicolas Modrzyk
22  * Contributor(s): ______________________.
23  */
24
25 package org.objectweb.cjdbc.console.text.commands;
26
27 import java.io.IOException JavaDoc;
28
29 import org.objectweb.cjdbc.common.i18n.ConsoleTranslate;
30 import org.objectweb.cjdbc.console.text.ConsoleException;
31 import org.objectweb.cjdbc.console.text.module.AbstractConsoleModule;
32
33 /**
34  * This class defines a Help
35  *
36  * @author <a HREF="mailto:Nicolas.Modrzyk@inria.fr">Nicolas Modrzyk</a>
37  * @version 1.0
38  */
39 public class Help extends ConsoleCommand
40 {
41
42   /**
43    * Creates a new <code>Help.java</code> object
44    *
45    * @param module the command is attached to
46    */
47   public Help(AbstractConsoleModule module)
48   {
49     super(module);
50   }
51   /**
52    * @see org.objectweb.cjdbc.console.text.commands.ConsoleCommand#parse(java.lang.String)
53    */
54   public void parse(String JavaDoc commandText) throws IOException JavaDoc, ConsoleException
55   {
56     module.help();
57   }
58
59   /**
60    * @see org.objectweb.cjdbc.console.text.commands.ConsoleCommand#getCommandName()
61    */
62   public String JavaDoc getCommandName()
63   {
64     return "help";
65   }
66
67   /**
68    * @see org.objectweb.cjdbc.console.text.commands.ConsoleCommand#getCommandDescription()
69    */
70   public String JavaDoc getCommandDescription()
71   {
72     return ConsoleTranslate.get("console.command.help");
73   }
74   
75   /**
76    * @see org.objectweb.cjdbc.console.text.commands.ConsoleCommand#execute(java.lang.String)
77    */
78   public void execute(String JavaDoc commandText) throws Exception JavaDoc
79   {
80     this.parse(commandText);
81   }
82
83 }
84
Popular Tags