jakarta.servlet.jsp.JspException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jakarta.jakartaee-web-api Show documentation

Jakarta EE Web Profile API

There is a newer version: 11.0.0-M4

Show newest version

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates and others.
 * All rights reserved.
 * Copyright 2004 The Apache Software Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jakarta.servlet.jsp;

/**
 * A generic exception known to the JSP engine; uncaught JspExceptions will result in an invocation of the errorpage
 * machinery.
 */
public class JspException extends Exception {

    private static final long serialVersionUID = -724329986255528641L;

    /**
     * Construct a JspException.
     */
    public JspException() {
    }

    /**
     * Constructs a new JSP exception with the specified message. The message can be written to the server log and/or
     * displayed for the user.
     *
     * @param msg a String specifying the text of the exception message
     *
     */
    public JspException(String msg) {
        super(msg);
    }

    /**
     * Constructs a new JspException with the specified detail message and cause.
     *
     * @param message a String specifying the text of the exception message
     * @param cause   the cause which is saved for later retrieval by the {@link #getCause()} and
     *                {@link #getRootCause()} methods.
     *
     * @see java.lang.Exception#Exception(String, Throwable)
     */
    public JspException(String message, Throwable cause) {
        super(message, cause);
    }

    /**
     * Constructs a new JspException with the specified cause.
     *
     * @param cause the cause which is saved for later retrieval by the {@link #getCause()} and {@link #getRootCause()}
     *              methods.
     *
     * @see java.lang.Exception#Exception(Throwable)
     */
    public JspException(Throwable cause) {
        super(cause);
    }

    /**
     * Returns the exception that caused this JSP exception.
     *
     * @return the Throwable that caused this JSP exception
     *
     * @deprecated As of JSP 2.1, replaced by {@link #getCause()}
     */
    @Deprecated
    public Throwable getRootCause() {
        return getCause();
    }
}