All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.

There is a newer version: 2.2.20
Show newest version
/*
 * 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.component.UIComponent;
import javax.faces.component.PartialStateHolder;
import javax.faces.context.FacesContext;


/**
 * 

{@link Converter} implementation * for java.lang.Enum (and enum primitive) values.

* * @since 1.2 */ public class EnumConverter implements Converter, PartialStateHolder { // for StateHolder public EnumConverter() { } public EnumConverter(Class targetClass) { this.targetClass = (Class) targetClass; } // ------------------------------------------------------ Manifest Constants /** *

The standard converter id for this converter.

*/ public static final String CONVERTER_ID = "javax.faces.Enum"; /** *

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

    *
  • {0} replaced by the unconverted value.
  • *
  • {1} replaced by one of the enum constants or the empty * string if none can be found.
  • *
  • {2} replaced by a String whose value * is the label of the input component that produced this message.
  • *

*/ public static final String ENUM_ID = "javax.faces.converter.EnumConverter.ENUM"; /** *

The message identifier of the {@link javax.faces.application.FacesMessage} to be created if * the conversion to Enum fails and no target class has been * provided. 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 ENUM_NO_CLASS_ID = "javax.faces.converter.EnumConverter.ENUM_NO_CLASS"; // ----------------------------------------------------- Converter Methods private Class targetClass; /** *

Convert the value argument to one of the enum * constants of the class provided in our constructor. If no * target class argument has been provided to the constructor of * this instance, throw a ConverterException * containing the {@link #ENUM_NO_CLASS_ID} message with proper * parameters. If the value argument is null * or it has a length of zero, return null. * Otherwise, perform the equivalent of Enum.valueOf using * target class and value and return the Object. * If the conversion fails, throw a ConverterException * containing the {@link #ENUM_ID} message with proper parameters. *

* * @param context the FacesContext for this request. * @param component the UIComponent to which this value * will be applied. * @param value the String value to be converted to * Object. * @throws ConverterException {@inheritDoc} * @throws NullPointerException {@inheritDoc} */ public Object getAsObject(FacesContext context, UIComponent component, String value) { if (context == null || component == null) { throw new NullPointerException(); } if (targetClass == null) { throw new ConverterException( MessageFactory.getMessage(context, ENUM_NO_CLASS_ID, value, MessageFactory.getLabel(context, component))); } // 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); } try { return Enum.valueOf(targetClass, value); } catch (IllegalArgumentException iae) { throw new ConverterException( MessageFactory.getMessage(context, ENUM_ID, value, value, MessageFactory.getLabel(context, component)), iae); } } /** *

Convert the enum constant given by the value * argument into a String. If no target class argument has been * provided to the constructor of this instance, throw a * ConverterException containing the {@link * #ENUM_NO_CLASS_ID} message with proper parameters. If the * value argument is null, return * null. If the value is an instance of the provided * target class, return its string value by casting it to a * java.lang.Enum and returning the result of calling * the name() method. Otherwise, throw a {@link * ConverterException} containing the {@link #ENUM_ID} message with * proper parameters.

* * @throws ConverterException {@inheritDoc} * @throws NullPointerException {@inheritDoc} */ public String getAsString(FacesContext context, UIComponent component, Object value) { if (context == null || component == null) { throw new NullPointerException(); } if (targetClass == null) { throw new ConverterException( MessageFactory.getMessage(context, ENUM_NO_CLASS_ID, value, MessageFactory.getLabel(context, component))); } // If the specified value is null, return null if (value == null) { // FIXSPEC even though the Javadoc states that we need to return // null the master Converter contract states that a null value // results in a zero-length string (see JAVASERVERFACES_SPEC_PUBLIC-1217) return ""; } if (targetClass.isInstance(value)) { return ((Enum)value).name(); } throw new ConverterException( MessageFactory.getMessage(context, ENUM_ID, value, value, MessageFactory.getLabel(context, component))); } // ----------------------------------------------------------- StateHolder public void restoreState(FacesContext facesContext, Object object) { if (facesContext == null) { throw new NullPointerException(); } if (object != null) { this.targetClass = (Class) object; } } public Object saveState(FacesContext facesContext) { if (facesContext == null) { throw new NullPointerException(); } if (!initialStateMarked()) { return this.targetClass; } return null; } private boolean isTransient = false; public void setTransient(boolean b) { isTransient = b; } public boolean isTransient() { return isTransient; } private boolean initialState; public void markInitialState() { initialState = true; } public boolean initialStateMarked() { return initialState; } public void clearInitialState() { initialState = false; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy