/*
 * [OS.java]
 *
 * Summary: enum of possible Windows OSes.
 *
 * Copyright: (c) 2009-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.8 2009-02-06 include go package in ZIP bundle.
 *                 military.
 */
package com.mindprod.htmlmacros.support;

import com.mindprod.fastcat.FastCat;

import java.util.EnumSet;

import static java.lang.System.*;

/**
 * enum of possible Windows OSes.
 * <p/>
 * DO NOT SORT. THE ENUM ORDER IS SIGNIFICANT!!
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.8 2009-02-06 include go package in ZIP bundle.
 * @since 2009
 */
@SuppressWarnings( { "EnumeratedClassNamingConvention", "UnusedDeclaration", "WeakerAccess" } )
public enum OS
    {
    // in order by release date/power
    //  MUST USE ENUM NAMES (CASE INSENSITIVE) IN  <!-- macro OSes. DISPLAY IS shortname, NOT NAME FOR OSse MACRO
        /**
         * MS DOS
         */
        DOS( "DOS", "DOS" ),
        /**
         * Windows 3.1, "W31" is enum name, the name in OSes macro. "W3.1" is short display,
         * "Windows 3.1" is long display
         */
        W31( "W3.1", "Windows 3.1" ),
        /**
         * ibm os/2
         */
        OS2( "OS2", "OS/2" ),
        /**
         * Windows 95 W95 is enum name, the name in OSes macro. W95 is short display, Windows 95 is long display.
         */
        W95( "W95", "Windows 95" ),
        /**
         * Windows 98
         */
        W98( "W98", "Windows 98" ),
        /**
         * Windows Me
         */
        ME( "Me", "Windows Me" ),
        /**
         * Windows NT
         */
        NT( "NT", "Windows NT" ),
        /**
         * Windows 2000
         */
        W2K( "W2K", "Windows 2000" ),
        /**
         * Windows XP
         */
        XP( "XP", "Windows XP" ),
        /**
         * Windows 2003
         */
        W2K3( "W2003", "Windows 2003" ),
        /**
         * Windows Vista
         */
        VISTA( "Vista", "Windows Vista" ),
        /**
         * Windows Server 2008
         */
        W2K8( "W2008", "Windows Server 2008" ),
        /**
         * Windows 7  32-bit
         */
        W732( "W7-32", "Windows 7 32-bit" ),
        /**
         * Windows 7  32-bit
         */
        W764( "W7-64", "Windows 7 64-bit" ),
        /**
         * Windows 8  32-bit
         */
        W832( "W8-32", "Windows 8 32-bit" ),
        /**
         * Windows 8  64-bit
         */
        W864( "W8-64", "Windows 8 64-bit" ),
        /**
         * Windows 8 server
         */
        W2012( "W2012", "Windows 2012 server" ),
        /**
         * Windows 10  32-bit
         */
        W1032( "W10-32", "Windows 10 32-bit" ),
        /*
         * Windows 10  64-bit
         */
        W1064( "W10-64", "Windows 10 64-bit" ),
        /**
         * Linux
         */
        LINUX( "Linux", "Linux" ),
        /**
         * Linux
         */
        LINUXARM( "LinuxARM", "Linux ARM" ),
        /**
         * Linux
         */
        LINUXX86( "LinuxX86", "Linux X86" ),
        /**
         * Linux
         */
        LINUXX64( "LinuxX64", "Linux X64" ),
        /**
         * Ubuntu
         */
        UBUNTU( "Ubuntu", "Ubuntu" ),
        /**
         * Solaris
         */
        SOLARIS( "Solaris", "Solaris" ),
        /**
         * Solaris
         */
        SOLARISSPARC( "SolarisSPARC", "Solaris SPARC" ),
        /**
         * Solaris
         */
        SOLARISSPARC64( "SolarisSPARC64", "Solaris SPARC64" ),
        /**
         * Solaris
         */
        SOLARISX86( "SolarisX86", "Solaris X86" ),
        /**
         * Solaris
         */
        SOLARISX64( "SolarisX64", "Solaris X64" ),
        /**
         * Mac OS/9
         */
        OS9( "OS9", "classic MacIntosh OS/9" ),
        /**
         * Mac OS X
         */
        OSX( "OSX", "MacIntosh OS X" );

    // mountain lion, Intel Mac
    private static final boolean DEBUGGING = false;

    private final String longName;

    private final String shortName;

    /**
     * Enum constant constructor that captures two extra facts about the enum.
     *
     * @param shortName name for the os e.g. Me
     * @param longName  name of the OS e.g. "Windows XP"
     */
    OS( String shortName, String longName )
        {
        this.shortName = shortName;
        this.longName = longName;
        }

    /**
     * Static method to construct a string mentioning multiple OSes, by slashes.
     *
     * @param choices EnumSet of just the oses you want included
     *
     * @return a String of the form "W2K/Vista"
     */
    public static String andList( EnumSet<OS> choices )
        {
        if ( choices.size() == 0 )
            {
            return "";
            }
        final FastCat sb = new FastCat( choices.size() );
        for ( OS o : choices )
            {
            sb.append( o.shortName );
            }
        return sb.toAndList();
        }

    /**
     * TEST harness
     *
     * @param args not used
     */
    @SuppressWarnings( { "UnusedParameters" } )
    public static void main( String[] args )
        {
        if ( DEBUGGING )
            {
            // You don't use a constructor to create EnumSet objects.
            EnumSet<OS> justThese = EnumSet.of( W2K, XP, ME );
            // prints "Me/W2K/XP"
            // note they come out in proper order.
            out.println( OS.andList( justThese ) );
            }
        }

    /**
     * @return long name
     */
    public String getLongName()
        {
        return this.longName;
        }

    /**
     * @return short name
     */
    public String getShortName()
        {
        return this.shortName;
        }
    }