# ArrayIterator.java

    /*
    ** Module   : ArrayIterator.java
    ** Abstract : Implementation of the builtin class.
    **
    ** Copyright (c) 2019-2025, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
    ** 001 ME  20200519 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 ME  20210927 Use '4GL' compare to account for unknown values.
    ** 005 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
    **                  dropped if is a no-op.
    ** 006 ICP 20250409 Included new function added in newer versions of Progress, corrected old implementation.
    */

    /*
    ** 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.Assert;
    import com.goldencode.p2j.oo.core.collections.Iiterator;
    import com.goldencode.p2j.oo.lang.*;

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

    /**
     * Business logic (converted to Java from the 4GL source code
     * in OpenEdge/Core/Collections/ArrayIterator.cls).
     */
    @LegacyResource(resource = "OpenEdge.Core.Collections.ArrayIterator")
    @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
    public class ArrayIterator
    extends BaseObject
    implements Iiterator,
               IlistIterator
    {
       @LegacySignature(type = Type.PROPERTY, name = "CurrentExtent")
       private integer currentExtent = TypeFactory.integer();

       @LegacySignature(type = Type.PROPERTY, name = "IteratedArray")
       private object<? extends Array> iteratedArray = TypeFactory.object(Array.class);

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

       @LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "CurrentExtent")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       protected integer getCurrentExtent()
       {
          return function(ArrayIterator.class, this, "CurrentExtent", integer.class,
                   new Block((Body) () ->
                   {
                      returnNormal(currentExtent);
                   }));
       }

       @LegacySignature(type = Type.SETTER, name = "CurrentExtent", parameters = {
                @LegacyParameter(name = "var", type = "INTEGER", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       protected void setCurrentExtent(final integer _var)
       {
          integer var = TypeFactory.initInput(_var);

          internalProcedure(ArrayIterator.class, this, "CurrentExtent", new Block((Body) () ->
          {
             currentExtent.assign(var);
          }));
       }

       @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Core.Collections.Array", type = Type.GETTER, name = "IteratedArray")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       protected object<? extends Array> getIteratedArray()
       {
          return function(ArrayIterator.class, this, "IteratedArray", object.class,
                   new Block((Body) () ->
                   {
                      returnNormal(iteratedArray);
                   }));
       }

       @LegacySignature(type = Type.SETTER, name = "IteratedArray", parameters = {
                @LegacyParameter(qualified = "OpenEdge.Core.Collections.Array", name = "var", type = "OBJECT", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       protected void setIteratedArray(final object<? extends Array> _var)
       {
          object<? extends Array> var = TypeFactory.initInput(_var);

          internalProcedure(ArrayIterator.class, this, "IteratedArray", new Block((Body) () ->
          {
             iteratedArray.assign(var);
          }));
       }

       @LegacySignature(type = Type.CONSTRUCTOR, parameters = {
                @LegacyParameter(name = "poIteratedArray", type = "OBJECT", qualified = "openedge.core.collections.array", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public void __core_collections_ArrayIterator_constructor__(
                final object<? extends Array> _poIteratedArray)
       {
          object<? extends Array> poIteratedArray = TypeFactory.initInput(_poIteratedArray);

          internalProcedure(ArrayIterator.class, this,
                   "__skeleton_oo4gl_openedge_core_collections_ArrayIterator_constructor__",
                   new Block((Body) () ->
                   {
                      __lang_BaseObject_constructor__();

                      Assert.notNull(poIteratedArray, new character("Iterated Array"));

                      currentExtent.assign(0);
                      iteratedArray.assign(poIteratedArray);
                   }));
       }

       @LegacySignature(type = Type.CONSTRUCTOR, name = "ArrayIterator", parameters =
          {
             @LegacyParameter(name = "pIteratedArray",
                              type = "OBJECT",
                              qualified = "openedge.core.collections.array",
                              mode = "INPUT"),
             @LegacyParameter(name = "pIndex", type = "INTEGER", mode = "INPUT")
          })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public void __core_collections_ArrayIterator_constructor__(final object<? extends Array> _pIteratedArray,
                                                                  final integer _pIndex)
       {
          object<? extends Array> pIteratedArray = TypeFactory.initInput(_pIteratedArray);
          integer pIndex = TypeFactory.initInput(_pIndex);

          internalProcedure(ArrayIterator.class, this, "ArrayIterator", new Block((Body) () ->
          {
             __lang_BaseObject_constructor__();
             Assert.notNull(pIteratedArray, new character("Iterated Array"));
             Assert.isZeroOrPositive(pIndex, new character("Index"));
             setCurrentExtent(pIndex);
             setIteratedArray(pIteratedArray);
          }));
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "HasNext")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public logical hasNext()
       {
          return function(ArrayIterator.class, this, "HasNext", logical.class, new Block((Body) () ->
          {
             returnNormal(CompareOps.lessThan(currentExtent, iteratedArray.ref().getSize()));
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Next", qualified = "progress.lang.object")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> next_()
       {
          return function(ArrayIterator.class, this, "Next", object.class, new Block((Body) () ->
          {
             Assert.isTrue(ArrayIterator.this.hasNext());
             setCurrentExtent(InputParameter.property(integer.class, plus(getCurrentExtent(), 1)));
             storeReturnValue(((Array) getIteratedArray().ref()).getValue(getCurrentExtent()));
          }));
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "Remove")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public logical remove()
       {
          return function(ArrayIterator.class, this, "Remove", logical.class, new Block((Body) () ->
          {
             if (_isGreaterThanOrEqual(new decimal(EnvironmentOps.getVersion()), decimal.fromLiteral("12.0")))
             {
                Assert.notZero(currentExtent, new character("Current iterator position"));
             }
             else
             {
                Assert.notZero(currentExtent, new character("Extent"));
             }
             returnNormal(iteratedArray.ref().remove(iteratedArray.ref().getValue(currentExtent)));
          }));
       }

       @LegacySignature(type = Type.METHOD, name = "HasPrevious", returns = "LOGICAL")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public logical hasPrevious()
       {
          return function(ArrayIterator.class, this, "HasPrevious", logical.class, new Block((Body) () ->
          {
             storeReturnValue(isGreaterThanOrEqual(minus(getCurrentExtent(), 1), 1));
          }));
       }

       @LegacySignature(type = Type.METHOD, name = "NextIndex", returns = "INTEGER")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public integer nextIndex()
       {
          return function(ArrayIterator.class, this, "NextIndex", integer.class, new Block((Body) () ->
          {
             storeReturnValue(int64.minimum(plus(getCurrentExtent(), 1),
                                            ((Array) getIteratedArray().ref()).getSize()));
          }));
       }

       @LegacySignature(type = Type.METHOD, name = "Previous", returns = "OBJECT", qualified = "progress.lang.object")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> previous()
       {
          return function(ArrayIterator.class, this, "Previous", object.class, new Block((Body) () ->
          {
             Assert.isTrue(ArrayIterator.this.hasPrevious());
             setCurrentExtent(InputParameter.property(integer.class, minus(getCurrentExtent(), 1)));
             storeReturnValue(((Array) getIteratedArray().ref()).getValue(getCurrentExtent()));
          }));
       }

       @LegacySignature(type = Type.METHOD, name = "PreviousIndex", returns = "INTEGER")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public integer previousIndex()
       {
          return function(ArrayIterator.class, this, "PreviousIndex", integer.class, new Block((Body) () ->
          {
             storeReturnValue(int64.maximum(minus(getCurrentExtent(), 1), new int64(0)));
          }));
       }
    }