1   /*
    2   * Licensed to the Apache Software Foundation (ASF) under one or more
    3   * contributor license agreements.  See the NOTICE file distributed with
    4   * this work for additional information regarding copyright ownership.
    5   * The ASF licenses this file to You under the Apache License, Version 2.0
    6   * (the "License"); you may not use this file except in compliance with
    7   * the License.  You may obtain a copy of the License at
    8   *
    9   *     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 indicate the calling page must cease evaluation.
   21    * Thrown by a simple tag handler to indicate that the remainder of 
   22    * the page must not be evaluated.  The result is propagated back to
   23    * the pagein the case where one tag invokes another (as can be
   24    * the case with tag files).  The effect is similar to that of a 
   25    * Classic Tag Handler returning Tag.SKIP_PAGE from doEndTag().
   26    * Jsp Fragments may also throw this exception.  This exception
   27    * should not be thrown manually in a JSP page or tag file - the behavior is
   28    * undefined.  The exception is intended to be thrown inside 
   29    * SimpleTag handlers and in JSP fragments.
   30    * 
   31    * @see javax.servlet.jsp.tagext.SimpleTag#doTag
   32    * @see javax.servlet.jsp.tagext.JspFragment#invoke
   33    * @see javax.servlet.jsp.tagext.Tag#doEndTag
   34    * @since 2.0
   35    */
   36   public class SkipPageException
   37       extends JspException
   38   {
   39       /**
   40        * Creates a SkipPageException with no message.
   41        */
   42       public SkipPageException() {
   43           super();
   44       }
   45       
   46       /**
   47        * Creates a SkipPageException with the provided message.
   48        *
   49        * @param message the detail message
   50        */
   51       public SkipPageException( String message ) {
   52           super( message );
   53       }
   54   
   55       /**
   56        * Creates a SkipPageException with the provided message and root cause.
   57        *
   58        * @param message the detail message
   59        * @param rootCause the originating cause of this exception
   60        */
   61       public SkipPageException( String message, Throwable rootCause ) {
   62   	super( message, rootCause );
   63       }
   64   
   65       /**
   66        * Creates a SkipPageException with the provided root cause.
   67        *
   68        * @param rootCause the originating cause of this exception
   69        */
   70       public SkipPageException( Throwable rootCause ) {
   71   	super( rootCause );
   72       }
   73       
   74   }
   75   
   76