1 /*
2 * $Id: FacesException.java,v 1.16 2007/04/27 22:00:02 ofung Exp $
3 */
4
5 /*
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
7 *
8 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
9 *
10 * The contents of this file are subject to the terms of either the GNU
11 * General Public License Version 2 only ("GPL") or the Common Development
12 * and Distribution License("CDDL") (collectively, the "License"). You
13 * may not use this file except in compliance with the License. You can obtain
14 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16 * language governing permissions and limitations under the License.
17 *
18 * When distributing the software, include this License Header Notice in each
19 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20 * Sun designates this particular file as subject to the "Classpath" exception
21 * as provided by Sun in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the License
23 * Header, with the fields enclosed by brackets [] replaced by your own
24 * identifying information: "Portions Copyrighted [year]
25 * [name of copyright owner]"
26 *
27 * Contributor(s):
28 *
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41
42 package javax.faces;
43
44
45 /**
46 * <p>This class encapsulates general JavaServer Faces exceptions.</p>
47 */
48
49 public class FacesException extends RuntimeException {
50
51
52 // ----------------------------------------------------------- Constructors
53
54
55 /**
56 * <p>Construct a new exception with no detail message or root cause.</p>
57 */
58 public FacesException() {
59
60 super();
61
62 }
63
64
65 /**
66 * <p>Construct a new exception with the specified detail message and
67 * no root cause.</p>
68 *
69 * @param message The detail message for this exception
70 */
71 public FacesException(String message) {
72
73 super(message);
74
75 }
76
77
78 /**
79 * <p>Construct a new exception with the specified root cause. The detail
80 * message will be set to <code>(cause == null ? null :
81 * cause.toString()</code>
82 *
83 * @param cause The root cause for this exception
84 */
85 public FacesException(Throwable cause) {
86
87 super(cause == null ? null : cause.toString());
88 this.cause = cause;
89
90 }
91
92
93 /**
94 * <p>Construct a new exception with the specified detail message and
95 * root cause.</p>
96 *
97 * @param message The detail message for this exception
98 * @param cause The root cause for this exception
99 */
100 public FacesException(String message, Throwable cause) {
101
102 super(message);
103 this.cause = cause;
104
105 }
106
107
108
109 // ----------------------------------------------------- Instance Variables
110
111
112 /**
113 * <p>The underlying exception that caused this exception.</p>
114 */
115 private Throwable cause = null;
116
117
118 // --------------------------------------------------------- Public Methods
119
120
121 /**
122 * <p>Return the cause of this exception, or <code>null</code> if the
123 * cause is nonexistent or unknown.</p>
124 */
125 public Throwable getCause() {
126
127 return (this.cause);
128
129 }
130
131
132 }