LegacyMapEntry.java

/*
** Module   : LegacyMapEntry.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 ME  20200514 First version, stubs taken by converting the skeleton using FWD.
**         20201014 Use different error number for chained reference in equals.
**     
** 002 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                  signature.
** 003 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.util.*;
import com.goldencode.p2j.util.BlockManager.Action;
import com.goldencode.p2j.util.BlockManager.Condition;
import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.oo.core.Assert;
import com.goldencode.p2j.oo.lang._BaseObject_;

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.BlockManager.*;
import static com.goldencode.p2j.util.InternalEntry.Type;

/**
 * Business logic (converted to Java from the 4GL source code
 * in OpenEdge/Core/Collections/MapEntry.cls).
 */
@LegacyResource(resource = "OpenEdge.Core.Collections.MapEntry")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class LegacyMapEntry
extends BaseObject
implements ImapEntry
{
   @LegacySignature(type = Type.PROPERTY, name = "OwningMap")
   private object<? extends Imap> owningMap = TypeFactory.object(Imap.class);

   @LegacySignature(type = Type.PROPERTY, name = "Key")
   private object<? extends _BaseObject_> key = TypeFactory.object(_BaseObject_.class);

   @LegacySignature(type = Type.EXECUTE)
   public void __core_collections_LegacyMapEntry_execute__()
   {
      onBlockLevel(Condition.ERROR, Action.THROW);
   }

   @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Core.Collections.IMap", type = Type.GETTER, name = "OwningMap")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   protected object<? extends Imap> getOwningMap()
   {
      return function(LegacyMapEntry.class, this, "OwningMap", object.class, new Block((Body) () -> 
      {
         returnNormal(owningMap);
      }));
   }

   @LegacySignature(type = Type.SETTER, name = "OwningMap", parameters = 
   {
      @LegacyParameter(qualified = "OpenEdge.Core.Collections.IMap", name = "var", type = "OBJECT", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   protected void setOwningMap(final object<? extends Imap> _var)
   {
      object<? extends Imap> var = TypeFactory.initInput(_var);
      
      internalProcedure(LegacyMapEntry.class, this, "OwningMap", new Block((Body) () -> 
      {
         owningMap.assign(var);
      }));
   }

   @LegacySignature(returns = "OBJECT", qualified = "Progress.Lang.Object", type = Type.GETTER, name = "Key")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public object<? extends _BaseObject_> getKey()
   {
      return function(LegacyMapEntry.class, this, "Key", object.class, new Block((Body) () -> 
      {
         returnNormal(key);
      }));
   }

   @LegacySignature(returns = "OBJECT", qualified = "Progress.Lang.Object", type = Type.GETTER, name = "Value")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public object<? extends _BaseObject_> getValue()
   {
      return function(LegacyMapEntry.class, this, "Value", object.class, new Block((Body) () -> 
      {
         returnNormal(owningMap.ref().get(key));
      }));
   }

   @LegacySignature(type = Type.SETTER, name = "Value", parameters = 
   {
      @LegacyParameter(qualified = "Progress.Lang.Object", name = "var", type = "OBJECT", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setValue(final object<? extends _BaseObject_> _var)
   {
      object<? extends _BaseObject_> var = TypeFactory.initInput(_var);
      
      internalProcedure(LegacyMapEntry.class, this, "Value", new Block((Body) () -> 
      {
         owningMap.ref().put(key, var);
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "p1", type = "OBJECT", qualified = "openedge.core.collections.imap", mode = "INPUT"),
      @LegacyParameter(name = "p2", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_collections_LegacyMapEntry_constructor__(final object<? extends Imap> _p1, final object<? extends _BaseObject_> _p2)
   {
      object<? extends Imap> p1 = TypeFactory.initInput(_p1);
      object<? extends _BaseObject_> p2 = TypeFactory.initInput(_p2);
      
      internalProcedure(LegacyMapEntry.class, this, "__core_collections_LegacyMapEntry_constructor__", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
         
         Assert.notNull(p1, new character("Map"));
         Assert.notNull(p2, new character("Key"));
         
         owningMap.assign(p1);
         key.assign(p2);
      }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "Equals", parameters = 
   {
      @LegacyParameter(name = "p1", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   @Override
   public logical legacyEquals(final object<? extends _BaseObject_> _p1)
   {
      object<? extends _BaseObject_> p1 = TypeFactory.initInput(_p1);
      
      return function(LegacyMapEntry.class, this, "Equals", logical.class, new Block((Body) () -> {
         if (super.legacyEquals(p1).booleanValue())
            returnNormal(true);
         
         if (ObjectOps.typeOf(p1, ImapEntry.class).booleanValue()) {
            ImapEntry other = (ImapEntry) p1.ref();
            object<? extends _BaseObject_> val = getValue();
            
            // chained reference, different error number
            if (key.isUnknown() || val.isUnknown())
               ErrorManager.recordOrThrowError(10068);
               
            returnNormal(key.ref().legacyEquals(other.getKey()).booleanValue() &&
                     val.ref().legacyEquals(other.getValue()).booleanValue());
         }
         
         returnNormal(false);
      }));
   }
}