ValueCollection.java

/*
** Module   : ValueCollection.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.
** 002 CA  20210113 Renamed Iiterator.next to Iiterator.next_, to follow NameConverter's rules.
** 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.util.*;
import com.goldencode.p2j.util.BlockManager.Action;
import com.goldencode.p2j.util.BlockManager.Condition;
import com.goldencode.p2j.oo.core.collections.MapBackedCollection;
import com.goldencode.p2j.oo.lang._BaseObject_;

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

import java.util.Collection;
import java.util.Collections;
import java.util.Map;

/**
 * Business logic (converted to Java from the 4GL source code
 * in OpenEdge/Core/Collections/ValueCollection.cls).
 */
@LegacyResource(resource = "OpenEdge.Core.Collections.ValueCollection")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class ValueCollection extends MapBackedCollection
{
   @LegacySignature(type = Type.EXECUTE)
   public void __core_collections_ValueCollection_execute__()
   {
      onBlockLevel(Condition.ERROR, Action.THROW);
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = {
            @LegacyParameter(name = "p1", type = "OBJECT", qualified = "openedge.core.collections.imap", mode = "INPUT"),
            @LegacyParameter(name = "p2", type = "HANDLE", mode = "INPUT"),
            @LegacyParameter(name = "p3", type = "CHARACTER", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void __core_collections_ValueCollection_constructor__(final object<? extends Imap> _p1,
            final handle _p2, final character _p3)
   {
      object<? extends Imap> p1 = TypeFactory.initInput(_p1);
      handle p2 = TypeFactory.initInput(_p2);
      character p3 = TypeFactory.initInput(_p3);

      internalProcedure(ValueCollection.class, this,
               "__core_collections_ValueCollection_constructor__", new Block((Body) () ->
               {
                  __core_collections_MapBackedCollection_constructor__(p1, p2, p3);
               }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "Contains", parameters = {
            @LegacyParameter(name = "p1", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public logical contains(final object<? extends _BaseObject_> _p1)
   {
      return function(ValueCollection.class, this, "Contains", logical.class,
               new Block((Body) () ->
               {
                  returnNormal(getOwningMap().ref().containsValue(_p1));
               }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "ContainsAll", parameters = {
            @LegacyParameter(name = "p1", type = "OBJECT", qualified = "openedge.core.collections.icollection", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public logical containsAll(final object<? extends Icollection> _p1)
   {
      return function(ValueCollection.class, this, "ContainsAll", logical.class,
               new Block((Body) () ->
               {
                  returnNormal(getOwningMap().ref().containsAllValues(_p1));
               }));
   }

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

      return function(ValueCollection.class, this, "Remove", logical.class, new Block((Body) () ->
      {
         Map<object<? extends _BaseObject_>, object<? extends _BaseObject_>> objects = getMap();

         if (objects != null)
         {
            returnNormal(objects.values().remove(_p1));
         }
         // the 4GL implementation
         else
         {
            Iiterator it = getOwningMap().ref().getKeySet().ref().iterator().ref();

            while (it.hasNext().booleanValue())
            {
               object<? extends _BaseObject_> key = it.next_();
               object<? extends _BaseObject_> val = getOwningMap().ref().get(key);

               if (p1.ref().legacyEquals(val).booleanValue())
               {
                  getOwningMap().ref().remove(key);
                  returnNormal(true);
               }
            }
         }
         returnNormal(false);
      }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "RemoveAll", parameters = {
            @LegacyParameter(name = "p1", type = "OBJECT", qualified = "openedge.core.collections.icollection", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public logical removeAll(final object<? extends Icollection> _p1)
   {
      object<? extends Icollection> p1 = TypeFactory.initInput(_p1);

      return function(ValueCollection.class, this, "RemoveAll", logical.class,
               new Block((Body) () ->
               {
                  Collection<object<? extends _BaseObject_>> objects = getCollection();

                  if (objects != Collections.EMPTY_LIST)
                  {
                     returnNormal(objects.removeIf((object<? extends _BaseObject_> o) -> (p1.ref()
                              .contains(o).booleanValue())));
                  }
                  // the 4GL implementation
                  else
                  {
                     boolean lAny = false;

                     Iiterator it = getOwningMap().ref().getKeySet().ref().iterator().ref();

                     while (it.hasNext().booleanValue())
                     {
                        object<? extends _BaseObject_> key = it.next_();
                        object<? extends _BaseObject_> val = getOwningMap().ref().get(key);

                        if (p1.ref().contains(val).booleanValue())
                        {
                           getOwningMap().ref().remove(key);
                           lAny = lAny || true;
                        }
                     }

                     returnNormal(lAny);
                  }
               }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "RetainAll", parameters = {
            @LegacyParameter(name = "p1", type = "OBJECT", qualified = "openedge.core.collections.icollection", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public logical retainAll(final object<? extends Icollection> _p1)
   {
      object<? extends Icollection> p1 = TypeFactory.initInput(_p1);

      return function(ValueCollection.class, this, "RetainAll", logical.class,
               new Block((Body) () ->
               {
                  Collection<object<? extends _BaseObject_>> objects = getCollection();

                  if (objects != Collections.EMPTY_LIST)
                  {
                     returnNormal(objects.removeIf((object<? extends _BaseObject_> o) -> (!p1
                              .ref().contains(o).booleanValue())));
                  }
                  // the 4GL implementation
                  else
                  {
                     boolean lAny = false;

                     Iiterator it = getOwningMap().ref().getKeySet().ref().iterator().ref();

                     while (it.hasNext().booleanValue())
                     {
                        object<? extends _BaseObject_> key = it.next_();
                        object<? extends _BaseObject_> val = getOwningMap().ref().get(key);

                        if (!p1.ref().contains(val).booleanValue())
                        {
                           getOwningMap().ref().remove(key);
                           lAny = lAny || true;
                        }
                     }

                     returnNormal(lAny);
                  }
               }));
   }
}