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 10:15:32 -0500 (dom, 06 mar 2011) $:
26 * Revision: $LastChangedRevision: 1913 $:
27 * URL: $HeadURL: https://zemucan.svn.sourceforge.net/svnroot/zemucan/branches/zemucan_v1/source-code/tools/src/main/java/name/angoca/zemucan/ParameterNullException.java $:
28 */
29
30 package name.angoca.zemucan;
31
32 import name.angoca.zemucan.tools.messages.Messages;
33
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36
37 /**
38 * Exception that indicates that a parameter was null.
39 * <p>
40 * <b>Control Version</b>
41 * <p>
42 * <ul>
43 * <li>1.0.0 Class creation.</li>
44 * <li>1.0.1 Error code.</li>
45 * <li>1.0.2 Logger and final.</li>
46 * <li>1.1.0 Parent exception.</li>
47 * <li>1.1.1 New id.</li>
48 * <li>1.2.0 getParameterName.</li>
49 * </ul>
50 *
51 * @author Andres Gomez Casanova <a
52 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
53 * @version 1.2.0 2009-11-07
54 */
55
56 public final class ParameterNullException extends AbstractZemucanException {
57
58 /**
59 * Logger.
60 */
61 private static final Logger LOGGER = LoggerFactory
62 .getLogger(ParameterNullException.class);
63
64 /**
65 * ID of the exception.
66 */
67 private static final long serialVersionUID = 6552466788027941468L;
68
69 /**
70 * Name of the parameter that was null.
71 */
72 private final String parameterName;
73
74 /**
75 * Creates the exception with the name of a parameter.
76 *
77 * @param parameterNameExcep
78 * Parameter that was null.
79 */
80 public ParameterNullException(final String/* ! */parameterNameExcep) {
81 super();
82 assert parameterNameExcep != null;
83
84 this.parameterName = parameterNameExcep;
85 ParameterNullException.LOGGER.trace(ParameterNullException.class
86 .getName()
87 + " created."); //$NON-NLS-1$
88 }
89
90 /*
91 * (non-Javadoc)
92 * @see java.lang.Throwable#getMessage()
93 */
94 @Override
95 public String/* ! */getMessage() {
96 return Messages.getString("ParameterNullException.CORE1-NullParameter") //$NON-NLS-1$
97 + this.parameterName;
98 }
99
100 /**
101 * Retrieves the name of the parameter, from which this exception was
102 * raised.
103 *
104 * @return The parameter name that has a null value.
105 */
106 public/* ! */String getParameterName() {
107 return this.parameterName;
108 }
109 }