/*
 * [CountryFlag.java]
 *
 * Summary: Country enumeration. Gets references to flags for HTML.
 *
 * Copyright: (c) 2008-2017 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.8+
 *
 * Created with: JetBrains IntelliJ IDEA IDE http://www.jetbrains.com/idea/
 *
 * Version History:
 *  1.1 2008-08-18 added more flags. Created with IntelliJ IDEA.
 */
package com.mindprod.htmlmacros.macro;

import com.mindprod.htmlmacros.support.BuildImage;
import com.mindprod.htmlmacros.support.ImageAlignment;

import java.io.File;

/**
 * Country enumeration. Gets references to flags for HTML.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.1 2008-08-18 added more flags. Created with IntelliJ IDEA.
 * @since 2008
 */
@SuppressWarnings( { "UnusedDeclaration" } )
public enum CountryFlag
    {
        Australia( "Australian" ),
        Brazil( "Brazilian" ),
        Canada( "Canadian" ),
        China( "Chinese" ),
        France( "French" ),
        Germany( "German" ),
        India( "India" ),
        Israel( "Israeli" ),
        Italy( "Italian" ),
        Norway( "Norwegian" ),
        NewZealand( "Kiwi" ),
        Russia( "Russian" ),
        Serbia( "Serbian" ),
        Spain( "Spanish" ),
        Sweden( "Swedish" ),
        UK( "UK" ),
        UN( "UN" ),
        USA( "American" );

    /**
     * e.g. French, German
     */
    private final String adjective;

    /**
     * define an enum constant.
     *
     * @param adjective name of country as an adjective, so can label Canadian flag in alt parm.
     */
    CountryFlag( String adjective )
        {
        this.adjective = adjective;
        }

    /**
     * Get <img... > tag for this country's flag. It is a method of each enum..
     * <p/>
     * the file currently being distributed.
     *
     * @param fileBeingDistributed where this link to a flag will end up
     *
     * @return HTML <img string to display flag
     */
    @SuppressWarnings( { "WeakerAccess" } )
    public String getFlagRef( File fileBeingDistributed )
        {
        final String png = "flag/" + this.toString().toLowerCase() + ".png";
        final String alt = adjective + " flag";
        return BuildImage.buildImgTag( png,
                alt,
                ImageAlignment.none,
                null,
                fileBeingDistributed );
        }
    //    /**
    //     * test driver
    //    //     * @param args not used
    //     */
    //    public static void main( String[] args )
    //        {
    //        System.out
    //                .println( CountryFlag.Canada.getFlagRef( new File(
    //                        "E:/mindprod/jgloss/bookstores.html" ) ) );
    //        }
    }