KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.objectstyle.cayenne.util.LocalizedStringsHandler;
59
60 /**
61  * A CayenneException is a generic exception that
62  * may be thrown by Cayenne framework. All checked exceptions
63  * in Cayenne would normally inherit from this class.
64  * The class is compatible with JDK 1.3 and at the same
65  * time implements enhancements introduced in 1.4, namely
66  * chained exceptions.
67  *
68  * @author Andrei Adamchik
69  */
70 public class CayenneException extends Exception JavaDoc {
71     private static String JavaDoc exceptionLabel;
72
73     static {
74         String JavaDoc version = LocalizedStringsHandler.getString("cayenne.version");
75         String JavaDoc date = LocalizedStringsHandler.getString("cayenne.build.date");
76
77         if (version != null || date != null) {
78             exceptionLabel = "[v." + version + " " + date + "] ";
79         }
80         else {
81             exceptionLabel = "";
82         }
83     }
84
85     public static String JavaDoc getExceptionLabel() {
86         return exceptionLabel;
87     }
88
89     private Throwable JavaDoc _cause;
90
91     /**
92      * Creates new <code>CayenneException</code> without detail message.
93      */
94     public CayenneException() {
95     }
96
97     /**
98      * Constructs an <code>CayenneException</code> with the specified detail message.
99      * @param msg the detail message.
100      */
101     public CayenneException(String JavaDoc msg) {
102         super(msg);
103     }
104
105     /**
106      * Constructs an <code>CayenneException</code> that wraps <code>exception</code>
107      * thrown elsewhere.
108      */
109     public CayenneException(Throwable JavaDoc th) {
110         this(th == null ? (String JavaDoc) null : th.toString(), th);
111     }
112
113     public CayenneException(String JavaDoc msg, Throwable JavaDoc th) {
114         super(msg);
115         this._cause = th;
116     }
117
118     /**
119      * @see java.lang.Throwable#getCause()
120      */
121     public Throwable JavaDoc getCause() {
122         return _cause;
123     }
124     
125     /**
126      * Returns exception message without Cayenne version label.
127      *
128      * @since 1.1
129      */
130     public String JavaDoc getUnlabeledMessage() {
131         return super.getMessage();
132     }
133
134     public String JavaDoc getMessage() {
135         String JavaDoc message = super.getMessage();
136         return (message != null)
137             ? getExceptionLabel() + message
138             : getExceptionLabel() + "(no message)";
139     }
140 }
141
Popular Tags