jakarta.faces.convert.UUIDConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
The newest version!
/*
 * Copyright (c) Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.faces.convert;

import java.util.UUID;

import jakarta.faces.component.UIComponent;
import jakarta.faces.context.FacesContext;

/**
 * 
 * {@link Converter} implementation for java.util.UUID values.
 * 
 * @since 4.1
 */
public class UUIDConverter implements Converter {

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

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

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

     * {0} replaced by the unconverted value.
     * {1} replaced by an example value.
     * {2} replaced by a String whose value is the label of the input component that produced this message.
     * 
     */
    public static final String UUID_ID = "jakarta.faces.converter.UUIDConverter.UUID";

    /**
     * 
     * The message identifier of the {@link jakarta.faces.application.FacesMessage} to be created if the conversion of the UUID 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 = "jakarta.faces.converter.STRING";

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

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

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

        if (value == null || value.isBlank()) {
            return null;
        }

        try {
            return UUID.fromString(value);
        } catch (IllegalArgumentException e) {
            throw new ConverterException(MessageFactory.getMessage(context, UUID_ID, value, "29573f55-4254-4afa-9ca6-6b5ae6c7ab6e", MessageFactory.getLabel(context, component)), e);
        } catch (Exception e) {
            throw new ConverterException(e);
        }
    }

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

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

        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);
        }
    }
}