Event.java

/*
** Module   : Event.java
** Abstract : Implementation of the Progress.Reflect.Event builtin class.
**
** Copyright (c) 2020-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------------Description---------------------------------------
** 001 ME  20200422 First version.
** 002 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                  signature.
** 003 ME  20230829 Mark the object as not tracked/internal, remove default 4GL ctor.
** 004 CA  20231130 Do not use 'TypeFactory.object' in cases where the skeleton class is not instantiated via
**                  ObjectOps (like the reflection classes), as this will force pending ObjectOps scopeable 
**                  registration, which never gets executed, as the legacy constructors are not used.
*/

/*
** 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.oo.reflect;

import com.goldencode.p2j.util.*;

import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.*;
import static com.goldencode.p2j.util.InternalEntry.Type;

import com.goldencode.p2j.oo.lang.LegacyClass;

/**
 * Implementation of the Progress.Reflect.Event builtin class.
 */
@LegacyResource(resource = "Progress.Reflect.Event")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_PARTIAL)
public class Event
extends com.goldencode.p2j.oo.lang.BaseObject
{
   private object<? extends AccessMode> accessMode = new object<>(AccessMode.class);

   private object<? extends LegacyClass> declaringClass = new object<>(LegacyClass.class);

   private logical isAbstract = TypeFactory.logical();

   private logical isOverride = TypeFactory.logical();

   private logical isStatic = TypeFactory.logical();

   private character name = TypeFactory.character();

   private integer numHandlerParameters = TypeFactory.integer();

   private object<? extends LegacyClass> originatingClass = new object<>(LegacyClass.class);

   @LegacySignature(returns = "OBJECT", qualified = "Progress.Reflect.AccessMode", type = Type.GETTER, name = "AccessMode")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public object<? extends AccessMode> getAccessMode()
   {
      return function(Event.class, this, "AccessMode", object.class, new Block((Body) () -> 
      {
         returnNormal(accessMode);
      }));
   }

   @LegacySignature(returns = "OBJECT", qualified = "Progress.Lang.Class", type = Type.GETTER, name = "DeclaringClass")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public object<? extends LegacyClass> getDeclaringClass()
   {
      return function(Event.class, this, "DeclaringClass", object.class, new Block((Body) () -> 
      {
         returnNormal(declaringClass);
      }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.GETTER, name = "IsAbstract")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public logical getIsAbstract()
   {
      return function(Event.class, this, "IsAbstract", logical.class, new Block((Body) () -> 
      {
         returnNormal(isAbstract);
      }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.GETTER, name = "IsOverride")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public logical getIsOverride()
   {
      return function(Event.class, this, "IsOverride", logical.class, new Block((Body) () -> 
      {
         returnNormal(isOverride);
      }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.GETTER, name = "IsStatic")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public logical getIsStatic()
   {
      return function(Event.class, this, "IsStatic", logical.class, new Block((Body) () -> 
      {
         returnNormal(isStatic);
      }));
   }

   @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "Name")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public character getName()
   {
      return function(Event.class, this, "Name", character.class, new Block((Body) () -> 
      {
         returnNormal(name);
      }));
   }

   @LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "NumHandlerParameters")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public integer getNumHandlerParameters()
   {
      return function(Event.class, this, "NumHandlerParameters", integer.class, new Block((Body) () -> 
      {
         returnNormal(numHandlerParameters);
      }));
   }

   @LegacySignature(returns = "OBJECT", qualified = "Progress.Lang.Class", type = Type.GETTER, name = "OriginatingClass")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public object<? extends LegacyClass> getOriginatingClass()
   {
      return function(Event.class, this, "OriginatingClass", object.class, new Block((Body) () -> 
      {
         returnNormal(originatingClass);
      }));
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "GetHandlerParameters", extent = -1, qualified = "progress.reflect.parameter")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public object<? extends Parameter>[] getHandlerParameters()
   {
      return extentFunction(Event.class, this, "GetHandlerParameters", object.class, new Block());
   }
   
   /**
    * Reports if the given instance is managed as part of the legacy 4GL object life cycle. This
    * includes reference counting, linking in the SESSION object chain, managed construction and
    * destruction.
    *
    * @return   Always {@code false} for 4GL internals (class/reflection).
    */
   @Override
   public boolean isTracked()
   {
      return false;
   }
}