KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > CayenneRuntimeException


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56 package org.objectstyle.cayenne;
57
58 /**
59  * A CayenneRuntimeException is a generic *runtime*
60  * exception that may be thrown by Cayenne framework.
61  * All runtime exceptions in Cayenne would normally inherit
62  * from this class. The class
63  * is compatible with JDK 1.3 and at the same time implements
64  * enhancements introduced in 1.4, namely chained exceptions.
65  *
66  * @author Andrei Adamchik
67  */
68 public class CayenneRuntimeException extends RuntimeException JavaDoc {
69     private Throwable JavaDoc _cause;
70
71     /**
72      * Creates new CayenneRuntimeException without detail message.
73      */
74     public CayenneRuntimeException() {
75     }
76
77     /**
78      * Constructs an <code>CayenneRuntimeException</code> with the specified detail message.
79      * @param msg the detail message.
80      */
81     public CayenneRuntimeException(String JavaDoc msg) {
82         super(msg);
83     }
84
85     /**
86      * Constructs an <code>CayenneRuntimeException</code> that
87      * wraps <code>exception</code> thrown elsewhere.
88      */
89     public CayenneRuntimeException(Throwable JavaDoc th) {
90         this(th == null ? (String JavaDoc) null : th.toString(), th);
91     }
92
93     public CayenneRuntimeException(String JavaDoc msg, Throwable JavaDoc th) {
94         super(msg);
95         this._cause = th;
96     }
97
98     /**
99      * Returns an exception that was the underlying cause of this exception.
100      */
101     public Throwable JavaDoc getCause() {
102         return _cause;
103     }
104     
105     /**
106      * Returns exception message without Cayenne version label.
107      *
108      * @since 1.1
109      */
110     public String JavaDoc getUnlabeledMessage() {
111         return super.getMessage();
112     }
113
114     /**
115      * Returns message that includes Cayenne version label and
116      * the actual exception message.
117      */
118     public String JavaDoc getMessage() {
119         String JavaDoc message = super.getMessage();
120         return (message != null)
121             ? CayenneException.getExceptionLabel() + message
122             : CayenneException.getExceptionLabel() + "(no message)";
123     }
124 }
125
Popular Tags