RunMode.java

/*
** Module   : RunMode.java
** Abstract : container for transform driver options   
**
** Copyright (c) 2006-2018, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------Description---------------------------------
** 001 GES 20181023 Extracted common code from ConversionDriver.
*/

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

/**
 * Container class that aggregates a set of options to control a run of the transformation  
 * driver.
 */
public class RunMode
{
   /** Run the front end. */
   public boolean front = false;
   
   /** The front end should run the schema-related components. */
   public boolean schema = false;
   
   /** The front end should run the call graph generator. */
   public boolean callgraph = false;
   
   /** The front end should run the preprocessor. */
   public boolean preproc = false;
   
   /** Run the middle. */
   public boolean middle = false;
   
   /** Run the back end. */
   public boolean back = false;
   
   /**
    * Builds an instance and initializes all data.
    *
    * @param    front
    *           Run the front end.
    * @param    preproc
    *           Front end should include preprocessor execution.
    * @param    schema
    *           Front end should include schema processing.
    * @param    callgraph
    *           Front end should include callgraph processing.
    * @param    middle
    *           Run the middle.
    * @param    back
    *           Run the back end.
    */
   public RunMode(boolean front,
                  boolean preproc,
                  boolean schema,
                  boolean callgraph,
                  boolean middle,
                  boolean back)
   {
      this.front     = front;
      this.preproc   = preproc;
      this.schema    = schema;
      this.callgraph = callgraph;
      this.middle    = middle;
      this.back      = back;
   }
   
   /**
    * Logically OR the given mode flags with the current mode flags and 
    * return an instance that has all flags active that are active in
    * either of the 2 original input modes.  No changes are made to the
    * original instances.
    *
    * @param    run
    *           The mode to logically OR with this instance's data.
    *
    * @return   The logically OR'd result.
    */
   public RunMode merge(RunMode run)
   {
      return new RunMode((this.front     || run.front),
                         (this.preproc   || run.preproc),
                         (this.schema    || run.schema),
                         (this.callgraph || run.callgraph),
                         (this.middle    || run.middle),
                         (this.back      || run.back));
   }
}