01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package javax.servlet.jsp;
18:
19: /**
20: * Exception to be used by a Tag Handler to indicate some unrecoverable
21: * error.
22: * This error is to be caught by the top level of the JSP page and will result
23: * in an error page.
24: */
25:
26: public class JspTagException extends JspException {
27: /**
28: * Constructs a new JspTagException with the specified message.
29: * The message can be written to the server log and/or displayed
30: * for the user.
31: *
32: * @param msg a <code>String</code> specifying the text of
33: * the exception message
34: */
35: public JspTagException(String msg) {
36: super (msg);
37: }
38:
39: /**
40: * Constructs a new JspTagException with no message.
41: */
42: public JspTagException() {
43: super ();
44: }
45:
46: /**
47: * Constructs a new JspTagException when the JSP Tag
48: * needs to throw an exception and include a message
49: * about the "root cause" exception that interfered with its
50: * normal operation, including a description message.
51: *
52: *
53: * @param message a <code>String</code> containing
54: * the text of the exception message
55: *
56: * @param rootCause the <code>Throwable</code> exception
57: * that interfered with the JSP Tag's
58: * normal operation, making this JSP Tag
59: * exception necessary
60: *
61: * @since 2.0
62: */
63: public JspTagException(String message, Throwable rootCause) {
64: super (message, rootCause);
65: }
66:
67: /**
68: * Constructs a new JSP Tag exception when the JSP Tag
69: * needs to throw an exception and include a message
70: * about the "root cause" exception that interfered with its
71: * normal operation. The exception's message is based on the localized
72: * message of the underlying exception.
73: *
74: * <p>This method calls the <code>getLocalizedMessage</code> method
75: * on the <code>Throwable</code> exception to get a localized exception
76: * message. When subclassing <code>JspTagException</code>,
77: * this method can be overridden to create an exception message
78: * designed for a specific locale.
79: *
80: * @param rootCause the <code>Throwable</code> exception
81: * that interfered with the JSP Tag's
82: * normal operation, making the JSP Tag
83: * exception necessary
84: *
85: * @since 2.0
86: */
87:
88: public JspTagException(Throwable rootCause) {
89: super(rootCause);
90: }
91:
92: }
|