ListIterator.java

/*
** Module   : ListIterator.java
** Abstract : Implementation of the Progress.Collections.ListIterator builtin class.
**
** Copyright (c) 2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 ICP 20250414 First version.
*/

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

import com.goldencode.p2j.util.*;
import com.goldencode.p2j.oo.lang.*;

import java.util.*;

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

/**
 * Implementation of the Progress.Collections.ListIterator builtin interface.
 */
@LegacyResource(resource = "Progress.Collections.ListIterator")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public final class ListIterator
extends BaseObject
implements com.goldencode.p2j.oo.collections.Iiterator
{
   @LegacySignature(type = Type.PROPERTY, name = "Current")
   private object<? extends _BaseObject_> current = TypeFactory.object(_BaseObject_.class);

   /** The elements to iterate. */
   private java.util.List<object<? extends _BaseObject_>> elements;

   /** Current index in the list. */
   private int index;

   @LegacySignature(type = Type.CONSTRUCTOR, name = "ListIterator")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void __collections_listIterator_constructor__()
   {
       __lang_BaseObject_constructor__();
       this.index = 0;
       this.elements = null;
       this.current = null;
   }

   @LegacySignature(type = Type.GETTER, name = "Current", returns = "OBJECT", qualified = "progress.lang.object")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> getCurrent()
   {
      return current;
   }

   @LegacySignature(type = Type.METHOD, name = "MoveNext", returns = "LOGICAL")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public logical moveNext()
   {
      if (elements != null)
      {
         if (index < elements.size())
         {
            current = elements.get(index++);
            return new logical(true);
         }
         else
         {
            current = null;
            return new logical(false);
         }
      }
      return new logical(false);
   }

   @LegacySignature(type = Type.METHOD, name = "Reset")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void reset()
   {
      index = 0;
      current = null;
   }

   /**
    * Set the internal list of elements to iterate over.
    *
    * @param    list
    *           the list to iterate
    */
   public void setElements(java.util.List<object<? extends _BaseObject_>> list)
   {
      if (list != null)
      {
         this.elements = list;
      }
      this.index = 0;
      this.current = null;
   }
}