001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 package javax.servlet.jsp; 018 019 /** 020 * Exception to indicate the calling page must cease evaluation. 021 * Thrown by a simple tag handler to indicate that the remainder of 022 * the page must not be evaluated. The result is propagated back to 023 * the pagein the case where one tag invokes another (as can be 024 * the case with tag files). The effect is similar to that of a 025 * Classic Tag Handler returning Tag.SKIP_PAGE from doEndTag(). 026 * Jsp Fragments may also throw this exception. This exception 027 * should not be thrown manually in a JSP page or tag file - the behavior is 028 * undefined. The exception is intended to be thrown inside 029 * SimpleTag handlers and in JSP fragments. 030 * 031 * @see javax.servlet.jsp.tagext.SimpleTag#doTag 032 * @see javax.servlet.jsp.tagext.JspFragment#invoke 033 * @see javax.servlet.jsp.tagext.Tag#doEndTag 034 * @since 2.0 035 */ 036 public class SkipPageException 037 extends JspException 038 { 039 /** 040 * Creates a SkipPageException with no message. 041 */ 042 public SkipPageException() { 043 super(); 044 } 045 046 /** 047 * Creates a SkipPageException with the provided message. 048 * 049 * @param message the detail message 050 */ 051 public SkipPageException( String message ) { 052 super( message ); 053 } 054 055 /** 056 * Creates a SkipPageException with the provided message and root cause. 057 * 058 * @param message the detail message 059 * @param rootCause the originating cause of this exception 060 */ 061 public SkipPageException( String message, Throwable rootCause ) { 062 super( message, rootCause ); 063 } 064 065 /** 066 * Creates a SkipPageException with the provided root cause. 067 * 068 * @param rootCause the originating cause of this exception 069 */ 070 public SkipPageException( Throwable rootCause ) { 071 super( rootCause ); 072 } 073 074 } 075 076