1 /**
2 * Redistribution and use of this software and associated documentation ("Software"), with or
3 * without modification, are permitted provided that the following conditions are met:
4 *
5 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6 * must also contain a copy of this document.
7 *
8 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9 * conditions and the following disclaimer in the documentation and/or other materials provided with
10 * the distribution.
11 *
12 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13 * without prior written permission of Intalio, Inc. For written permission, please contact
14 * info@exolab.org.
15 *
16 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18 * Intalio, Inc.
19 *
20 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21 *
22 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35
36 package org.exolab.castor.xml;
37
38 /**
39 * The base exception for Castor (or at least Castor XML)
40 *
41 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
42 * @version $Revision$ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
43 **/
44 public class CastorException extends Exception {
45 /** SerialVersionUID */
46 private static final long serialVersionUID = -1648679783713336948L;
47
48 /**
49 * The error code for this Exception
50 **/
51 private int _errorCode = -1;
52
53 /**
54 * The message for this Exception
55 **/
56 private String _message = null;
57
58 // ----------------/
59 // - Constructors -/
60 // ----------------/
61
62 /**
63 * Creates a new CastorException with no message, or nested Exception
64 **/
65 public CastorException() {
66 super();
67 } // -- CastorException
68
69 /**
70 * Creates a new CastorException with the given message.
71 *
72 * @param message the message for this Exception
73 **/
74 public CastorException(String message) {
75 super(message);
76 this._message = message;
77 } // -- CastorException(String)
78
79 /**
80 * Creates a new CastorException with the given nested exception.
81 *
82 * @param errorCode the error code for this Exception
83 **/
84 public CastorException(int errorCode) {
85 super();
86 this._errorCode = errorCode;
87 } // -- CastorException(int)
88
89 /**
90 * Creates a new CastorException with the given message nested exception.
91 *
92 * @param message the detail message for this exception
93 * @param errorCode the error code for this Exception
94 **/
95 public CastorException(String message, int errorCode) {
96 super(message);
97 this._message = message;
98 this._errorCode = errorCode;
99 } // -- CastorException(String, int)
100
101 // ------------------/
102 // - Public Methods -/
103 // ------------------/
104
105 /**
106 * Returns the error code for this Exception, or -1 if no error code exists.
107 *
108 * @return the error code for this Exception, or -1 if no error code exists
109 **/
110 public int getErrorCode() {
111 return _errorCode;
112 } // -- getErrorCode
113
114 /**
115 * Returns the detail message for this Exception
116 *
117 * @return the detail message for this Exception
118 **/
119 public String getMessage() {
120 // -- simply return message, or if null,
121 // -- to prevent null pointer exceptions while printing
122 // -- error message, return ""
123 if (_message == null)
124 return "";
125 return _message;
126 } // -- getMessage
127
128
129 /**
130 * Sets the error code for this Exception
131 *
132 * @param errorCode the error code
133 **/
134 public void setErrorCode(int errorCode) {
135 this._errorCode = errorCode;
136 } // -- setErrorCode
137
138 /**
139 * Sets the message for this Exception
140 *
141 * @param message the message for this Exception
142 **/
143 public void setMessage(String message) {
144 this._message = message;
145 } // -- setMessage
146
147
148 } // -- CastorException