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