AssertionFailedError.java

/*
** Module   : AssertionFailedError.java
** Abstract : Implementation of the OpenEdge.Core.AssertionFailedError builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 CA  20190423 Created the first version, by converting the legacy skeleton .cls file and
**                  using that output.
** 002 CA  20190508 Fixed the converted package.
**     RFB 20191022 Added LegacyResource annotation
** 003 CA  20191024 Added method support levels and updated the class support level.
** 004 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                  signature.
** 005 VVT 20221221 Serialization support added (see #4658). Missing Javadocs added.
**                  Also the fields excepted and actual were added.
** 006 VVT 20230307 AbstractAssertionFailedError class extracted from this class.
** 007 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;

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

import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.InternalEntry.*;

/**
 * OpenEdge.Core.AssertionFailedError implementation
 */
@LegacyResource(resource = "OpenEdge.Core.AssertionFailedError")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class AssertionFailedError
extends AbstractAssertionFailedError
{
   /**
    * Static constructor
    */
   @LegacySignature(type = Type.CONSTRUCTOR)
   public static void __core_AssertionFailedError_constructor__static__()
   {
      externalProcedure(AssertionFailedError.class, new Block((Body) () -> 
      {
         onRoutineLevel(Condition.ERROR, Action.THROW);
      }));
   }

   /**
    * Default constructor. Instances are created using this constructor,
    * then initialized in another call.
    */
   public AssertionFailedError()
   {
      // no-op
   }

   /**
    * Initialize using the message describing the failure.
    * 
    * @param msgtxt
    *        the message
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = {
            @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt)
   {
      internalProcedure(AssertionFailedError.class, this,
               "__core_AssertionFailedError_constructor__", new Block((Body) () -> {
                  __core_AssertionFailedError_constructor__(msgtxt, new integer(0));
               }));
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the COMHANDLE type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "COMHANDLE", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "COMHANDLE", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final comhandle expected,
                                                         final comhandle actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the DATE type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "DATE", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "DATE", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final date expected,
                                                         final date actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the DATETIME type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "DATETIME", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "DATETIME", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final datetime expected,
                                                         final datetime actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the DATETIME-TZ type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "DATETIME-TZ", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "DATETIME-TZ", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final datetimetz expected,
                                                         final datetimetz actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the DECIMAL type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "DECIMAL", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "DECIMAL", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final decimal expected,
                                                         final decimal actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the HANDLE type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "HANDLE", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "HANDLE", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final handle expected,
                                                         final handle actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the INT64 type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "INT64", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "INT64", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final int64 expected,
                                                         final int64 actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and the message number.
    * 
    * @param msgtxt
    *        the message
    * @param msgnum
    *        the message number
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = {
            @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
            @LegacyParameter(name = "msgnum", type = "INTEGER", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final integer msgnum)
   {
      internalProcedure(AssertionFailedError.class, this,
               "__core_AssertionFailedError_constructor__", new Block((Body) () -> {
                  __lang_AppError_constructor__(msgtxt, msgnum);
                  msg = msgtxt.getValue();
               }));
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the INTEGER type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "INTEGER", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "INTEGER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final integer expected,
                                                         final integer actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the LOGICAL type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "LOGICAL", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "LOGICAL", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final logical expected,
                                                         final logical actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the LONGCHAR type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "LONGCHAR", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "LONGCHAR", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final longchar expected,
                                                         final longchar actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the MEMPTR type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "MEMPTR", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "MEMPTR", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final memptr expected,
                                                         final memptr actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the OBJECT type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "OBJECT", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "OBJECT", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final object expected,
                                                         final object actual)
   {
      constructor(msgtxt, expected, actual);
   }


   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the RAW type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "RAW", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "RAW", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final raw expected,
                                                         final raw actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the RECID type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "RECID", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "RECID", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final recid expected,
                                                         final recid actual)
   {
      constructor(msgtxt, expected, actual);
   }

   /**
    * Initialize using the message describing the failure and 
    * the expected and actual values of the ROWID type.
    * 
    * @param msgtxt
    *        the message
    * @param expected
    *        the expected value, must not be {@code null}
    * @param actual 
    *        the actual value, must not be {@code null}
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msgtxt", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "expected", type = "ROWID", mode = "INPUT"),
      @LegacyParameter(name = "actual", type = "ROWID", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_AssertionFailedError_constructor__(final character msgtxt,
                                                         final rowid expected,
                                                         final rowid actual)
   {
      constructor(msgtxt, expected, actual);
   }

}