AccessMode.java

/*
** Module   : AccessMode.java
** Abstract : Implementation of the Progress.Reflect.AccessMode builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------------Description---------------------------------------
** 001 CA  20190924 First version.
**     RFB 20191022 Added LegacyResource annotation
** 002 CA  20191024 Added method support levels and updated the class support level.
** 003 ME  20200422 Convert to Enum.
** 004 ME  20200423 Drop using context local variables for enums, class not registered.
** 005 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                  signature.
** 006 ME  20211022 Added package protected/private enum members.
** 007 ME  20230716 Added method to convert java to 4GL access mode.
*/

/*
** 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 com.goldencode.p2j.oo.lang.LegacyEnum;

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

import java.lang.reflect.Modifier;

/**
 * Business logic (converted to Java from the 4GL source code
 * in Progress/Reflect/AccessMode.cls).
 */
@LegacyResource(resource = "Progress.Reflect.AccessMode")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public final class AccessMode
extends LegacyEnum
{
   @LegacySignature(type = Type.VARIABLE, name = "Public")
   public static final object<? extends AccessMode> public_;

   @LegacySignature(type = Type.VARIABLE, name = "Protected")
   public static final object<? extends AccessMode> protected_;

   @LegacySignature(type = Type.VARIABLE, name = "Private")
   public static final object<? extends AccessMode> private_;
   
   @LegacySignature(type = Type.VARIABLE, name = "Package-Protected")
   public static final object<? extends AccessMode> packageProtected;
   
   @LegacySignature(type = Type.VARIABLE, name = "Package-Private")
   public static final object<? extends AccessMode> packagePrivate;
   
   static
   {
      registerEnum(AccessMode.class, AccessMode::new, "Progress.Reflect.AccessMode");
      
      public_ = createEnum(AccessMode.class, "Public");
      protected_ = createEnum(AccessMode.class, "Protected");
      private_ = createEnum(AccessMode.class, "Private");
      packageProtected = createEnum(AccessMode.class, "Package-Protected");
      packagePrivate = createEnum(AccessMode.class, "Package-Private");
   }
   
   private AccessMode(String name, long value)
   {
      super(name, value);
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "GetEnum", qualified = "Progress.Reflect.AccessMode", parameters =
   {
      @LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public static object<? extends AccessMode> getEnum(final character enumName)
   {
      return LegacyEnum.getEnum(AccessMode.class, enumName);
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "GetEnum", qualified = "Progress.Reflect.AccessMode", parameters =
   {
      @LegacyParameter(name = "val", type = "INT64", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public static object<? extends AccessMode> getEnum(final int64 enumValue)
   {
      return LegacyEnum.getEnum(AccessMode.class, enumValue);
   }
   
   /**
    * Map java method modifiers to 4GL AccessMode.
    * 
    * @param    mod the Java method modifiers.
    * 
    * @return   the corresponding 4GL access mode
    */
   public static object<? extends AccessMode> getEnum(final int mod) 
   {
      if (Modifier.isPublic(mod))
      {
         return public_;
      } 
      
      if (Modifier.isPrivate(mod))
      {
         return private_;
      }
      
      if (Modifier.isProtected(mod))
      {
         return protected_;
      }
      
      return packageProtected;
  }
}