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/ReferencingEndingNodeException.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 child of EndingNode is detected.
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 GrammarReader separated from Graph.</li>
45   * <li>1.2.0 getNodeName.</li>
46   * </ul>
47   *
48   * @author Andres Gomez Casanova <a
49   *         href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
50   * @version 1.2.0 2009-11-08
51   */
52  public class ReferencingEndingNodeException extends AbstractGraphException {
53  
54      /**
55       * Logger.
56       */
57      private static final Logger LOGGER = LoggerFactory
58              .getLogger(ReferencingEndingNodeException.class);
59  
60      /**
61       * ID of the exception.
62       */
63      private static final long serialVersionUID = -8254963909837315555L;
64  
65      /**
66       * Node that references the StartingNode.
67       */
68      private final String referencedNodename;
69  
70      /**
71       * Default constructor.
72       *
73       * @param nodename
74       *            Node's name that references the StartingNode.
75       */
76      public ReferencingEndingNodeException(final String /* ! */nodename) {
77          super();
78          assert nodename != null;
79  
80          this.referencedNodename = nodename;
81          ReferencingEndingNodeException.LOGGER
82                  .debug(ReferencingEndingNodeException.class.getName()
83                          + " created."); //$NON-NLS-1$
84      }
85  
86      /*
87       * (non-Javadoc)
88       * @see java.lang.Throwable#getMessage()
89       */
90      @Override
91      public final String getMessage() {
92          return Messages
93                  .getString("ReferencingEndingNodeException.GRPH11-EndingNodeWithChild") //$NON-NLS-1$
94                  + this.referencedNodename;
95      }
96  
97      /**
98       * Retrieves the name of the node that tries to be reference by EndingNode.
99       *
100      * @return node name
101      */
102     public final String/* ! */getReferencedNodename() {
103         return this.referencedNodename;
104     }
105 }