javax.faces.convert.Converter Maven / Gradle / Ivy
/*
* $Id: Converter.java,v 1.15 2006/12/15 18:12:14 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.convert;
import javax.faces.component.StateHolder;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
/**
* Converter is an interface describing a Java class
* that can perform Object-to-String and String-to-Object conversions
* between model data objects and a String representation of those
* objects that is suitable for rendering.
*
* {@link Converter} implementations must have a zero-arguments public
* constructor. In addition, if the {@link Converter} class wishes to have
* configuration property values saved and restored with the component tree,
* the implementation must also implement {@link StateHolder}.
*
* Starting with version 1.2 of the specification, an exception to the above
* zero-arguments constructor requirement has been introduced. If a converter has
* a single argument constructor that takes a Class instance and
* the Class of the data to be converted is
* known at converter instantiation time, this constructor
* must be used to instantiate the converter instead of the zero-argument
* version. This enables the per-class conversion
* of Java enumerated types.
*
* If any Converter implementation requires a
* java.util.Locale to perform its job, it must obtain that
* Locale from the {@link javax.faces.component.UIViewRoot}
* of the current {@link FacesContext}, unless the
* Converter maintains its own Locale as part
* of its state.
*/
public interface Converter {
/**
* Convert the specified string value, which is associated with
* the specified {@link UIComponent}, into a model data object that
* is appropriate for being stored during the Apply Request
* Values phase of the request processing lifecycle.
*
* @param context {@link FacesContext} for the request being processed
* @param component {@link UIComponent} with which this model object
* value is associated
* @param value String value to be converted (may be null)
* @return null if the value to convert is null,
* otherwise the result of the conversion
* @throws ConverterException if conversion cannot be successfully
* performed
* @throws NullPointerException if context or
* component is null
*/
public Object getAsObject(FacesContext context, UIComponent component,
String value);
/**
* Convert the specified model object value, which is associated with
* the specified {@link UIComponent}, into a String that is suitable
* for being included in the response generated during the
* Render Response phase of the request processing
* lifeycle.
*
* @param context {@link FacesContext} for the request being processed
* @param component {@link UIComponent} with which this model object
* value is associated
* @param value Model object value to be converted
* (may be null)
* @return a zero-length String if value is null,
* otherwise the result of the conversion
* @throws ConverterException if conversion cannot be successfully
* performed
* @throws NullPointerException if context or
* component is null
*/
public String getAsString(FacesContext context, UIComponent component,
Object value);
}