Save This Page
Home » glassfish-v2ur2-b04-src » javax » servlet » jsp » [javadoc | source]
    1   /*
    2    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
    3    * 
    4    * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
    5    * 
    6    * Portions Copyright Apache Software Foundation.
    7    * 
    8    * The contents of this file are subject to the terms of either the GNU
    9    * General Public License Version 2 only ("GPL") or the Common Development
   10    * and Distribution License("CDDL") (collectively, the "License").  You
   11    * may not use this file except in compliance with the License. You can obtain
   12    * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
   13    * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
   14    * language governing permissions and limitations under the License.
   15    * 
   16    * When distributing the software, include this License Header Notice in each
   17    * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
   18    * Sun designates this particular file as subject to the "Classpath" exception
   19    * as provided by Sun in the GPL Version 2 section of the License file that
   20    * accompanied this code.  If applicable, add the following below the License
   21    * Header, with the fields enclosed by brackets [] replaced by your own
   22    * identifying information: "Portions Copyrighted [year]
   23    * [name of copyright owner]"
   24    * 
   25    * Contributor(s):
   26    * 
   27    * If you wish your version of this file to be governed by only the CDDL or
   28    * only the GPL Version 2, indicate your decision by adding "[Contributor]
   29    * elects to include this software in this distribution under the [CDDL or GPL
   30    * Version 2] license."  If you don't indicate a single choice of license, a
   31    * recipient has the option to distribute your version of this file under
   32    * either the CDDL, the GPL Version 2 or to extend the choice of license to
   33    * its licensees as provided above.  However, if you add GPL Version 2 code
   34    * and therefore, elected the GPL Version 2 license, then the option applies
   35    * only if the new code is made subject to such option by the copyright
   36    * holder.
   37    */
   38   package javax.servlet.jsp;
   39   
   40   /**
   41    * Exception to indicate the calling page must cease evaluation.
   42    * Thrown by a simple tag handler to indicate that the remainder of 
   43    * the page must not be evaluated.  The result is propagated back to
   44    * the pagein the case where one tag invokes another (as can be
   45    * the case with tag files).  The effect is similar to that of a 
   46    * Classic Tag Handler returning Tag.SKIP_PAGE from doEndTag().
   47    * Jsp Fragments may also throw this exception.  This exception
   48    * should not be thrown manually in a JSP page or tag file - the behavior is
   49    * undefined.  The exception is intended to be thrown inside 
   50    * SimpleTag handlers and in JSP fragments.
   51    * 
   52    * @see javax.servlet.jsp.tagext.SimpleTag#doTag
   53    * @see javax.servlet.jsp.tagext.JspFragment#invoke
   54    * @see javax.servlet.jsp.tagext.Tag#doEndTag
   55    * @since 2.0
   56    */
   57   public class SkipPageException
   58       extends JspException
   59   {
   60       /**
   61        * Creates a SkipPageException with no message.
   62        */
   63       public SkipPageException() {
   64           super();
   65       }
   66       
   67       /**
   68        * Creates a SkipPageException with the provided message.
   69        *
   70        * @param message the detail message
   71        */
   72       public SkipPageException( String message ) {
   73           super( message );
   74       }
   75   
   76       /**
   77        * Creates a SkipPageException with the provided message and root cause.
   78        *
   79        * @param message the detail message
   80        * @param rootCause the originating cause of this exception
   81        */
   82       public SkipPageException( String message, Throwable rootCause ) {
   83   	super( message, rootCause );
   84       }
   85   
   86       /**
   87        * Creates a SkipPageException with the provided root cause.
   88        *
   89        * @param rootCause the originating cause of this exception
   90        */
   91       public SkipPageException( Throwable rootCause ) {
   92   	super( rootCause );
   93       }
   94       
   95   }
   96   
   97   

Save This Page
Home » glassfish-v2ur2-b04-src » javax » servlet » jsp » [javadoc | source]