javax.faces.convert.ConverterException Maven / Gradle / Ivy
Show all versions of jsf-api Show documentation
/*
* 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.dev.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.convert;
import javax.faces.FacesException;
import javax.faces.application.FacesMessage;
/**
* ConverterException is an exception thrown by the
* getAsObject() or getAsText() method of a
* {@link Converter}, to indicate that the requested conversion cannot
* be performed.
*/
public class ConverterException extends FacesException {
// ----------------------------------------------------------- Constructors
/**
* Construct a new exception with no detail message or root cause.
*/
public ConverterException() {
super();
}
/**
* Construct a new exception with the specified detail message and
* no root cause.
*
* @param message The detail message for this exception
*/
public ConverterException(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 ConverterException(Throwable cause) {
super(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 ConverterException(String message, Throwable cause) {
super(message, cause);
}
/**
* Construct a new exception with the specified detail message and
* no root cause.
*
* @param message The detail message for this exception
*/
public ConverterException(FacesMessage message) {
super(message.getSummary());
this.facesMessage = message;
}
/**
* 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 ConverterException(FacesMessage message, Throwable cause) {
super(message.getSummary(), cause);
this.facesMessage = message;
}
/**
* Returns the FacesMessage associated with this exception; this
* will only be available if the converter that thew this exception
* instance placed it there.
*/
public FacesMessage getFacesMessage() {
return facesMessage;
}
private FacesMessage facesMessage;
}