001 /** 002 * 003 * Copyright 2003-2004 The Apache Software Foundation 004 * 005 * Licensed under the Apache License, Version 2.0 (the "License"); 006 * you may not use this file except in compliance with the License. 007 * 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 018 // 019 // This source code implements specifications defined by the Java 020 // Community Process. In order to remain compliant with the specification 021 // DO NOT add / change / or delete method signatures! 022 // 023 024 package javax.servlet.jsp; 025 026 /** 027 * Exception to indicate the calling page must cease evaluation. 028 * Thrown by a simple tag handler to indicate that the remainder of 029 * the page must not be evaluated. The result is propagated back to 030 * the pagein the case where one tag invokes another (as can be 031 * the case with tag files). The effect is similar to that of a 032 * Classic Tag Handler returning Tag.SKIP_PAGE from doEndTag(). 033 * Jsp Fragments may also throw this exception. This exception 034 * should not be thrown manually in a JSP page or tag file - the behavior is 035 * undefined. The exception is intended to be thrown inside 036 * SimpleTag handlers and in JSP fragments. 037 * 038 * @see javax.servlet.jsp.tagext.SimpleTag#doTag 039 * @see javax.servlet.jsp.tagext.JspFragment#invoke 040 * @see javax.servlet.jsp.tagext.Tag#doEndTag 041 * @since 2.0 042 */ 043 public class SkipPageException 044 extends JspException 045 { 046 /** 047 * Creates a SkipPageException with no message. 048 */ 049 public SkipPageException() { 050 super(); 051 } 052 053 /** 054 * Creates a SkipPageException with the provided message. 055 * 056 * @param message the detail message 057 */ 058 public SkipPageException( String message ) { 059 super( message ); 060 } 061 062 /** 063 * Creates a SkipPageException with the provided message and root cause. 064 * 065 * @param message the detail message 066 * @param rootCause the originating cause of this exception 067 */ 068 public SkipPageException( String message, Throwable rootCause ) { 069 super( message, rootCause ); 070 } 071 072 /** 073 * Creates a SkipPageException with the provided root cause. 074 * 075 * @param rootCause the originating cause of this exception 076 */ 077 public SkipPageException( Throwable rootCause ) { 078 super( rootCause ); 079 } 080 081 } 082 083