LoggingEntryType.java

/*
** Module   : LoggingEntryType.java
** Abstract : Enumeration to list all currently supported logging entry types.
**
** Copyright (c) 2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 GBB 20250331 Initial version.
*/
/*
** 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;

import java.util.*;
import java.util.stream.*;

/** Enumeration to list all currently supported logging entry types. */
public enum LoggingEntryType
{
   /** Needs to be explicitly defined only for ABL GUI and character modes */ 
   Messages("4GLMessages"),
   
   /** Valid for ABL clients, AppServer, and WebSpeed agents */
   Trace("4GLTrace"),
   
   /** Valid for ABL clients, AppServer, and WebSpeed agents */
   QryInfo("QryInfo"),
   
   /** Valid for AppServer agents. Same as ASPlumbing + DB.Connects */
   ASDefault("ASDefault"),
   
   /** Valid for AppServer agents */
   ASPlumbing("ASPlumbing"),
   
   /** Valid for ABL clients, AppServer, and WebSpeed agents */
   DB_Connects("DB.Connects"),

   /** Valid for AppServer brokers */
   UBroker_BASIC("uBroker.basic");

   /** Collection of all the names of the supported entry types. */
   private static final List<String> NAMES = Arrays.stream(values())
                                                   .map(LoggingEntryType::getName)
                                                   .collect(Collectors.toList());

   /**
    * Finds the entry type constant that matches the provided 4GL name.
    *
    * @param    typeName
    *           A 4GL entry type name.
    *
    * @return   The entry type constant.
    */
   public static LoggingEntryType get(String typeName)
   {
      if (typeName.equals("DB.*"))
      {
         return LoggingEntryType.DB_Connects;
      }
      return Arrays.stream(values())
                   .filter(type -> type.getName().equalsIgnoreCase(typeName))
                   .findAny()
                   .orElse(null);
   }

   /**
    * Returns a {@link List} of all currently supported entry type names as strings.
    *
    * @return   See above.
    */
   public static List<String> get4GLNames()
   {
      return NAMES;
   }

   /** The string representation of the supported entry type. */
   private final String name;

   /**
    /**
    * Package-private constructor for enum SupportedEntryType.
    *
    * @param   name
    *          The string representation of the supported entry type.
    */
   LoggingEntryType(String name)
   {
      this.name = name;
   }

   /**
    * Returns the 4GL name of the supported entry type.
    *
    * @return   The 4GL name of the supported entry type.
    */
   public String getName()
   {
      return name;
   }

   /**
    * Returns the string representation of the supported entry type.
    * That is the 4GL name.
    *
    * @return   The string representation of the supported entry type.
    */
   public String toString()
   {
      return name;
   }
}