# HandlePropertyRef.java

    /*
    ** Module   : HandlePropertyRef.java
    ** Abstract : Data wrapper which associates with a legacy OO property and provides direct access
    **            to this property.
    **
    ** Copyright (c) 2019-2024, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 CA  20190524 Created initial version.
    ** 002 CA  20190604 Fixed javadocs.
    ** 003 CA  20240215 Fixed issues using CALL property/field references as arguments, associated with a
    **                  DATASET/TABLE-HANDLE parameter.
    */
    /*
    ** 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 com.goldencode.p2j.oo.lang.*;

    /**
     * Data wrapper which associates with a OO property and provides direct access to this property.
     * <p>
     * All writing is done to both the OO member and the local {@link handle}'s private {@code value}.
     * On instantiation, the current property value is saved in the {@link handle}'s private
     * {@code value}, and this instance will be used for reading until {@link #set} or
     * {@link #setUnknown} is called again.
     */
    public class HandlePropertyRef
    extends handle
    {
       /** The property referenced by this instance. */
       private final PropertyReference propertyRef;

       /**
        * Initialize using the given property.
        *
        * @param    propertyRef
        *           The property reference.
        */
       public HandlePropertyRef(PropertyReference propertyRef)
       {
          this.propertyRef = propertyRef;

          init(propertyRef.getInstance());
       }

       /**
        * Constructor.
        *
        * @param   className
        *          The class name in case of static property access.
        * @param   property
        *          Name of class property member.
        */
       public HandlePropertyRef(String className, String property)
       {
          this.propertyRef = new PropertyReference(className, property);

          init(null);
       }

       /**
        * Constructor.
        *
        * @param   instance
        *          The class instance, for instance property access.
        * @param   property
        *          Name of class property member.
        */
       public HandlePropertyRef(object<? extends _BaseObject_> instance, String property)
       {
          this.propertyRef = new PropertyReference(instance, property);

          init(instance);
       }

       /**
        * Constructor.
        *
        * @param   className
        *          The class name in case of static property access.
        * @param   property
        *          Name of class property member.
        * @param   index
        *          Index to pass to property's getter method at resolve time.
        */
       public HandlePropertyRef(String className, String property, int64 index)
       {
          this.propertyRef = new PropertyReference(className, property, index);

          init(null);
       }

       /**
        * Constructor.
        *
        * @param   className
        *          The class name in case of static property access.
        * @param   property
        *          Name of class property member.
        * @param   index
        *          Index to pass to property's getter method at resolve time.
        */
       public HandlePropertyRef(String className, String property, int index)
       {
          this.propertyRef = new PropertyReference(className, property, index);

          init(null);
       }

       /**
        * Constructor.
        *
        * @param   instance
        *          The class instance, for instance property access.
        * @param   property
        *          Name of class property member.
        * @param   index
        *          Index to pass to property's getter method at resolve time.
        */
       public HandlePropertyRef(object<? extends _BaseObject_> instance, String property, int64 index)
       {
          this.propertyRef = new PropertyReference(instance, property, index);

          init(instance);
       }

       /**
        * Constructor.
        *
        * @param   instance
        *          The class instance, for instance property access.
        * @param   property
        *          Name of class property member.
        * @param   index
        *          Index to pass to property's getter method at resolve time.
        */
       public HandlePropertyRef(object<? extends _BaseObject_> instance, String property, int index)
       {
          this.propertyRef = new PropertyReference(instance, property, index);

          init(instance);
       }

       /**
        * Set the value of this instance as a {@link WrappedResource}.
        * <p>
        * Also updates the {@link #propertyRef} with the new state of this handle instance.
        *
        * @param    value
        *           The value to be represented in this instance.
        */
       @Override
       public void set(WrappedResource value)
       {
          super.set(value);

          propertyRef.set(this);
       }

       /**
        * Sets the state of this instance's <code>unknown value</code> flag or state to <code>true</code>.
        * <p>
        * <b>Warning: the data stored in this instance may be invalid after calling this method.</b>
        * <p>
        * Also updates the {@link #propertyRef} with the new state of this handle instance.
        */
       public void setUnknown()
       {
          super.setUnknown();

          propertyRef.set(this);
       }

       /**
        * Initialize this instance.
        *
        * @param    instance
        *           non-null for instance property member.
        */
       private void init(object<? extends _BaseObject_> instance)
       {
          if (instance == null || !instance.isUnknown())
          {
             super.set(((handle) propertyRef.get()).getResource());
          }
          else
          {
             super.setUnknown();
          }
       }
    }