/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. 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.java.net/public/CDDL+GPL_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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;
/**
* <p class="changed_added_2_0">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 <code>ExceptionHandler</code> has an opportunity to handle it.</p>
*
* @since 2.0
*/
public class UpdateModelException extends FacesException {
private static final long serialVersionUID = 6081145672680351218L;
private FacesMessage facesMessage;
// ------------------------------------------------------------ Constructors
/**
* <p class="changed_added_2_0">Store the argument
* <code>facesMessage</code> so it may be returned from {@link
* #getFacesMessage} and pass the argument <code>cause</code> to the
* super constructor.</p>
* @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
/**
* <p class="changed_added_2_0">Return the <code>FacesMessage</code>
* passed to the constructor.</p>
*
* @return the message of this exception.
*
* @since 2.0
*/
public FacesMessage getFacesMessage() {
return this.facesMessage;
}
}