javax.faces.FacesException Maven / Gradle / Ivy
/*
* $Id: FacesException.java,v 1.15 2007/01/29 07:18:02 rlubke Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
package javax.faces;
/**
* This class encapsulates general JavaServer Faces exceptions.
*/
public class FacesException extends RuntimeException {
// ----------------------------------------------------------- Constructors
/**
* Construct a new exception with no detail message or root cause.
*/
public FacesException() {
super();
}
/**
* Construct a new exception with the specified detail message and
* no root cause.
*
* @param message The detail message for this exception
*/
public FacesException(String message) {
super(message);
}
/**
* Construct a new exception with the specified root cause. The detail
* message will be set to (cause == null ? null :
* cause.toString()
*
* @param cause The root cause for this exception
*/
public FacesException(Throwable cause) {
super(cause == null ? null : cause.toString());
this.cause = cause;
}
/**
*
Construct a new exception with the specified detail message and
* root cause.
*
* @param message The detail message for this exception
* @param cause The root cause for this exception
*/
public FacesException(String message, Throwable cause) {
super(message);
this.cause = cause;
}
// ----------------------------------------------------- Instance Variables
/**
* The underlying exception that caused this exception.
*/
private Throwable cause = null;
// --------------------------------------------------------- Public Methods
/**
* Return the cause of this exception, or null if the
* cause is nonexistent or unknown.
*/
public Throwable getCause() {
return (this.cause);
}
}