Flags.java

/*
** Module   : Flags.java
** Abstract : Implementation of the Progress.Reflect.Flags builtin class.
**
** Copyright (c) 2020-2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------------Description---------------------------------------
** 001 ME  20200422 First version.
** 002 ME  20200423 Drop using context local variables for enums, class not registered.
**     GES 20200521 Changes to match final legacy enum approach.
** 003 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
** 004 ME  20211022 Added package protected/private enum members.
**     CA  20220513 Annotated all enum fields, so they can be tracked during conversion, to use the Java name.
*/

/*
 ** 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.CVT_LVL_FULL;
import static com.goldencode.p2j.report.ReportConstants.RT_LVL_FULL;
import static com.goldencode.p2j.util.InternalEntry.Type;

import com.goldencode.p2j.oo.lang.LegacyEnum;
import com.goldencode.p2j.oo.lang.FlagsEnum;

/**
 * Implementation of the Progress.Reflect.Flags builtin class.
 */
@LegacyResource(resource = "Progress.Reflect.Flags")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public final class Flags
extends FlagsEnum
{
   @LegacySignature(type = Type.VARIABLE, name = "Public")
   public static final object<? extends Flags> public_;

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

   @LegacySignature(type = Type.VARIABLE, name = "Private")
   public static final object<? extends Flags> private_;

   @LegacySignature(type = Type.VARIABLE, name = "Static")
   public static final object<? extends Flags> static_;

   @LegacySignature(type = Type.VARIABLE, name = "Instance")
   public static final object<? extends Flags> instance;

   @LegacySignature(type = Type.VARIABLE, name = "DeclaredOnly")
   public static final object<? extends Flags> declaredOnly;
   
   @LegacySignature(type = Type.VARIABLE, name = "Package-Protected")
   public static final object<? extends Flags> packageProtected;
   
   @LegacySignature(type = Type.VARIABLE, name = "Package-Private")
   public static final object<? extends Flags> packagePrivate;
   
   static {
      registerEnum(Flags.class, Flags::new, "Progress.Reflect.Flags");
      
      public_ = createEnum(Flags.class, "Public", 1L);
      protected_ = createEnum(Flags.class, "Protected");
      private_ = createEnum(Flags.class, "Private");
      static_ = createEnum(Flags.class, "Static");
      instance = createEnum(Flags.class, "Instance");
      declaredOnly = createEnum(Flags.class, "DeclaredOnly");
      packageProtected = createEnum(Flags.class, "Package-Protected");
      packagePrivate = createEnum(Flags.class, "Package-Private");
   }
   
   private Flags(String name, long value)
   {
      super(name, value);
   }
   
   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "GetEnum", qualified = "progress.reflect.flags", parameters = 
   {
      @LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public static object<? extends Flags> getEnum(final character enumName)
   {
      return LegacyEnum.getEnum(Flags.class, enumName);
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "GetEnum", qualified = "progress.reflect.flags", parameters = 
   {
      @LegacyParameter(name = "val", type = "INT64", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public static object<? extends Flags> getEnum(final int64 enumValue)
   {
      return LegacyEnum.getEnum(Flags.class, enumValue);
   }
}