it.cnr.iit.jscontact.tools.dto.utils.EnumUtils Maven / Gradle / Ivy

Go to download
/*
 *    Copyright (C) 2020  Consiglio Nazionale delle Ricerche
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Affero General Public License as
 *     published by the Free Software Foundation, either version 3 of the
 *     License, or (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Affero General Public License for more details.
 *
 *     You should have received a copy of the GNU Affero General Public License
 *     along with this program.  If not, see .
 */
package it.cnr.iit.jscontact.tools.dto.utils;

import java.util.Collection;
import java.util.Map;

/**
 * Utility class for handling generic enums.
 *
 * @author Mario Loffredo
 */
public class EnumUtils {

    /**
     * Returns the value of an enum class matching the given text value.
     *
     * @param  a generic enum
     * @param enumType the enum class
     * @param value the text value
     * @return the enum value matching the text value.
     */
    public static > E getEnum(Class enumType, String value) {

        return getEnum(enumType, value, null);
    }

    /**
     * Returns the value of an enum class matching the given text value.
     * The matching is done by considering possible aliases.
     *
     * @param  a generic enum
     * @param enumType the enum class
     * @param value the text value
     * @param aliases the possible aliases
     * @return the enum value matching the text value
     */
    public static > E getEnum(Class enumType, String value, Map aliases) {

        if (aliases!=null && aliases.containsKey(value))
            return aliases.get(value);

        for (E e : java.util.EnumSet.allOf(enumType)) {
            if (e.toString().equals(value))
                return e;
        }
        throw new IllegalArgumentException();
    }

    /**
     * Returns the value of vCard 4.0 TYPE parameter, as defined in section 5.6 of [RFC6350], matching the given context value.
     *
     * @param  a generic enum
     * @param context the context value
     * @return the value of vCard 4.0 TYPE parameter
     * @see RFC6350
     */
    public static > String toVCardTypeParam(E context) {

        if (context == null)
            return null;

        if (context.toString().equals("work"))
            return "work";
        else if (context.toString().equals("private"))
            return "home";
        else
            return null;
    }

    /**
     * Returns an array of strings matching the given enum values.
     *
     * @param  a generic enum
     * @param enumValues a collection of enum values
     * @return the array of strings
     */
    public static > String[] toStrings(Collection enumValues) {

        if (enumValues == null)
            return null;

        String[] array = new String[enumValues.size()];
        int i = 0;
        for (E item : enumValues)
            array[i++] = item.toString();

        return array;
    }

    /**
     * Returns true if any of the given extensible enum registered values match case insensitively the give value, false otherwise
     *
     * @param  a generic extensible enum
     * @param enumValues an array of registerd values for an extensible enum
     * @param value the given value to match case insensitively
     * @return true if any of the given extensible enum registered values match case insensitively the give value, false otherwise
     */
    public static > boolean containsIgnoreCase(E[] enumValues, String value) {

        for (E enumValue : enumValues) {
            if (enumValue.toString().equalsIgnoreCase(value))
                return true;
        }

        return false;
    }



}