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/tools/src/main/java/name/angoca/zemucan/tools/configurator/ConfigurationFileNotFoundException.java $:
28   */
29  package name.angoca.zemucan.tools.configurator;
30  
31  import name.angoca.zemucan.tools.messages.Messages;
32  
33  import org.slf4j.Logger;
34  import org.slf4j.LoggerFactory;
35  
36  /**
37   * The configuration file was not found.
38   * <p>
39   * <b>Control Version</b>
40   * <p>
41   * <ul>
42   * <li>0.0.1 Class creation.</li>
43   * <li>0.1.0 Recommendations from PMD.</li>
44   * <li>0.2.0 getMessage.</li>
45   * <li>1.0.0 Moved to version 1.</li>
46   * <li>1.1.0 Parent changed.</li>
47   * <li>1.1.1 Error code.</li>
48   * <li>1.1.2 Logger and final.</li>
49   * <li>1.1.2 Assert.</li>
50   * <li>1.1.3 New id.</li>
51   * <li>1.2.0 getFilename.</li>
52   * <li>1.3.0 No wrapped exception.</li>
53   * </ul>
54   *
55   * @author Andres Gomez Casanova <a
56   *         href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
57   * @version 1.2.0 2010-05-27
58   */
59  public final class ConfigurationFileNotFoundException extends
60          AbstractConfiguratorException {
61  
62      /**
63       * Logger.
64       */
65      private static final Logger LOGGER = LoggerFactory
66              .getLogger(ConfigurationFileNotFoundException.class);
67  
68      /**
69       * ID of the exception.
70       */
71      private static final long serialVersionUID = 4154592559188299629L;
72  
73      /**
74       * Name of the configuration file that was not found.
75       */
76      private final String notFoundFilename;
77  
78      /**
79       * Creates the exception with the not found name.
80       *
81       * @param filename
82       *            Name of the configuration file that was not found.
83       */
84      public ConfigurationFileNotFoundException(final String/* ! */filename) {
85          super();
86          assert filename != null;
87  
88          this.notFoundFilename = filename;
89          ConfigurationFileNotFoundException.LOGGER
90                  .debug(ConfigurationFileNotFoundException.class.getName()
91                          + " created."); //$NON-NLS-1$
92      }
93  
94      /**
95       * Retrieves the name of the file that was not found.
96       *
97       * @return name of the configuration file.
98       */
99      public/* ! */String getFilename() {
100         return this.notFoundFilename;
101     }
102 
103     /**
104      * Returns the name of the configuration file that was not found.
105      *
106      * @return Message indicating the error.
107      */
108     @Override
109     public String/* ! */getMessage() {
110         return Messages.getString("ConfigurationFileNotFoundException" //$NON-NLS-1$
111                 + ".CONF2-Message") + this.notFoundFilename; //$NON-NLS-1$
112     }
113 }