# OsResourceType.java

    /*
    ** Module   : OsResourceType.java
    ** Abstract : Enum for OS resource types.
    **
    ** Copyright (c) 2024, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
    ** 001 GBB 20240515 Created initial version.
    ** 002 GBB 20240912 Adding support for types mail, launcher and streams.
    **                  Support for non-configurable null types like DATE.
    */

    /*
     ** 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.util.osresource;

    import com.goldencode.p2j.library.*;
    import com.goldencode.p2j.util.*;

    import java.util.*;

    /** Enum for OS resource types. */
    public enum OsResourceType
    {
       /** The type of the {@link memptr} OS resource. */
       MEMPTR("memptr"),

       /** The type of the {@link NativeInvoker library calls} OS resource. */
       LIBRARY("library"),

       /** The type of the streams OS resource. */
       STREAMS("streams"),

       /** The type of the client socket OS resource. */
       SOCKET("socket"),

       /** The type of the file system OS resource. */
       FILESYSTEM("filesystem"),

       /** The type of the web service OS resource. */
       WEBSERVICE("webservice"),

       /** The type of the environment OS resource. */
       ENVIRONMENTS("environments"),

       /** The type for the mail sender resource. */
       MAIL("mail"),

       /** The type for the launcher resource. */
       LAUNCHER("launcher"),

       /** The type for the time / date OS resource. */
       DATE(null),

       /** A type to enable all OS resources. */
       ALL("all");

       /** OS resource name. */
       private final String name;

       /**
        * Enum constructor.
        *
        * @param   name
        *          OS resource name.
        */
       OsResourceType(String name)
       {
          this.name = name;
       }

       /**
        * Finds and returns the enum value for the resource type or <code>null</code> if nothing matches.
        *
        * @param   resName
        *          The resource name to look for.
        *
        * @return  See above.
        */
       public static OsResourceType find(String resName)
       {
          return Arrays.stream(OsResourceType.values())
                       .filter(resourceType -> resourceType.name != null && resourceType.name.equals(resName))
                       .findAny()
                       .orElse(null);
       }

       /**
        * Getter for {@link #name}.
        *
        * @return  See above.
        */
       public String getName()
       {
          return name;
       }

       /**
        * Returns the string representation of the OS resource type, i.e. the name of the resource.
        *
        * @return  See above.
        */
       @Override
       public String toString()
       {
          return name;
       }
    }