# EntrySet.java

    /*
    ** Module   : EntrySet.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.
    **         20201120 Fix remove method return value, removeAll implementation is different
    **                  https://proj.goldencode.com/issues/5010.
    ** 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.core.collections.Iset;
    import com.goldencode.p2j.oo.lang._BaseObject_;
    import com.goldencode.p2j.oo.core.Assert;

    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.Collections;

    /**
     * Business logic (converted to Java from the 4GL source code
     * in OpenEdge/Core/Collections/EntrySet.cls).
     */
    @LegacyResource(resource = "OpenEdge.Core.Collections.EntrySet")
    @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
    public class EntrySet extends MapBackedCollection implements Iset
    {
       @LegacySignature(type = Type.EXECUTE)
       public void __core_collections_EntrySet_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_EntrySet_constructor__(final object<? extends Imap> _p1,
                final handle _p2, final character _p3)
       {
          internalProcedure(EntrySet.class, this, "__core_collections_EntrySet_constructor__",
                   new Block((Body) () ->
                   {
                      __core_collections_MapBackedCollection_constructor__(_p1, _p2, _p3);
                   }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Iterator", qualified = "openedge.core.collections.iiterator")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       @Override
       public object<? extends com.goldencode.p2j.oo.core.collections.Iiterator> iterator()
       {
          return function(EntrySet.class, this, "Iterator", object.class, new Block((Body) () ->
          {
             if (getMap() != Collections.EMPTY_MAP)
             {
                returnNormal(ObjectOps.newInstance(EntrySetIterator.class, "IIII", getOwningMap(),
                         new object(this), new handle(new TransparentWrapper(getCollection())), ""));
             }
             else
             {
                returnNormal(ObjectOps.newInstance(EntrySetIterator.class, "IIII", getOwningMap(),
                         new object(this), getOwningBuffer(), getKeyField().unwrap().name()));
             }
          }));
       }

       @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)
       {
          object<? extends _BaseObject_> p1 = TypeFactory.initInput(_p1);

          return function(EntrySet.class, this, "Contains", logical.class, new Block((Body) () ->
          {
             Assert.isType(p1, ObjectOps.getLegacyClass(ImapEntry.class));

             returnNormal(getOwningMap().ref().containsKey(((ImapEntry) p1.ref()).getKey()));
          }));
       }

       @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)
       {
          object<? extends Icollection> p1 = TypeFactory.initInput(_p1);

          return function(EntrySet.class, this, "ContainsAll", logical.class, new Block((Body) () ->
          {
             Assert.notNull(p1, new character("Check collection"));

             if (p1.ref().isEmpty().booleanValue())
                returnNormal(true);

             // 4GL implementation does not consider a collection to potentially contain the same object multiple times (set)
             if (p1.ref().getSize().intValue() > getSize().intValue())
                returnNormal(false);

             Iiterator it = p1.ref().iterator().ref();

             while (it.hasNext().booleanValue())
             {
                if (!contains(it.next_()).booleanValue())
                   returnNormal(false);
             }

             returnNormal(true);
          }));
       }

       @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(EntrySet.class, this, "Remove", logical.class, new Block((Body) () ->
          {
             Assert.isType(p1, ObjectOps.getLegacyClass(ImapEntry.class));

             object<? extends _BaseObject_> removed = getOwningMap().ref().remove(((ImapEntry) p1.ref()).getKey());

             returnNormal(!removed.isUnknown());
          }));
       }

       @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(EntrySet.class, this, "RemoveAll", logical.class, new Block((Body) () ->
          {
             // no check for null on 4GL implementation

             Iiterator it = p1.ref().iterator().ref();

             while (it.hasNext().booleanValue())
             {
                // there seems to be a bug in 4GL, only if entry is found and key equals value it is removed
                remove(it.next_());
             }

             // 4GL always seems to return false
             returnNormal(false);
          }));
       }

       @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(EntrySet.class, this, "RetainAll", logical.class, new Block((Body) () ->
          {
             // no check for null on 4GL implementation
             //Assert.notNull(p1, new character("Check collection"));

             Iiterator it = iterator().ref();
             boolean ok = false;

             while (it.hasNext().booleanValue())
             {
                object<? extends _BaseObject_> obj = it.next_();
                if (!p1.ref().contains(obj).booleanValue())
                {
                   while (remove(obj).booleanValue())
                      ok = true;
                }
             }

             returnNormal(ok);
          }));
       }
    }