ConversionStatus.java

/*
 ** Module   : ConversionStatus.java
 ** Abstract : Conversion Status
 **
 ** Copyright (c) 2023, Golden Code Development Corporation.
 **
 ** -#- -I- --Date-- ----------------------------Description-----------------------------
 ** 001 GBB 20230327 Initial setup
 */
/*
 ** 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.convert;

import com.goldencode.p2j.cfg.*;
import com.goldencode.p2j.util.logging.*;

import java.util.logging.*;

/**
 * Class providing logging in app runtime mode, debugging and IDE integration in conversion mode. Acts as a
 * simple wrapper for CentralLogger in runtime mode. In conversion mode makes requests to the status API to 
 * persist conversion details and allow IDE integration.
 */
public class ConversionStatus
{
   /** Initialization-on-demand holder for ConversionStatus singleton instance. */
   private static class InstanceHolder
   {
      /** ConversionStatus instance. */
      private static final ConversionStatus INSTANCE = new ConversionStatus();
   }

   /** Instance of CentralLogger for the runtime ConversionStatus. */
   private CentralLogger runtimeLogger;

   /** Private constructor for ConversionStatus for conversion. */
   private ConversionStatus()
   {
   }

   /** Private constructor for ConversionStatus for runtime. */
   private ConversionStatus(Class<?> clazz)
   {
      if (clazz.getSimpleName().equals("ExpressionClassLoader"))
      {
         // TODO: check if ExpressionClassLoader poses the issue of recursion due to checking its parent 
         //  levels like the other class loaders and find a permanent solution to the interface
         runtimeLogger = CentralLogger.get(clazz.getName(), false, false);
         return;
      }
      runtimeLogger = CentralLogger.get(clazz);
   }

   /** Static method for getting instance of ConversionStatus. */
   public static ConversionStatus get()
   {
      if (Configuration.isRuntimeConfig())
      {
         throw new IllegalArgumentException(
            "In runtime ConversionStatus get method requires a class argument.");
      }
      return InstanceHolder.INSTANCE;
   }

   /**
    * Static method for getting the instance of ConversionStatus corresponding to the app launch mode.
    * 
    * @param    clazz
    *           The class to be used as logger name.
    *
    * @return   The instance of ConversionStatus corresponding to the app launch mode.
    */
   public static ConversionStatus get(Class<?> clazz)
   {
      return new ConversionStatus(clazz);
      // TODO: replace implementation when conversion mode is implemented
      /*if (Configuration.isRuntimeConfig())
      {
         return new ConversionStatus(clazz);
      }
      return InstanceHolder.INSTANCE;*/
   }

   /**
    * Method that forwards the call to CentralLogger in runtime mode.
    * Conversion mode: TBD.
    * 
    * @param    level
    *           The log record level.
    * @param    msg
    *           The message to be logged.
    */
   public void log(Level level, String msg)
   {
      if (runtimeLogger != null)
      {
         runtimeLogger.log(level, msg);
         return;
      }
      // TBD: conversion mode
   }

   /**
    * Method that forwards the call to CentralLogger in runtime mode.
    * Conversion mode: TBD.
    *
    * @param    level
    *           The log record level.
    * @param    msg
    *           The message to be logged.
    * @param    t
    *           The throwable to be logged.
    */
   public void log(Level level, String msg, Throwable t)
   {
      if (runtimeLogger != null)
      {
         runtimeLogger.log(level, msg, t);
         return;
      }
      // TBD: conversion mode
   }
}