javax.faces.convert.BooleanConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsf-api
This is the master POM file for Oracle's Implementation of the JSF 2.1 Specification.
There is a newer version: 2.1
/*
 * $Id: BooleanConverter.java,v 1.19 2007/01/29 06:59:57 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.UIComponent;
import javax.faces.context.FacesContext;


/**
 * {@link Converter} implementation for java.lang.Boolean
 * (and boolean primitive) values.
 */

public class BooleanConverter implements Converter {

    // ------------------------------------------------------ Manifest Constants


    /**
     * The standard converter id for this converter.
     */
    public static final String CONVERTER_ID = "javax.faces.Boolean";

    /**
     * The message identifier of the {@link javax.faces.application.FacesMessage} to be created if
     * the conversion to Boolean fails.  The message format
     * string for this message may optionally include the following
     * placeholders:
     * 

     * {0} replaced by the unconverted value.
     * {1} replaced by a String whose value
     * is the label of the input component that produced this message.
     * 

     */
    public static final String BOOLEAN_ID =
         "javax.faces.converter.BooleanConverter.BOOLEAN";

    /**
     * The message identifier of the {@link javax.faces.application.FacesMessage} to be created if
     * the conversion of the Boolean value to
     * String fails.   The message format string for this message
     * may optionally include the following placeholders:
     * 

     * {0} relaced by the unconverted value.
     * {1} replaced by a String whose value
     * is the label of the input component that produced this message.
     * 

     */
    public static final String STRING_ID =
         "javax.faces.converter.STRING";

    // ------------------------------------------------------- Converter Methods

    /**
     * @throws ConverterException   {@inheritDoc}
     * @throws NullPointerException {@inheritDoc}
     */
    public Object getAsObject(FacesContext context, UIComponent component,
                              String value) {

        if (context == null || component == null) {
            throw new NullPointerException();
        }

        // If the specified value is null or zero-length, return null
        if (value == null) {
            return (null);
        }
        value = value.trim();
        if (value.length() < 1) {
            return (null);
        }

        // Let them know that the value being converted is not specifically
        // "true" or "false".
        try {
            return (Boolean.valueOf(value));
        } catch (Exception e) {
            throw new ConverterException(
                 MessageFactory.getMessage(context,
                                           BOOLEAN_ID,
                                           value,
                                           MessageFactory.getLabel(context,
                                                                   component)),
                                           e);
        }
    }

    /**
     * @throws ConverterException   {@inheritDoc}
     * @throws NullPointerException {@inheritDoc}
     */
    public String getAsString(FacesContext context, UIComponent component,
                              Object value) {

        if (context == null || component == null) {
            throw new NullPointerException();
        }

        // If the specified value is null, return a zero-length String
        if (value == null) {
            return "";
        }

        try {
            return value.toString();
        } catch (Exception e) {
            throw new ConverterException(
                 MessageFactory.getMessage(context,
                                           STRING_ID,
                                           value,
                                           MessageFactory.getLabel(context,
                                                                   component)),
                                           e);
        }
    }
}