# AssertArray.java

    /*
    ** Module   : AssertArray.java
    ** Abstract : Implementation of the builtin class.
    **
    ** Copyright (c) 2021-2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- -------------------------------Description--------------------------------
    ** 001 ME  20210908 First version, stubs taken by converting the skeleton using FWD.
    ** 002 VVT 20230318 The file re-designed completely, API is compatible with the latest
    **                  OE releases. Javadocs added. All methods are now fully implemented.
    **                  See #3827.
    ** 003 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.assertion;

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

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

    /**
     * Business logic (converted to Java from the 4GL source code
     * in OpenEdge/Core/Assertion/AssertArray.cls).
     */
    @LegacyResource(resource = "OpenEdge.Core.Assertion.AssertArray")
    @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
    public class AssertArray
    extends AbstractAssert
    {
       /**
        * Static constructor
        */
       @LegacySignature(type = Type.CONSTRUCTOR)
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void __core_assertion_AssertArray_constructor__static__()
       {
          externalProcedure(AssertArray.class, new Block((Body) () -> {
             onBlockLevel(Condition.ERROR, Action.THROW);
          }));
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "CHARACTER", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "CHARACTER", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final character[] expected, final character[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "DATE", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "DATE", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final date[] expected, final date[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "DATETIME", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "DATETIME", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final datetime[] expected, final datetime[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "DATETIMETZ", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "DATETIMETZ", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final datetimetz[] expected, final datetimetz[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "DECIMAL", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "DECIMAL", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final decimal[] expected, final decimal[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "HANDLE", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "HANDLE", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final handle[] expected, final handle[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "INT64", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "INT64", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final int64[] expected, final int64[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "INTEGER", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "INTEGER", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final integer[] expected, final integer[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "LOGICAL", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "LOGICAL", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final logical[] expected, final logical[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "LONGCHAR", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "LONGCHAR", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final longchar[] expected, final longchar[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "MEMPTR", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "MEMPTR", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final memptr[] expected, final memptr[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", qualified = "progress.lang.object", type = "OBJECT", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", qualified = "progress.lang.object", type = "OBJECT", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final object<? extends _BaseObject_>[] expected,
                                       final object<? extends _BaseObject_>[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "RAW", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "RAW", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final raw[] expected, final raw[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "RECID", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "RECID", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final recid[] expected, final recid[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Check that two arguments are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       @LegacySignature(type = Type.METHOD, name = "Equals", parameters = {
                @LegacyParameter(name = "expected", type = "ROWID", extent = -1, mode = "INPUT"),
                @LegacyParameter(name = "actual", type = "ROWID", extent = -1, mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void legacyEquals(final rowid[] expected, final rowid[] actual)
       {
          equalsImpl(expected, actual);
       }

       /**
        * Implementation helper for all test methods.
        *
        * @param legacyName
        *        the legacy name of the method
        * @param body
        *        the method body
        */
       private static void call(final String legacyName, final Body body)
       {
          call(AssertArray.class, legacyName, body);
       }

       /**
        * Check that two arrays are equal
        *
        * @param expected
        *        The expected value
        * @param actual
        *        The actual value
        */
       private static void equalsImpl(final BaseDataType[] expected, final BaseDataType[] actual)
       {
          call("Equals", () -> {
             final integer srcSize = ArrayAssigner.lengthOf(expected);
             final integer tgtSize = ArrayAssigner.lengthOf(actual);
             if (!srcSize.equals(tgtSize))
             {
                raiseError("Arrays are different sizes (source=&1; target=&2)", srcSize, tgtSize);
             }

             if(srcSize.isUnknown())
             {
                // dstSize must be unknown either.
                return;
             }

             final int length = srcSize.intValue();
             for (int i = 0; i < length; i++)
             {
                if (!CompareOps._isEqual(expected[i], actual[i]))
                {
                   raiseError("Array value differ for index &1", i + 1);
                }
             }
          });

       }

       /**
        * Constructor
        */
       @LegacySignature(type = Type.CONSTRUCTOR)
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public void __core_assertion_AssertArray_constructor__()
       {
          internalProcedure(AssertArray.class, this, "__core_assertion_AssertArray_constructor__",
                   new Block((Body) () -> {
                      __core_AbstractAssert_constructor__();
                   }));
       }

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