# VariableAssigner.java

    /*
    ** Module   : VariableAssigner.java
    ** Abstract : Assigns [input-]output parameter values to variables upon exit from subroutines.
    **
    ** Copyright (c) 2015-2022, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ----------------------------------------Description---------------------------------------
    ** 001 OM  20150626 First version.
    ** 002 CA  20181029 If assignment fails, raise an ERROR condition.
    ** 003 CA  20200506 Fixed runtime for character vs longchar OO method calls.
    ** 004 CA  20210609 Reworked INPUT/INPUT-OUTPUT parameters to a new approach, where they are explicitly
    **                  initialized at the method's execution, and not at the caller's arguments.
    **     TJD 20220504 Java 11 compatibility minor changes
    */
    /*
    ** 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.util;

    import java.lang.reflect.*;
    import java.util.logging.*;

    /**
     * Specialization of {@link OutputParameterAssigner} that handles intermediary variables are
     * replacement of the correct type that assign INPUT-OUTPUT or OUTPUT parameter's value back to
     * the database field with which it is associated, upon exit from a procedure or function.
     * <p>
     * Instance of this class is automatically created if the original instance is not of the correct
     * OUTPUT type. Upon exit from the procedure or function with which it is associated, it attempts
     * to assign the current value of its contained variable back into the associated DMO, optionally
     * applying the provided conversion constructor. This may trigger normal validation processing,
     * which may produce error conditions.
     */
    public final class VariableAssigner
    extends AbstractSimpleParameter
    {
       /** The original variable that must be updated at the end of the subroutine. */
       private final BaseDataType originalVar;

       /**
        * Constructor. Uses the super constructor to register this as output parameter.
        *
        * @param   variable
        *          Parameter value to and from which we will assign.
        * @param   originalVar
        *          Original variable from procedure call that is being accessed.
        */
       VariableAssigner(BaseDataType variable, BaseDataType originalVar)
       {
          super(variable);
          this.originalVar = originalVar;
       }

       /**
        * Assign the current value of the parameter variable back to the associated DMO property. This
        * is expected to occur upon exit from the function or procedure with which this object is
        * associated.
        */
       @Override
       protected void assign()
       {
          if (convCtor != null)
          {
             try
             {
                originalVar.assign((BaseDataType) convCtor.newInstance(outputValue));
             }
             catch (ReflectiveOperationException e)
             {
                if (LOG.isLoggable(Level.WARNING))
                {
                   String msg = "Failed to convert OUTPUT value from " + outputValue.getClass() +
                                " to " + originalVar.getTypeName() + " using " + convCtor +
                                " conversion constructor.";
                   LOG.log(Level.WARNING, msg);
                }

                if (e.getCause() instanceof ErrorConditionException)
                {
                   throw (ErrorConditionException) e.getCause();
                }
             }
          }
          else
          {
             originalVar.assign(outputValue);
          }
       }
    }