001: /*
002: * Redistribution and use of this software and associated documentation
003: * ("Software"), with or without modification, are permitted provided
004: * that the following conditions are met:
005: *
006: * 1. Redistributions of source code must retain copyright
007: * statements and notices. Redistributions must also contain a
008: * copy of this document.
009: *
010: * 2. Redistributions in binary form must reproduce the
011: * above copyright notice, this list of conditions and the
012: * following disclaimer in the documentation and/or other
013: * materials provided with the distribution.
014: *
015: * 3. The name "Exolab" must not be used to endorse or promote
016: * products derived from this Software without prior written
017: * permission of Intalio, Inc. For written permission,
018: * please contact info@exolab.org.
019: *
020: * 4. Products derived from this Software may not be called "Exolab"
021: * nor may "Exolab" appear in their names without prior written
022: * permission of Intalio, Inc. Exolab is a registered
023: * trademark of Intalio, Inc.
024: *
025: * 5. Due credit should be given to the Exolab Project
026: * (http://www.exolab.org/).
027: *
028: * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
029: * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
030: * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
031: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
032: * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
033: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
034: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
035: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
036: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
037: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
038: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
039: * OF THE POSSIBILITY OF SUCH DAMAGE.
040: *
041: * Copyright 2002 (C) Intalio Inc. All Rights Reserved.
042: *
043: * $Id: BindingException.java 6678 2007-01-02 17:09:52Z rjoachim $
044: */
045: package org.exolab.castor.builder.binding;
046:
047: /**
048: * The base exception for the <tt>binding</tt> package. This exception is
049: * nested in order to keep a correct stack trace while nesting the exception
050: * that causes the call to BindingException.
051: *
052: * @author <a href="mailto:blandin@intalio.com">Arnaud Blandin</a>
053: * @version $Version:$ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
054: */
055: public final class BindingException extends Exception {
056:
057: /** We add this field because an Exception is serializable. */
058: private static final long serialVersionUID = 1726983206974247107L;
059: /** The embedded exception if tunnelling, or null. */
060: private Exception _exception;
061:
062: /**
063: * Creates a new BindingException.
064: *
065: * @param message The error or warning message.
066: */
067: public BindingException(final String message) {
068: super (message);
069: _exception = null;
070: }
071:
072: /**
073: * Creates a new BindingException wrapping an existing Exception.
074: * <p>
075: * The existing Exception will be embedded in the new one, and its message
076: * will become the default message for the BindingException.
077: *
078: * @param exception The Exception to be wrapped in a BindingException.
079: */
080: public BindingException(final Exception exception) {
081: super ();
082: _exception = exception;
083: }
084:
085: /**
086: * Creates a new BindingException from an existing exception.
087: * <p>
088: * The existing Exception will be embedded in the new one, but the new
089: * Exception will have its own message.
090: *
091: * @param message The detail message.
092: * @param exception The Exception to be wrapped in a BindingException.
093: */
094: public BindingException(final String message,
095: final Exception exception) {
096: super (message);
097: _exception = exception;
098: }
099:
100: /**
101: * Returns a detailed message for this Exception.
102: * <p>
103: * If there is an embedded Exception, and if the BindingException has no
104: * detail message of its own, this method will return the detail message
105: * from the embedded Exception.
106: *
107: * @return String The error or warning message.
108: */
109: public String getMessage() {
110: String message = super .getMessage();
111:
112: if (message == null && _exception != null) {
113: return _exception.getMessage();
114: }
115: return message;
116: }
117:
118: /**
119: * Returns the embedded Exception, if any.
120: *
121: * @return Exception The embedded Exception, or null if there is none.
122: */
123: public Exception getException() {
124: return _exception;
125: }
126:
127: /**
128: * Overrides printStackTrace to keep the stack trace of the embedded
129: * Exception.
130: */
131: public void printStackTrace() {
132: if (_exception != null) {
133: System.out.println("--------------------------------");
134: System.out.println("Stack Trace for :" + _exception);
135: _exception.printStackTrace();
136: System.out.println("--------------------------------");
137: }
138: super .printStackTrace();
139: }
140:
141: /**
142: * Overrides toString to pick up any embedded Exception.
143: *
144: * @return String A string representation of this Exception.
145: */
146: public String toString() {
147: if (_exception != null) {
148: return _exception.toString();
149: }
150: return super.toString();
151: }
152:
153: }
|