KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > continuent > sequoia > console > text > commands > Help


1 /**
2  * Sequoia: Database clustering technology.
3  * Copyright (C) 2002-2004 French National Institute For Research In Computer
4  * Science And Control (INRIA).
5  * Contact: sequoia@continuent.org
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  * Initial developer(s): Nicolas Modrzyk
20  * Contributor(s): ______________________.
21  */
22
23 package org.continuent.sequoia.console.text.commands;
24
25 import java.io.IOException JavaDoc;
26
27 import org.continuent.sequoia.common.i18n.ConsoleTranslate;
28 import org.continuent.sequoia.console.text.ConsoleException;
29 import org.continuent.sequoia.console.text.module.AbstractConsoleModule;
30
31 /**
32  * This class defines a Help
33  *
34  * @author <a HREF="mailto:Nicolas.Modrzyk@inria.fr">Nicolas Modrzyk</a>
35  * @version 1.0
36  */
37 public class Help extends ConsoleCommand
38 {
39
40   /**
41    * Creates a new <code>Help.java</code> object
42    *
43    * @param module the command is attached to
44    */
45   public Help(AbstractConsoleModule module)
46   {
47     super(module);
48   }
49   /**
50    * @see org.continuent.sequoia.console.text.commands.ConsoleCommand#parse(java.lang.String)
51    */
52   public void parse(String JavaDoc commandText) throws IOException JavaDoc, ConsoleException
53   {
54     module.help();
55   }
56
57   /**
58    * @see org.continuent.sequoia.console.text.commands.ConsoleCommand#getCommandName()
59    */
60   public String JavaDoc getCommandName()
61   {
62     return "help"; //$NON-NLS-1$
63 }
64
65   /**
66    * @see org.continuent.sequoia.console.text.commands.ConsoleCommand#getCommandDescription()
67    */
68   public String JavaDoc getCommandDescription()
69   {
70     return ConsoleTranslate.get("console.command.help"); //$NON-NLS-1$
71 }
72   
73   /**
74    * @see org.continuent.sequoia.console.text.commands.ConsoleCommand#execute(java.lang.String)
75    */
76   public void execute(String JavaDoc commandText) throws Exception JavaDoc
77   {
78     this.parse(commandText);
79   }
80
81 }
82
Popular Tags