1 /*
2 * db2sa: DB2 Syntax Assistant
3 * Copyright (C) Andres Gomez Casanova
4 *
5 * This file is part of db2sa.
6 *
7 * db2sa 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 * db2sa 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: 2009-06-29 23:12:30 +0200 (Mon, 29 Jun 2009) $:
26 * Revision: $LastChangedRevision: 258 $:
27 * URL: $HeadURL: https://db2sa.svn.sourceforge.net/svnroot/db2sa/branches/db2sa_beta/source-code/src/main/java/name/angoca/db2sa/readers/exceptions/ConfigurationFileCorruptException.java $:
28 */
29 package name.angoca.db2sa.readers.exceptions;
30
31 /**
32 * This exception is raised when the configuration file has an invalid
33 * structure.<br/>
34 * <b>Control Version</b><br />
35 * <ul>
36 * <li>0.0.1 Class creation.</li>
37 * <li>0.0.2 Recommendations from PMD.</li>
38 * <li>0.1.0 getMessage.</li>
39 * <li>1.0.0 Moved to version 1.</li>
40 * </ul>
41 *
42 * @author Andres Gomez Casanova <a
43 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
44 * @version 1.0.0 2009-07-19
45 */
46 public class ConfigurationFileCorruptException extends AbstractReaderException {
47
48 /**
49 * ID of the exception.
50 */
51 private static final long serialVersionUID = -6687925109860190386L;
52 /**
53 * Name of the configuration file.
54 */
55 private final String m_filename;
56
57 /**
58 * Constructor that gives the name of the configuration file and a message
59 * describing why its structure is invalid.
60 *
61 * @param filename
62 * Name of the configuration file.
63 * @param exception
64 * Generated exception
65 */
66 public ConfigurationFileCorruptException(final String/* ! */filename,
67 final Exception/* ! */exception) {
68 super(exception);
69 this.m_filename = filename;
70 }
71
72 /*
73 * (non-Javadoc)
74 *
75 * @see java.lang.Throwable#getMessage()
76 */
77 @Override
78 public final String getMessage() {
79 return super.getMessage() + "Invalid structure in configuration file "
80 + this.getFilename();
81 }
82
83 /**
84 * Returns the filename of the configuration file.
85 *
86 * @return the filename
87 */
88 public final String getFilename() {
89 return this.m_filename;
90 }
91 }