Home » apache-tomcat-6.0.26-src » javax » servlet » jsp » [javadoc | source]

    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 be used by a Tag Handler to indicate some unrecoverable
   21    * error.
   22    * This error is to be caught by the top level of the JSP page and will result
   23    * in an error page.
   24    */
   25   
   26   public class JspTagException extends JspException {
   27       /**
   28        * Constructs a new JspTagException with the specified message.
   29        * The message can be written to the server log and/or displayed
   30        * for the user.
   31        * 
   32        * @param msg a <code>String</code> specifying the text of 
   33        *     the exception message
   34        */
   35       public JspTagException(String msg) {
   36   	super( msg );
   37       }
   38   
   39       /**
   40        * Constructs a new JspTagException with no message.
   41        */
   42       public JspTagException() {
   43   	super();
   44       }
   45   
   46       /**
   47        * Constructs a new JspTagException when the JSP Tag
   48        * needs to throw an exception and include a message 
   49        * about the "root cause" exception that interfered with its 
   50        * normal operation, including a description message.
   51        *
   52        *
   53        * @param message 		a <code>String</code> containing 
   54        *				the text of the exception message
   55        *
   56        * @param rootCause		the <code>Throwable</code> exception 
   57        *				that interfered with the JSP Tag's
   58        *				normal operation, making this JSP Tag
   59        *				exception necessary
   60        *
   61        * @since 2.0
   62        */
   63       public JspTagException(String message, Throwable rootCause) {
   64   	super( message, rootCause );
   65       }
   66   
   67   
   68       /**
   69        * Constructs a new JSP Tag exception when the JSP Tag
   70        * needs to throw an exception and include a message
   71        * about the "root cause" exception that interfered with its
   72        * normal operation.  The exception's message is based on the localized
   73        * message of the underlying exception.
   74        *
   75        * <p>This method calls the <code>getLocalizedMessage</code> method
   76        * on the <code>Throwable</code> exception to get a localized exception
   77        * message. When subclassing <code>JspTagException</code>, 
   78        * this method can be overridden to create an exception message 
   79        * designed for a specific locale.
   80        *
   81        * @param rootCause 	the <code>Throwable</code> exception
   82        * 				that interfered with the JSP Tag's
   83        *				normal operation, making the JSP Tag 
   84        *                          exception necessary
   85        *
   86        * @since 2.0
   87        */
   88   
   89       public JspTagException(Throwable rootCause) {
   90   	super( rootCause );
   91       }
   92   
   93   }

Home » apache-tomcat-6.0.26-src » javax » servlet » jsp » [javadoc | source]