# AbstractAssertionFailedError.java

    /*
    ** Module   : AbstractAssertionFailedError.java
    ** Abstract : Common implementation part for OpenEdge.Core.AssertionFailedError and
    **            OEUnit.Assertion.AssertionFailedError classes.
    **
    ** Copyright (c) 2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- -------------------------------Description--------------------------------
    ** 001 VVT 20230318 Initial release
    ** 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;

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

    import java.io.*;

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

    /**
     * Common ancestor for {@link AssertionFailedError}
     * and {@link com.goldencode.p2j.oo.oeunit.assertion.AssertionFailedError}.
     */
    @LegacyResource(resource = "OpenEdge.Core.AbstractAssertionFailedError")
    @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_STUB)
    public abstract class AbstractAssertionFailedError
    extends AppError
    {

       /**
        * The actual value if was set in the object constructor, otherwise {@code null}
        */
       private BaseDataType actual;

       /**
        * The expected value if was set in the object constructor, otherwise {@code null}
        */
       private BaseDataType expected;

       /**
        * The failure message or {@code null} if no message was set.
        */
       protected String msg;

       /**
        * Default constructor.
        */
       public AbstractAssertionFailedError()
       {
          // no-op
       }

       /**
        * Get the actual value, if set. Otherwise return {@code null}.
        * <p>
        * Note: the caller must <b>not</b> modify the contents of the returned object.
        *
        * @return see above
        */
       public BaseDataType getActual()
       {
          return actual;
       }

       /**
        * Get the expected value, if set. Otherwise return {@code null}.
        * <p>
        * Note: the caller must <b>not</b> modify the contents of the returned object.
        *
        * @return see above
        */
       public BaseDataType getExpected()
       {
          return expected;
       }

       /**
        * Get failure message.
        *
        * @return see above
        */
       @LegacySignature(returns = "CHARACTER", type = Type.METHOD, name = "getMessage")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public character getMessage()
       {
          return function(this, "GetMessage", character.class, new Block((Body) () -> {
             returnNormal(msg == null ? new character() : new character(msg));
          }));
       }

       /**
        * Access the message string directly.
        *
        * @return see above
        */
       public String getMessageInt()
       {
          return msg;
       }

       /**
        * The object implements the readExternal method to restore its
        * contents by calling the methods of DataInput for primitive
        * types and readObject for objects, strings and arrays.  The
        * readExternal method must read the values in the same sequence
        * and with the same types as were written by writeExternal.
        *
        * @param     in the stream to read data from in order to restore the object
        *
        * @exception IOException if I/O errors occur
        * @exception ClassNotFoundException If the class for an object being
        *            restored cannot be found.
        */
       @Override
       public void readExternal(final ObjectInput in)
       throws IOException,
              ClassNotFoundException
       {
          super.readExternal(in);

          actual = (BaseDataType) in.readObject();
          expected = (BaseDataType) in.readObject();
          msg = (String) in.readObject();
       }

       /**
        * The object implements the writeExternal method to save its contents
        * by calling the methods of DataOutput for its primitive values or
        * calling the writeObject method of ObjectOutput for objects, strings,
        * and arrays.
        *
        * @serialData Overriding methods should use this tag to describe
        *             the data layout of this Externalizable object.
        *             List the sequence of element types and, if possible,
        *             relate the element to a public/protected field and/or
        *             method of this Externalizable class.
        *
        * @param      out the stream to write the object to
        *
        * @exception  IOException Includes any I/O exceptions that may occur
        */
       @Override
       public void writeExternal(final ObjectOutput out)
       throws IOException
       {
          super.writeExternal(out);

          out.writeObject(actual);
          out.writeObject(expected);
          out.writeObject(msg);
       }

       /**
        * Initialize using the message describing the failure, the expected and actual values.
        *
        * @param msgtxt
        *        the message
        * @param expected
        *        the expected value, must not be {@code null}
        * @param actual
        *        the actual value, must not be {@code null}
        */
       protected final void constructor(final character msgtxt,
                                        final BaseDataType expected,
                                        final BaseDataType actual)
       {
          internalProcedure(getClass(), this, "__core_AbstractAssertionFailedError_constructor__",
                   new Block((Body) () -> {
                      __lang_AppError_constructor__(msgtxt, new integer(0));

                      this.msg = msgtxt.getValue();
                      this.expected = expected;
                      this.actual = actual;
                   }));
       }
    }