01 /*
02 * Copyright 2004 The Apache Software Foundation
03 *
04 * Licensed under the Apache License, Version 2.0 (the "License");
05 * you may not use this file except in compliance with the License.
06 * You may obtain a copy of the License at
07 *
08 * http://www.apache.org/licenses/LICENSE-2.0
09 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package javax.servlet.jsp;
17
18 /**
19 * Exception to indicate the calling page must cease evaluation.
20 * Thrown by a simple tag handler to indicate that the remainder of
21 * the page must not be evaluated. The result is propagated back to
22 * the pagein the case where one tag invokes another (as can be
23 * the case with tag files). The effect is similar to that of a
24 * Classic Tag Handler returning Tag.SKIP_PAGE from doEndTag().
25 * Jsp Fragments may also throw this exception. This exception
26 * should not be thrown manually in a JSP page or tag file - the behavior is
27 * undefined. The exception is intended to be thrown inside
28 * SimpleTag handlers and in JSP fragments.
29 *
30 * @see javax.servlet.jsp.tagext.SimpleTag#doTag
31 * @see javax.servlet.jsp.tagext.JspFragment#invoke
32 * @see javax.servlet.jsp.tagext.Tag#doEndTag
33 * @since 2.0
34 */
35 public class SkipPageException extends JspException {
36 /**
37 * Creates a SkipPageException with no message.
38 */
39 public SkipPageException() {
40 super ();
41 }
42
43 /**
44 * Creates a SkipPageException with the provided message.
45 *
46 * @param message the detail message
47 */
48 public SkipPageException(String message) {
49 super (message);
50 }
51
52 /**
53 * Creates a SkipPageException with the provided message and root cause.
54 *
55 * @param message the detail message
56 * @param rootCause the originating cause of this exception
57 */
58 public SkipPageException(String message, Throwable rootCause) {
59 super (message, rootCause);
60 }
61
62 /**
63 * Creates a SkipPageException with the provided root cause.
64 *
65 * @param rootCause the originating cause of this exception
66 */
67 public SkipPageException(Throwable rootCause) {
68 super(rootCause);
69 }
70
71 }
|