StringCollection.java

/*
** Module   : StringCollection.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 ME  20210908 First version, stubs taken by converting the skeleton using FWD.
** 002 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 static com.goldencode.p2j.report.ReportConstants.CVT_LVL_PARTIAL;
import static com.goldencode.p2j.report.ReportConstants.RT_LVL_STUB;
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/StringCollection.cls).
 */
@LegacyResource(resource = "OpenEdge.Core.Collections.StringCollection")
@LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
public class StringCollection
extends com.goldencode.p2j.oo.core.collections.LegacyCollection
implements com.goldencode.p2j.oo.core.collections.IstringCollection,
           com.goldencode.p2j.oo.core.collections.Icollection,
           com.goldencode.p2j.oo.core.collections.Iiterable
{
   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void __core_collections_StringCollection_constructor__()
   {
      internalProcedure(StringCollection.class, this, "__core_collections_StringCollection_constructor__", new Block((Body) () -> 
      {
         __core_collections_LegacyCollection_constructor__();
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "poCollection", type = "OBJECT", qualified = "openedge.core.collections.istringcollection", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void __core_collections_StringCollection_constructor__(final object<? extends com.goldencode.p2j.oo.core.collections.IstringCollection> _poCollection)
   {
      object<? extends com.goldencode.p2j.oo.core.collections.IstringCollection> poCollection = TypeFactory.initInput(_poCollection);
      
      internalProcedure(StringCollection.class, this, "__core_collections_StringCollection_constructor__", new Block((Body) () -> 
      {
         __core_collections_LegacyCollection_constructor__();
      }));
   }

   @LegacySignature(type = Type.METHOD, name = "Add", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "newObject", type = "OBJECT", qualified = "openedge.core.string", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical add_1(final object<? extends com.goldencode.p2j.oo.core.LegacyString> _newObject)
   {
      object<? extends com.goldencode.p2j.oo.core.LegacyString> newObject = TypeFactory.initInput(_newObject);
      
      return function(StringCollection.class, this, "Add", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "AddArray", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "poArray", type = "OBJECT", extent = -1, qualified = "openedge.core.string", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical addArray_1(final object<? extends com.goldencode.p2j.oo.core.LegacyString>[] _poArray)
   {
      object<? extends com.goldencode.p2j.oo.core.LegacyString>[] poArray[] = new object[][]
      {
         TypeFactory.initInput(_poArray)
      };
      
      return function(StringCollection.class, this, "AddArray", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Remove", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "oldObject", type = "OBJECT", qualified = "openedge.core.string", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical remove_1(final object<? extends com.goldencode.p2j.oo.core.LegacyString> _oldObject)
   {
      object<? extends com.goldencode.p2j.oo.core.LegacyString> oldObject = TypeFactory.initInput(_oldObject);
      
      return function(StringCollection.class, this, "Remove", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "AddAll", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "poCollection", type = "OBJECT", qualified = "openedge.core.collections.istringcollection", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical addAll_1(final object<? extends com.goldencode.p2j.oo.core.collections.IstringCollection> _poCollection)
   {
      object<? extends com.goldencode.p2j.oo.core.collections.IstringCollection> poCollection = TypeFactory.initInput(_poCollection);
      
      return function(StringCollection.class, this, "AddAll", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "RemoveAll", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "poCollection", type = "OBJECT", qualified = "openedge.core.collections.istringcollection", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical removeAll_1(final object<? extends com.goldencode.p2j.oo.core.collections.IstringCollection> _poCollection)
   {
      object<? extends com.goldencode.p2j.oo.core.collections.IstringCollection> poCollection = TypeFactory.initInput(_poCollection);
      
      return function(StringCollection.class, this, "RemoveAll", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "RetainAll", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "poCollection", type = "OBJECT", qualified = "openedge.core.collections.istringcollection", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical retainAll_1(final object<? extends com.goldencode.p2j.oo.core.collections.IstringCollection> _poCollection)
   {
      object<? extends com.goldencode.p2j.oo.core.collections.IstringCollection> poCollection = TypeFactory.initInput(_poCollection);
      
      return function(StringCollection.class, this, "RetainAll", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Contains", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "checkObject", type = "OBJECT", qualified = "openedge.core.string", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical contains_1(final object<? extends com.goldencode.p2j.oo.core.LegacyString> _checkObject)
   {
      object<? extends com.goldencode.p2j.oo.core.LegacyString> checkObject = TypeFactory.initInput(_checkObject);
      
      return function(StringCollection.class, this, "Contains", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "ToStringArray", extent = -1, returns = "OBJECT", qualified = "openedge.core.string")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public object<? extends com.goldencode.p2j.oo.core.LegacyString>[] toStringArray()
   {
      return extentFunction(StringCollection.class, this, "ToStringArray", object.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Add", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "pcElement", type = "LONGCHAR", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical add(final longchar _pcElement)
   {
      longchar pcElement = TypeFactory.initInput(_pcElement);
      
      return function(StringCollection.class, this, "Add", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "AddArray", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "pcElements", type = "LONGCHAR", extent = -1, mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical addArray(final longchar[] _pcElements)
   {
      longchar[] pcElements[] = 
      {
         TypeFactory.initInput(_pcElements)
      };
      
      return function(StringCollection.class, this, "AddArray", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Contains", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "pcElement", type = "LONGCHAR", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical contains(final longchar _pcElement)
   {
      longchar pcElement = TypeFactory.initInput(_pcElement);
      
      return function(StringCollection.class, this, "Contains", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Remove", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "pcElement", type = "LONGCHAR", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical remove(final longchar _pcElement)
   {
      longchar pcElement = TypeFactory.initInput(_pcElement);
      
      return function(StringCollection.class, this, "Remove", logical.class, new Block());
   }
}