# ParameterMode.java

    /*
    ** Module   : ParameterMode.java
    ** Abstract : Implementation of the Progress.Reflect.ParameterMode builtin class.
    **
    ** Copyright (c) 2020-2023, 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.
    ** 003 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
    **     CA  20220513 Annotated all enum fields, so they can be tracked during conversion, to use the Java name.
    ** 004 CA  20230215 Sanitized the LegacySignature parameters, so their type match their Java method definition.
    */

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

    import com.goldencode.p2j.oo.lang.LegacyEnum;
    import com.goldencode.p2j.oo.lang.FlagsEnum;
    import com.goldencode.p2j.util.InternalEntry.Type;
    import com.goldencode.p2j.util.LegacyParameter;
    import com.goldencode.p2j.util.LegacyResource;
    import com.goldencode.p2j.util.LegacyResourceSupport;
    import com.goldencode.p2j.util.LegacySignature;
    import com.goldencode.p2j.util.character;
    import com.goldencode.p2j.util.int64;
    import com.goldencode.p2j.util.object;

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

       @LegacySignature(type = Type.VARIABLE, name = "Output")
       public static final object<? extends ParameterMode> output;

       @LegacySignature(type = Type.VARIABLE, name = "InputOutput")
       public static final object<? extends ParameterMode> inputOutput;

       @LegacySignature(type = Type.VARIABLE, name = "Append")
       public static final object<? extends ParameterMode> append;

       @LegacySignature(type = Type.VARIABLE, name = "Bind")
       public static final object<? extends ParameterMode> bind;

       static {
          registerEnum(ParameterMode.class, ParameterMode::new, "Progress.Reflect.ParameterMode");

          input = createEnum(ParameterMode.class, "Input", 1l);
          output = createEnum(ParameterMode.class, "Output", 2l);
          inputOutput = createEnum(ParameterMode.class, "InputOutput", 3l);
          append = createEnum(ParameterMode.class, "Append");
          bind = createEnum(ParameterMode.class, "Bind");
       }

       private ParameterMode(String name, long value)
       {
          super(name, value);
       }

       /**
        * Resolve the enum from the given name.
        *
        * @param enumName The enum name.
        *
        */
       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "GetEnum", qualified = "progress.reflect.parametermode", parameters = {
                @LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static object<? extends ParameterMode> getEnum(final character enumName)
       {
          return LegacyEnum.getEnum(ParameterMode.class, enumName);
       }

       /**
        * Resolve the enum from the given name.
        *
        * @param enumValue The enum value.
        *
        */
       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "GetEnum", qualified = "progress.reflect.parametermode", parameters = {
                @LegacyParameter(name = "value", type = "INT64", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static object<? extends ParameterMode> getEnum(final int64 enumValue)
       {
          return LegacyEnum.getEnum(ParameterMode.class, enumValue);
       }
    }