# FilterOperation.java

    /*
    ** Module   : FileOperation.java
    ** Abstract : For a file-set configuration, this is the base class for Include or eXclude operations.
    **
    ** Copyright (c) 2022, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
    ** 001 CA  20220412 Created initial version.
    */
    /*
    ** 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;

    /**
     * When a configuration is read from a {@link FileSet}, this represents the base class for Include or eXclude
     * operations, to remove or add back files (from the {@link FileSet#getReferences()}) to the file list.
     */
    public abstract class FilterOperation
    {
       /** Flag indicating if this is an Include (when {@code true} or eXclude operation. */
       private final boolean include;

       /** The filter to apply on the reference file list, obtained from the {@link PathReference file-set}. */
       private String filter;

       /**
        * Create a new instance.
        *
        * @param    include
        *           Flag indicating this is a Include or eXclude operation.
        */
       public FilterOperation(boolean include)
       {
          this.include = include;
       }

       /**
        * Create a new instance.
        *
        * @param    include
        *           Flag indicating this is a Include or eXclude operation.
        * @param    filter
        *           The filter to apply.
        */
       public FilterOperation(boolean include, String filter)
       {
          this.include = include;
          this.filter = filter;
       }

       /**
        * Get the {@link #filter}.
        *
        * @return   See above.
        */
       public String getFilter()
       {
          return filter;
       }

       /**
        * Set the {@link #filter}.
        *
        * @param    filter
        *           See above.
        */
       public void setFilter(String filter)
       {
          this.filter = filter;
       }

       /**
        * Get the {@link #include} flag.
        *
        * @return   See above.
        */
       public boolean isInclude()
       {
          return include;
       }
    }