FileSet.java

/*
** Module   : FileSet.java
** Abstract : The configuration to load the file-list from a file-set.
**
** Copyright (c) 2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20220412 Created initial version.
**     CA  20220501 Added copy constructor.
*/
/*
** 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.cfg;

import java.util.*;

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

/**
 * The configuration to load the file-list from a file-set.
 * <p>
 * This is used to populate the {@link #references} and {@link #operations} lists, when either reading from
 * the {@code p2j.cfg.xml configuration file}, or from an explicit file, when the {@code -Z} option is used
 * at the {@link TransformDriver} or if the {@code <file-set filename="">} attribute is set in 
 * {@code p2j.cfg.xml}.
 * <p>
 * To load from an explicit file, use {@link FileListFactory#loadFileSet}.
 * <p>
 * To process the file-set and create an explicit file-list, use {@link FileListFactory#processFileSet}.
 */
public class FileSet
{
   /** The target file with the file-set configuration. */
   private String filename;
   
   /** The list of references to create the initial file list. */
   private List<PathReference> references = new ArrayList<>();
   
   /** The list of Include and eXclude operations to apply on the {@link #references}. */
   private List<FilterOperation> operations = new ArrayList<>();
   
   /**
    * Create a new instance.
    */
   public FileSet()
   {
      // no-op
   }
   
   /**
    * Initialize it as a copy of the specified instance.
    * 
    * @param    instance
    *           The instance to copy.
    */
   public FileSet(FileSet instance)
   {
      this.filename = instance.filename;
      this.references = new ArrayList<>(instance.references);
      this.operations = new ArrayList<>(instance.operations);
   }

   /**
    * Get the {@link #filename}.
    * 
    * @return   See above.
    */
   public String getFilename()
   {
      return filename;
   }
   
   /**
    * Set the {@link #filename}.
    * 
    * @param    filename
    *           See above.
    */
   public void setFilename(String filename)
   {
      this.filename = filename;
   }
   
   /**
    * Add a reference to the {@link #references} list.
    * 
    * @param    ref
    *           The reference to add.
    */
   public void addReference(PathReference ref)
   {
      references.add(ref);
   }

   /**
    * Add an {@link IncludeFilter Include} or {@link ExcludeFilter eXclude} operation to be applied on the
    * {@link #references reference file-list}.
    * 
    * @param    oper
    *           The operation to add.
    */
   public void addOperation(FilterOperation oper)
   {
      operations.add(oper);
   }

   /**
    * Get the {@link #references}.
    * 
    * @return   See above.
    */
   public PathReference[] getReferences()
   {
      return references.toArray(new PathReference[0]);
   }

   /**
    * Get the {@link #operations}.
    * 
    * @return   See above.
    */
   public FilterOperation[] getOperations()
   {
      return operations.toArray(new FilterOperation[0]);
   }
}