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/ConfigurationFileCorruptException.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 * This exception is raised when the configuration file has an invalid
38 * structure.
39 * <p>
40 * <b>Control Version</b>
41 * <p>
42 * <ul>
43 * <li>0.0.1 Class creation.</li>
44 * <li>0.0.2 Recommendations from PMD.</li>
45 * <li>0.1.0 getMessage.</li>
46 * <li>1.0.0 Moved to version 1.</li>
47 * <li>1.1.0 Parent changed.</li>
48 * <li>1.1.1 Error code.</li>
49 * <li>1.1.2 Logger and final.</li>
50 * <li>1.2.0 Method deleted.</li>
51 * <li>1.2.1 New id.</li>
52 * <li>1.3.0 getFilename.</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.3.0 2009-11-07
58 */
59 public final class ConfigurationFileCorruptException extends
60 AbstractConfiguratorException {
61
62 /**
63 * Logger.
64 */
65 private static final Logger LOGGER = LoggerFactory
66 .getLogger(ConfigurationFileCorruptException.class);
67
68 /**
69 * ID of the exception.
70 */
71 private static final long serialVersionUID = -8444781575931696111L;
72
73 /**
74 * Name of the configuration file.
75 */
76 private final String corruptFileName;
77
78 /**
79 * Constructor that gives the name of the configuration file and a message
80 * describing why its structure is invalid.
81 *
82 * @param filename
83 * Name of the configuration file.
84 * @param exception
85 * Generated exception
86 */
87 public ConfigurationFileCorruptException(final String/* ! */filename,
88 final Exception/* ! */exception) {
89 super(exception);
90 assert exception != null;
91 assert filename != null;
92
93 this.corruptFileName = filename;
94 ConfigurationFileCorruptException.LOGGER
95 .debug(ConfigurationFileCorruptException.class.getName()
96 + " created."); //$NON-NLS-1$
97 }
98
99 /**
100 * Retrieves the name of the configuration file which is corrupt.
101 *
102 * @return The corruptFileName.s
103 */
104 public/* ! */String getFilename() {
105 return this.corruptFileName;
106 }
107
108 /*
109 * (non-Javadoc)
110 * @see java.lang.Throwable#getMessage()
111 */
112 @Override
113 public String/* ! */getMessage() {
114 return Messages.getString("ConfigurationFileCorruptException." //$NON-NLS-1$
115 + "CONF1-InvalidStructure") + this.corruptFileName //$NON-NLS-1$
116 + '(' + super.getCause().getClass().getName() + ')';
117 }
118 }