/*
* 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.convert;
import javax.faces.component.UIComponent;
import javax.faces.component.PartialStateHolder;
import javax.faces.context.FacesContext;
/**
* <p><span class="changed_modified_2_0
* changed_modified_2_0_rev_a">{@link Converter}</span> implementation
* for <code>java.lang.Enum</code> (and enum primitive) values.</p>
*
* @since 1.2
*/
public class EnumConverter implements Converter, PartialStateHolder {
// for StateHolder
public EnumConverter() {
}
public EnumConverter(Class targetClass) {
this.targetClass = (Class<? extends Enum>) targetClass;
}
// ------------------------------------------------------ Manifest Constants
/**
* <p>The standard converter id for this converter.</p>
*/
public static final String CONVERTER_ID = "javax.faces.Enum";
/**
* <p>The message identifier of the {@link javax.faces.application.FacesMessage} to be created if
* the conversion to <code>Enum</code> fails. The message format
* string for this message may optionally include the following
* placeholders:
* <ul>
* <li><code>{0}</code> replaced by the unconverted value.</li>
* <li><code>{1}</code> replaced by one of the enum constants or the empty
* string if none can be found.</li>
* <li><code>{2}</code> replaced by a <code>String</code> whose value
* is the label of the input component that produced this message.</li>
* </ul>
*/
public static final String ENUM_ID =
"javax.faces.converter.EnumConverter.ENUM";
/**
* <p>The message identifier of the {@link javax.faces.application.FacesMessage} to be created if
* the conversion to <code>Enum</code> fails and no target class has been
* provided. The message format
* string for this message may optionally include the following
* placeholders:
* <ul>
* <li><code>{0}</code> replaced by the unconverted value.</li>
* <li><code>{1}</code> replaced by a <code>String</code> whose value
* is the label of the input component that produced this message.</li>
* </ul>
*/
public static final String ENUM_NO_CLASS_ID =
"javax.faces.converter.EnumConverter.ENUM_NO_CLASS";
// ----------------------------------------------------- Converter Methods
private Class<? extends Enum> targetClass;
/**
* <p>Convert the <code>value</code> 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 <code>ConverterException</code>
* containing the {@link #ENUM_NO_CLASS_ID} message with proper
* parameters. If the <code>value</code> argument is <code>null</code>
* or it has a length of zero, return <code>null</code>.
* Otherwise, perform the equivalent of <code>Enum.valueOf</code> using
* target class and <code>value</code> and return the <code>Object</code>.
* If the conversion fails, throw a <code>ConverterException</code>
* containing the {@link #ENUM_ID} message with proper parameters.
* </p>
*
* @param context the <code>FacesContext</code> for this request.
* @param component the <code>UIComponent</code> to which this value
* will be applied.
* @param value the String <code>value</code> to be converted to
* <code>Object</code>.
* @throws ConverterException {@inheritDoc}
* @throws NullPointerException {@inheritDoc}
*/
@Override
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);
}
}
/**
* <p class="changed_modified_2_3">Convert the enum constant given by the <code>value</code>
* argument into a String. If no target class argument has been
* provided to the constructor of this instance, throw a
* <code>ConverterException</code> containing the {@link
* #ENUM_NO_CLASS_ID} message with proper parameters. If the
* <code>value</code> argument is <code>null</code>, return
* the empty String. If the value is an instance of the provided
* target class, return its string value by <span
* class="changed_added_2_0">casting it to a
* <code>java.lang.Enum</code> and returning the result of calling
* the <code>name()</code> method.</span> Otherwise, throw a {@link
* ConverterException} containing the {@link #ENUM_ID} message with
* proper parameters.</p>
*
* @throws ConverterException {@inheritDoc}
* @throws NullPointerException {@inheritDoc}
*/
@Override
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 the empty string.
if (value == null) {
return "";
}
if (targetClass.isInstance(value)) {
return ((Enum)value).name();
}
throw new ConverterException(
MessageFactory.getMessage(context,
ENUM_ID,
value,
value,
MessageFactory.getLabel(context,
component)));
}
// ----------------------------------------------------------- StateHolder
@Override
public void restoreState(FacesContext facesContext, Object object) {
if (facesContext == null) {
throw new NullPointerException();
}
if (object != null) {
this.targetClass = (Class<? extends Enum>) object;
}
}
@Override
public Object saveState(FacesContext facesContext) {
if (facesContext == null) {
throw new NullPointerException();
}
if (!initialStateMarked()) {
return this.targetClass;
}
return null;
}
private boolean isTransient;
@Override
public void setTransient(boolean b) {
isTransient = b;
}
@Override
public boolean isTransient() {
return isTransient;
}
private boolean initialState;
@Override
public void markInitialState() {
initialState = true;
}
@Override
public boolean initialStateMarked() {
return initialState;
}
@Override
public void clearInitialState() {
initialState = false;
}
}