View Javadoc

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/NodeNotComesFromStartingNodeException.java $:
28   */
29  package name.angoca.zemucan.core.graph.model;
30  
31  import name.angoca.zemucan.tools.messages.Messages;
32  
33  import org.slf4j.Logger;
34  import org.slf4j.LoggerFactory;
35  
36  /**
37   * This exception is thrown when a node does not have StartingNode as ancestry.
38   * <p>
39   * <b>Control Version</b>
40   * <p>
41   * <ul>
42   * <li>1.0.0 Class creation.</li>
43   * <li>1.0.1 New id.</li>
44   * <li>1.1.0 No object, just string.</li>
45   * <li>1.1.1 GraphToken renamed by GraphNode</li>
46   * <li>1.2.0 GrammarReader separated from Graph.</li>
47   * <li>1.3.0 getNodeName.</li>
48   * </ul>
49   *
50   * @author Andres Gomez Casanova <a
51   *         href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
52   * @version 1.3.0 2009-11-08
53   */
54  public class NodeNotComesFromStartingNodeException extends
55          AbstractGraphException {
56  
57      /**
58       * Logger.
59       */
60      private static final Logger LOGGER = LoggerFactory
61              .getLogger(NodeNotComesFromStartingNodeException.class);
62  
63      /**
64       * ID of the exception.
65       */
66      private static final long serialVersionUID = -2717564911503964336L;
67  
68      /**
69       * Node name that does not come from StartingNode.
70       */
71      private final String nodename;
72  
73      /**
74       * constructor with an node that represents the problematic node.
75       *
76       * @param excepNodename
77       *            Node's name without StartingNode as ancestry.
78       */
79      public NodeNotComesFromStartingNodeException(
80              final String /* ! */excepNodename) {
81          super();
82          assert excepNodename != null;
83  
84          this.nodename = excepNodename;
85          NodeNotComesFromStartingNodeException.LOGGER
86                  .debug(NodeNotComesFromStartingNodeException.class.getName()
87                          + " created."); //$NON-NLS-1$
88      }
89  
90      /*
91       * (non-Javadoc)
92       * @see java.lang.Throwable#getMessage()
93       */
94      @Override
95      public final String getMessage() {
96          return Messages.getString("NodeNotComesFromStartingNodeException." //$NON-NLS-1$
97                  + "GRPH17-NoAscestryFromStartingNode") //$NON-NLS-1$
98                  + this.nodename;
99      }
100 
101     /**
102      * Retrieves the name of the node that does not come from StartingNode.
103      *
104      * @return node name.
105      */
106     public final String/* ! */getNodename() {
107         return this.nodename;
108     }
109 }