# BufferCopy.java

    /*
    ** Module   : BufferCopy.java
    ** Abstract : A configurable buffer copy operation.
    **
    ** Copyright (c) 2019-2025, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
    ** 001 ECF 20190208 Created initial version to simplify API for BUFFER-COPY operations.
    ** 002 CA  20190530 Added except(Object), to allow mixed BDT and String arguments.
    ** 003 CA  20220513 The USING and EXCEPT options at BUFFER-COPY and BUFFER-COMPARE can target only fields -
    **                  anything else must be ignored.
    ** 004 ES  20250526 Removed unused import.
    */

    /*
    ** 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.persist;

    /**
     * Object which performs a buffer copy operation. All configuration methods return the current
     * object instance, to allow method chaining.
     */
    public class BufferCopy
    {
       /** Source DMO to be copied */
       private final DataModelObject source;

       /** Target DMO into which to copy */
       private final DataModelObject target;

       /** {@code true} if {@code fields} should be excluded; {@code false} for them to be included */
       private boolean exclusive = true;

       /** Optional field names to include or exclude from copy */
       private String[] fields = null;

       /** {@code true} to skip any LOBs when performing copy; {@code false} to include them */
       private boolean noLobs = false;

       /**
        * Constructor which accepts a source and target DMO on which to perform the copy.
        *
        * @param   source
        *          Source DMO to be copied.
        * @param   target
        *          Target DMO into which to copy.
        */
       public BufferCopy(DataModelObject source, DataModelObject target)
       {
          this.source = source;
          this.target = target;
       }

       /**
        * Exclude the given fields from the copy. Include all others (except LOBs if {@code
        * #noLobs()} was invoked).
        *
        * @param   fields
        *          List of legacy field names to exclude.
        *
        * @return  This object instance.
        */
       public BufferCopy except(String... fields)
       {
          this.exclusive = true;
          this.fields = fields;

          return this;
       }

       /**
        * Include only the given fields for the copy. Exclude all others.
        *
        * @param   fields
        *          List of legacy field names to include.
        *
        * @return  This object instance.
        */
       public BufferCopy using(String... fields)
       {
          this.exclusive = false;
          this.fields = fields;

          return this;
       }

       /**
        * Exclude any LOB fields from the copy. If the buffer record contains no LOB fields, this
        * option has no effect.
        *
        * @return  This object instance.
        */
       public BufferCopy noLobs()
       {
          this.noLobs = true;

          return this;
       }

       /**
        * Perform the copy. This method should only be invoked once all configuration methods
        * have been invoked. In the typical use pattern, this method is called at the end of the
        * method chain which starts with {@code new BufferCopy(source, target)}.
        *
        * @param   validate
        *          If {@code true}, buffer validation is performed after the copy, else it is not.
        *          This should be set to {@code false} if the original BUFFER-COPY statement
        *          contained an ASSIGN clause. In that case, validation is performed at the end of
        *          the assignment batch operation, and validating the copied record before this
        *          batch operation completes may lead to incorrect behavior.
        */
       public void run(boolean validate)
       {
          RecordBuffer.copy(source, target, fields, exclusive, noLobs, validate);
       }
    }