javax.faces.component.UpdateModelException Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.component;
import javax.faces.FacesException;
import javax.faces.application.FacesMessage;
/**
* This exception indicates a failure to
* update the model and is created to wrap any exception
* that occurs during {@link UIInput#updateModel}. The exception is then passed
* to {@link javax.faces.context.ExceptionHandler#processEvent}, where
* the ExceptionHandler has an opportunity to handle it.
*
* @since 2.0
*/
public class UpdateModelException extends FacesException {
private static final long serialVersionUID = 6081145672680351218L;
private FacesMessage facesMessage;
// ------------------------------------------------------------ Constructors
/**
* Store the argument
* facesMessage so it may be returned from {@link
* #getFacesMessage} and pass the argument cause to the
* super constructor.
* @param facesMessage the message for the exception
* @param cause the cause of this exception
*
* @since 2.0
*/
public UpdateModelException(FacesMessage facesMessage,
Throwable cause) {
super(cause);
this.facesMessage = facesMessage;
}
// ---------------------------------------------------------- Public Methods
/**
* Return the FacesMessage
* passed to the constructor.
*
* @since 2.0
*/
public FacesMessage getFacesMessage() {
return this.facesMessage;
}
}