# StringKeyedMap.java

    /*
    ** Module   : StringKeyedMap.java
    ** Abstract : Implementation of the builtin class.
    **
    ** Copyright (c) 2019-2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- -------------------------------Description--------------------------------
    ** 001 IAS 20190923 First version
    ** 002 ME  20200519 Complete implementation as of OE 11.7.4.
    ** 003 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
    **                  signature.
    ** 004 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
    **                  dropped if is a no-op.
    */

    /*
    ** 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.core.collections;

    import com.goldencode.p2j.oo.core.*;
    import com.goldencode.p2j.oo.lang.*;
    import com.goldencode.p2j.util.*;
    import com.goldencode.p2j.util.BlockManager.Action;
    import com.goldencode.p2j.util.BlockManager.Condition;
    import com.goldencode.p2j.util.InternalEntry.Type;

    import static com.goldencode.p2j.report.ReportConstants.*;
    import static com.goldencode.p2j.util.BlockManager.externalProcedure;
    import static com.goldencode.p2j.util.BlockManager.function;
    import static com.goldencode.p2j.util.BlockManager.internalProcedure;
    import static com.goldencode.p2j.util.BlockManager.onBlockLevel;
    import static com.goldencode.p2j.util.BlockManager.returnNormal;

    /**
     *
     * A map containing String keys and String values.
     *
     */
    @LegacyResource(resource = "OpenEdge.Core.Collections.StringKeyedMap")
    @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
    public class StringKeyedMap extends LegacyMap implements IStringKeyedMap
    {
       @LegacySignature(type = Type.EXECUTE)
       public void __core_collections_StringKeyedMap_execute__()
       {
          onBlockLevel(Condition.ERROR, Action.THROW);
       }

       @LegacySignature(type = Type.CONSTRUCTOR)
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public void __core_collections_StringKeyedMap_constructor__()
       {
          internalProcedure(StringKeyedMap.class, this,
                   "__core_collections_StringKeyedMap_constructor__", new Block((Body) () -> {
                      __core_collections_LegacyMap_constructor__();
                   }));
       }

       @LegacySignature(type = Type.CONSTRUCTOR, parameters = {
                @LegacyParameter(name = "p1", type = "OBJECT", qualified = "openedge.core.collections.istringkeyedmap", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public void __core_collections_StringKeyedMap_constructor__(
                final object<? extends IStringKeyedMap> _p1)
       {
          internalProcedure(StringKeyedMap.class, this,
                   "__core_collections_StringKeyedMap_constructor__", new Block((Body) () -> {
                      __core_collections_LegacyMap_constructor__(_p1);
                   }));
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "ContainsKey", parameters = {
                @LegacyParameter(name = "pcKey", type = "CHARACTER", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public logical containsKey(final character _pcKey)
       {
          character pcKey = TypeFactory.initInput(_pcKey);

          return function(StringKeyedMap.class, this, "ContainsKey", logical.class,
                   new Block((Body) () -> {
                      object<LegacyString> key = ObjectOps.newInstance(LegacyString.class, "I",
                               pcKey);

                      returnNormal(super.containsKey(key));
                   }));
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "ContainsKey", parameters = {
                @LegacyParameter(name = "poKey", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       @Override
       public logical containsKey(final object<? extends _BaseObject_> _poKey)
       {
          object<? extends _BaseObject_> poKey = TypeFactory.initInput(_poKey);

          return function(StringKeyedMap.class, this, "ContainsKey", logical.class,
                   new Block((Body) () -> {
                      Assert.isType(poKey, ObjectOps.getLegacyClass(LegacyString.class));

                      returnNormal(super.containsKey(poKey));
                   }));
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "ContainsKey", parameters = {
                @LegacyParameter(name = "poKey", type = "OBJECT", qualified = "openedge.core.string", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public logical containsKey_1(
                final object<? extends com.goldencode.p2j.oo.core.LegacyString> _poKey)
       {
          object<? extends _BaseObject_> poKey = TypeFactory.initInput(_poKey);

          return function(StringKeyedMap.class, this, "ContainsKey", logical.class,
                   new Block((Body) () -> {
                      returnNormal(super.containsKey(poKey));
                   }));
       }

       @LegacySignature(returns = "OBJECT", qualified = "Progress.Lang.Object", type = Type.METHOD, name = "Get", parameters = {
                @LegacyParameter(name = "pcKey", type = "CHARACTER", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public object<? extends _BaseObject_> get(character _pcKey)
       {
          character pcKey = TypeFactory.initInput(_pcKey);

          return function(StringKeyedMap.class, this, "Get", object.class, new Block((Body) () -> {
             object<LegacyString> key = ObjectOps.newInstance(LegacyString.class, "I", pcKey);

             returnNormal(super.get(key));
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Get", qualified = "openedge.core.string", parameters = {
                @LegacyParameter(name = "poKey", type = "OBJECT", qualified = "openedge.core.string", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public object<? extends com.goldencode.p2j.oo.core.LegacyString> get_1(
                final object<? extends com.goldencode.p2j.oo.core.LegacyString> _poKey)
       {

          object<? extends _BaseObject_> poKey = TypeFactory.initInput(_poKey);

          return function(StringKeyedMap.class, this, "Get", object.class, new Block((Body) () -> {
             returnNormal(super.get(poKey));
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Get", qualified = "openedge.core.string", parameters = {
                @LegacyParameter(name = "poKey", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       @Override
       public object<? extends com.goldencode.p2j.oo.core.LegacyString> get(
                final object<? extends com.goldencode.p2j.oo.lang._BaseObject_> _poKey)
       {
          object<? extends _BaseObject_> poKey = TypeFactory.initInput(_poKey);

          return function(StringKeyedMap.class, this, "Get", object.class, new Block((Body) () -> {
             Assert.isType(poKey, ObjectOps.getLegacyClass(LegacyString.class));

             returnNormal(super.get(poKey));
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Put", qualified = "openedge.core.string", parameters = {
                @LegacyParameter(name = "pcKey", type = "CHARACTER", mode = "INPUT"),
                @LegacyParameter(name = "poValue", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public object<? extends com.goldencode.p2j.oo.core.LegacyString> put_2(final character _pcKey,
                final object<? extends com.goldencode.p2j.oo.lang._BaseObject_> _poValue)
       {
          character pcKey = TypeFactory.initInput(_pcKey);
          object<? extends _BaseObject_> poValue = TypeFactory.initInput(_poValue);

          return function(StringKeyedMap.class, this, "Put", object.class, new Block((Body) () -> {
             object<LegacyString> key = ObjectOps.newInstance(LegacyString.class, "I", pcKey);

             returnNormal(super.put(key, poValue));
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Put", qualified = "progress.lang.object", parameters = {
                @LegacyParameter(name = "poKey", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT"),
                @LegacyParameter(name = "poValue", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       @Override
       public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> put(
                final object<? extends _BaseObject_> _poKey,
                final object<? extends _BaseObject_> _poValue)
       {
          object<? extends _BaseObject_> poKey = TypeFactory.initInput(_poKey);
          object<? extends _BaseObject_> poValue = TypeFactory.initInput(_poValue);

          return function(StringKeyedMap.class, this, "Put", object.class, new Block((Body) () -> {
             Assert.isType(poKey, ObjectOps.getLegacyClass(LegacyString.class));

             returnNormal(super.put(poKey, poValue));
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Put", qualified = "progress.lang.object", parameters = {
                @LegacyParameter(name = "poKey", type = "OBJECT", qualified = "openedge.core.string", mode = "INPUT"),
                @LegacyParameter(name = "poValue", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> put_1(
                final object<? extends LegacyString> _poKey,
                final object<? extends _BaseObject_> _poValue)
       {
          object<? extends LegacyString> poKey = TypeFactory.initInput(_poKey);
          object<? extends _BaseObject_> poValue = TypeFactory.initInput(_poValue);

          return function(StringKeyedMap.class, this, "Put", object.class, new Block((Body) () -> {
             returnNormal(super.put(poKey, poValue));
          }));
       }

       @LegacySignature(type = Type.METHOD, name = "PutAll", parameters = {
                @LegacyParameter(name = "poMap", type = "OBJECT", qualified = "openedge.core.collections.imap", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       @Override
       public void putAll(final object<? extends Imap> _poMap)
       {
          object<? extends Imap> poMap = TypeFactory.initInput(_poMap);

          internalProcedure(StringKeyedMap.class, this, "PutAll", new Block((Body) () -> {
             Assert.isType(poMap, ObjectOps.getLegacyClass(IStringKeyedMap.class));

             super.putAll(poMap);
          }));
       }

       @LegacySignature(type = Type.METHOD, name = "PutAll", parameters = {
                @LegacyParameter(name = "poMap", type = "OBJECT", qualified = "openedge.core.collections.istringkeyedmap", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public void putAll_1(final object<? extends IStringKeyedMap> _poMap)
       {
          object<? extends IStringKeyedMap> poMap = TypeFactory.initInput(_poMap);

          internalProcedure(StringKeyedMap.class, this, "PutAll", new Block((Body) () -> {
             super.putAll(poMap);
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Remove", qualified = "progress.lang.object", parameters = {
                @LegacyParameter(name = "pcKey", type = "CHARACTER", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> remove(final character _pcKey)
       {
          character pcKey = TypeFactory.initInput(_pcKey);

          return function(StringKeyedMap.class, this, "Remove", object.class, new Block((Body) () -> {
             object<LegacyString> key = ObjectOps.newInstance(LegacyString.class, "I", pcKey);

             returnNormal(super.remove(key));
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Remove", qualified = "progress.lang.object", parameters = {
                @LegacyParameter(name = "poKey", type = "OBJECT", qualified = "openedge.core.string", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> remove_1(
                final object<? extends LegacyString> _poKey)
       {
          object<? extends LegacyString> poKey = TypeFactory.initInput(_poKey);

          return function(StringKeyedMap.class, this, "Remove", object.class, new Block((Body) () -> {
             returnNormal(super.remove(poKey));
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Remove", qualified = "progress.lang.object", parameters = {
                @LegacyParameter(name = "poKey", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       @Override
       public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> remove(
                final object<? extends _BaseObject_> _poKey)
       {
          object<? extends _BaseObject_> poKey = TypeFactory.initInput(_poKey);

          return function(StringKeyedMap.class, this, "Remove", object.class, new Block((Body) () -> {
             Assert.isType(poKey, ObjectOps.getLegacyClass(LegacyString.class));

             returnNormal(super.remove(poKey));
          }));
       }

    }