1 /*
2 * Zemucan: A Syntax Assistant for DB2
3 * Copyright (C) 2009, 2010 Andres Gomez Casanova
4 *
5 * This file is part of Zemucan.
6 *
7 * Zemucan is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * Zemucan is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Lesser General Public License 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, see <http://www.gnu.org/licenses/>.
19 *
20 * Contact:
21 * a n g o c a at y a h o o dot c o m
22 * Cra. 45 No 61 - 31, Bogota, Colombia.
23 *
24 * Author: $LastChangedBy: angoca $:
25 * Date: $LastChangedDate: 2011-03-06 09:19:05 -0500 (dom, 06 mar 2011) $:
26 * Revision: $LastChangedRevision: 1910 $:
27 * URL: $HeadURL: https://zemucan.svn.sourceforge.net/svnroot/zemucan/branches/zemucan_v1/source-code/graph/src/main/java/name/angoca/zemucan/core/graph/model/HelpNode.java $:
28 */
29 package name.angoca.zemucan.core.graph.model;
30
31 import name.angoca.zemucan.core.graph.api.InvalidGraphNodeException;
32 import name.angoca.zemucan.tools.Constants;
33 import name.angoca.zemucan.tools.messages.Messages;
34
35 /**
36 * This token shows a little help with the simple commands.
37 * <p>
38 * This object is immutable, once it is created, their properties cannot be
39 * changed. This is the reason because there are not setter methods.
40 * <p>
41 * TODO v2.0 Cuando se usen alias, poner como alias 'help' y palabra primaria
42 * '?'
43 * <p>
44 * <b>Control Version</b>
45 * <p>
46 * <ul>
47 * <li>0.0.1 Class creation.</li>
48 * <li>1.0.0 Moved to version 1.</li>
49 * <li>1.1.0 Exception hierarchy changed.</li>
50 * <li>1.2.0 final.</li>
51 * <li>1.2.1 GraphToken renamed by GraphNode.</li>
52 * <li>1.2.2 Extra tokens problem.</li>
53 * <li>1.3.0 GraphNode hierarchy.</li>
54 * </ul>
55 *
56 * @author Andres Gomez Casanova <a
57 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
58 * @version 1.3.0 2010-08-29
59 */
60 public final class HelpNode extends NonReservedGraphNode {
61
62 /**
63 * License description.
64 */
65 private static final String HELP = Messages.getString("HelpNode.help"); //$NON-NLS-1$
66
67 /**
68 * Default constructor.
69 *
70 * @param graph
71 * Associated graph.
72 * @throws InvalidGraphNodeException
73 * The name is invalid
74 */
75 public HelpNode(final Graph/* ! */graph) throws InvalidGraphNodeException {
76 super(Constants.HELP_CONTENT_TOKEN_ID, HelpNode.HELP, graph);
77 }
78
79 }