View Javadoc

1   /*
2    PlantUMLDependencyException.java
3    Creation date : 11/07/2010
4    Copyright © Benjamin Croizet (graffity2199@yahoo.fr)
5   
6    This program is free software; you can redistribute it and/or
7    modify it under the terms of the GNU General Public License
8    or GNU Lesser General Public License as published by the
9    Free Software Foundation; either version 3 of the License,
10   or (at your option) any later version.
11  
12   This program 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 General Public License for more details.
16  
17   You should have received copies of the GNU General Public License
18   and GNU Lesser General Public License along with this program;
19   if not, write to the Free Software Foundation, Inc.,
20   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21   http://www.fsf.org/licensing/licenses/gpl.html
22   http://www.gnu.org/licenses/lgpl.html
23   */
24  
25  package net.sourceforge.plantumldependency.cli.exception;
26  
27  /**
28   * The exception which is thrown when an error occurs while executing the plantUML dependency
29   * program.
30   *
31   * @author Benjamin Croizet (<a href="mailto:graffity2199@yahoo.fr>graffity2199@yahoo.fr</a>)
32   * @since 1.0.0
33   * @version 1.3.0
34   */
35  public class PlantUMLDependencyException extends Exception {
36  
37      /** Serial version UID. */
38      private static final long serialVersionUID = -679527490164460773L;
39  
40      /**
41       * Constructs a new exception with the specified detail message. The cause is not initialized,
42       * and may subsequently be initialized by a call to {@link #initCause}.
43       *
44       * @param messageKey
45       *            the detail message key, ready to be translated. The detail message key is saved
46       *            for later retrieval by the {@link #getMessage()} method.
47       * @since 1.0.0
48       */
49      public PlantUMLDependencyException(final String messageKey) {
50          super(messageKey);
51      }
52  
53      /**
54       * Constructs a new exception with the specified detail message and cause.
55       * <p>
56       * Note that the detail message associated with <code>cause</code> is <i>not</i> automatically
57       * incorporated in this exception's detail message.
58       *
59       * @param messageKey
60       *            the detail message key, ready to be translated. The detail message key is saved
61       *            for later retrieval by the {@link #getMessage()} method.
62       * @param cause
63       *            the cause (which is saved for later retrieval by the {@link #getCause()} method).
64       *            (A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent
65       *            or unknown.)
66       * @since 1.0.0
67       */
68      public PlantUMLDependencyException(final String messageKey, final Throwable cause) {
69          super(messageKey, cause);
70      }
71  }