# WebDriverType.java

    /*
     ** Module   : WebDriverType.java
     ** Abstract : Web driver type.
     **
     ** Copyright (c) 2024, Golden Code Development Corporation.
     **
     ** -#- -I- --Date-- ---------------------------------Description---------------------------------
     ** 001 GBB 20240704 Moved from WebDriverHandler inner class.
     */
    /*
     ** 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 may find a copy of the GNU Affero GPL version 3 at the following
     ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
     **
     ** Additional terms under GNU Affero GPL version 3 section 7:
     **
     **   Under Section 7 of the GNU Affero GPL version 3, the following additional
     **   terms apply to the works covered under the License.  These additional terms
     **   are non-permissive additional terms allowed under Section 7 of the GNU
     **   Affero GPL version 3 and may not be removed by you.
     **
     **   0. Attribution Requirement.
     **
     **     You must preserve all legal notices or author attributions in the covered
     **     work or Appropriate Legal Notices displayed by works containing the covered
     **     work.  You may not remove from the covered work any author or developer
     **     credit already included within the covered work.
     **
     **   1. No License To Use Trademarks.
     **
     **     This license does not grant any license or rights to use the trademarks
     **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
     **     of Golden Code Development Corporation. You are not authorized to use the
     **     name Golden Code, FWD, or the names of any author or contributor, for
     **     publicity purposes without written authorization.
     **
     **   2. No Misrepresentation of Affiliation.
     **
     **     You may not represent yourself as Golden Code Development Corporation or FWD.
     **
     **     You may not represent yourself for publicity purposes as associated with
     **     Golden Code Development Corporation, FWD, or any author or contributor to
     **     the covered work, without written authorization.
     **
     **   3. No Misrepresentation of Source or Origin.
     **
     **     You may not represent the covered work as solely your work.  All modified
     **     versions of the covered work must be marked in a reasonable way to make it
     **     clear that the modified work is not originating from Golden Code Development
     **     Corporation or FWD.  All modified versions must contain the notices of
     **     attribution required in this license.
     */

    package com.goldencode.p2j.main;

    /** The web driver type. */
    public enum WebDriverType
    {
       GUI("GUI",
           true,
           WebDriverHandler.TARGET_GUI_ROOT,
           WebDriverHandler.TARGET_GUI_LOGOUT),
       CHUI("ChUI",
            false,
            WebDriverHandler.TARGET_CHUI_ROOT,
            WebDriverHandler.TARGET_CHUI_LOGOUT),
       EMBEDDED("embedded",
                true,
                WebDriverHandler.TARGET_EMBEDDED,
                WebDriverHandler.TARGET_EMBEDDED);

       /** The string representation. */
       private String stringRepresentation;

       /** Flag to indicate if the driver is running in gui mode. */
       private boolean isGui;

       /** Login page target path. */
       private String loginTarget;

       /** Logout page target path. */
       private String logoutTarget;

       /**
        * Package-private constructor.
        *
        * @param    stringRepresentation
        *           The string representation.
        * @param    isGui
        *           Flag to indicate if the driver is running in gui mode.
        * @param    loginTarget
        *           Login page target path.
        * @param    logoutTarget
        *           Logout page target path.
        */
       WebDriverType(String stringRepresentation, boolean isGui, String loginTarget, String logoutTarget)
       {
          this.stringRepresentation = stringRepresentation;
          this.isGui = isGui;
          this.loginTarget = loginTarget;
          this.logoutTarget = logoutTarget;
       }

       /**
        * Returns the string representation.
        *
        * @return   The string representation.
        */
       @Override
       public String toString()
       {
          return stringRepresentation;
       }

       /**
        * Returns {@link #loginTarget}.
        *
        * @return   See above.
        */
       public String getLoginTarget()
       {
          return loginTarget;
       }

       /**
        * Returns {@link #logoutTarget}.
        *
        * @return   See above.
        */
       public String getLogoutTarget()
       {
          return logoutTarget;
       }

       /**
        * Returns {@link #isGui}.
        *
        * @return   See above.
        */
       public boolean isGui()
       {
          return isGui;
       }
    }