/**
 * Copyright © CENRA (2016)
 *
 * remi.clement@espaces-naturels.fr
 * 
 * This software is a multi-platform and portable application based on 
 * the scientifical toolbox to monitor wetlands. With this toolbox it’s 
 * possible to calculate indicators «RhoMéO» to monitor quality, 
 * fonctionalities and urban and agricultural pressures of wetlands. 
 * Indicators are calculated using naturalist data entered and/or imported,
 * and geographic data downloaded from a geographic server.
 * 
 * This software is governed by the CeCILL license under French law and
 * abiding by the rules of distribution of free software.  You can  use, 
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info". 
 * 
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability. 
 * 
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or 
 * data to be ensured and,  more generally, to use and operate it in the 
 * same conditions as regards security. 
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
*/
package fr.cenra.rhomeo.api.preferences;

import fr.cenra.rhomeo.api.InternationalDescription;
import static fr.cenra.rhomeo.api.InternationalDescription.DESCRIPTION_KEY;
import fr.cenra.rhomeo.core.RhomeoCore;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.logging.Level;
import static fr.cenra.rhomeo.api.InternationalDescription.LABEL_KEY;

/**
 * An interface to be implemented by preference keys which have an international
 * description.
 *
 * This interface provides a default implementation usefull for {@link Enum}
 * based implementations, assuming the {@link InternationalPreferenceKey#name() }
 * method is implemented.
 *
 * @author Samuel Andrés (Geomatys)
 */
public interface InternationalPreferenceKey extends InternationalDescription, SimplePreferenceKey {

    /**
     * The name of the key.
     *
     * The purpose of this method is to provide a default implementation of
     * {@link InternationalPreferenceKey#getLabel(java.util.Locale) } and
     * {@link InternationalPreferenceKey#getDescription(java.util.Locale) } for
     * {@link Enum} based implementations. In case the default implementation is
     * overriden, the InternationalPreferenceKey#name() method implementation is
     * free and even posibly useless.
     *
     * @see Enum#name()
     *
     * @return
     */
    String name();

    /**
     *
     * @param locale
     * @return
     */
    @Override
    default String getDescription(final Locale locale) {
        try {
            return ResourceBundle.getBundle(getClass().getName(), locale).getString(name() + '.' + DESCRIPTION_KEY);
        } catch (Exception e) {
            RhomeoCore.LOGGER.log(Level.WARNING, "A bundle key cannot be found !", e);
            return name().concat(" (No traduction available)");
        }
    }

    /**
     *
     * @param locale
     * @return
     */
    @Override
    default String getLabel(final Locale locale) {
        try {
            return ResourceBundle.getBundle(getClass().getName(), locale).getString(name() + '.' + LABEL_KEY);
        } catch (Exception e) {
            RhomeoCore.LOGGER.log(Level.WARNING, "A bundle key cannot be found !", e);
            return name().concat(" (No traduction available)");
        }
    }
}
