package org.apache.torque.generator.configuration;
   
   /*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
   * with the License.  You may obtain a copy of the License at
   *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  
  import org.apache.torque.generator.configuration.controller.Loglevel;
  import org.apache.torque.generator.configuration.option.OptionsConfiguration;
  import org.apache.torque.generator.configuration.paths.ProjectPaths;
  import org.apache.torque.generator.configuration.paths.TorqueGeneratorPaths;
  import org.apache.torque.generator.source.SourceProvider;
  
  /**
   * Contains all necessary information about a generation unit.
   */
  public class UnitDescriptor
  {
      /**
       * Possible packaging forms of a unit of generation.
       */
      public enum Packaging
      {
          /** the generation unit is provided as a jar file .*/
          JAR,
          /** the generation unit is provided in a local directory. */
          DIRECTORY,
          /** the generation unit is provided in the classpath. */
          CLASSPATH
      }
  
      /**
       * The packaging of the generation unit.
       */
      private Packaging packaging;
  
     /**
      * The paths the Torque generator must know about the surrounding project.
      */
      private ProjectPaths projectPaths;
  
      /**
       * How the Torque generator's configuration is organized internally.
       */
      private TorqueGeneratorPaths configurationPaths;
  
      /**
       * The parent of this generation unit, or null if it has no parent.
       */
      private UnitDescriptor inheritsFrom;
  
      /**  Overrides the source defined in the control file. */
      private SourceProvider overrideSourceProvider;
  
      /** Options to override the settings in the project Directory. */
      private OptionsConfiguration overrideOptions;
  
      /**
       * The Loglevel to override the loglevel in the Torque
       * generator configuration.
       */
      private Loglevel loglevel;
  
      /**
       * The output encoding if no specific encoding has been set in the output;
       * null for the default platform encoding.
       */
      private String defaultOutputEncoding = null;
  
      /**
       * Constructor without inheritance, override options, overrideSourceFileset
       * and loglevel.
       *
       * @param packaging The packaging of the generation unit, not null.
       * @param projectPaths The paths the Torque generator must know about
       *        the surrounding project, not null.
       * @param configurationPaths The paths within the configuration
       *        of the configuration unit, not null.
       */
      public UnitDescriptor(
              Packaging packaging,
              ProjectPaths projectPaths,
              TorqueGeneratorPaths configurationPaths)
      {
          if (packaging == null)
         {
             throw new NullPointerException("packaging must not be null");
         }
         if (projectPaths == null)
         {
             throw new NullPointerException(
                     "projectPaths must not be null");
         }
         if (configurationPaths == null)
         {
             throw new NullPointerException(
                     "configurationPaths must not be null");
         }
 
         this.packaging = packaging;
         this.projectPaths = projectPaths;
         this.configurationPaths = configurationPaths;
     }
 
     /**
      * Returns the packaging of the unit of generation.
      *
      * @return the packaging of the unit of generation, not null.
      */
     public Packaging getPackaging()
     {
         return packaging;
     }
 
     /**
      * Returns the paths which the Torque generator must know about the
      * surrounding project.
      *
      * @return the paths of the surrounding project, not null.
      */
     public ProjectPaths getProjectPaths()
     {
         return projectPaths;
     }
 
     /**
      * Returns the paths in the configuration of this generation unit.
      * @return the paths in the configuration of this generation unit,
      *          not null.
      */
     public TorqueGeneratorPaths getConfigurationPaths()
     {
         return configurationPaths;
     }
 
     /**
      * Returns the descriptor of the generation unit from which this generation
      * unit inherits, or null if this generation unit does not inherit from
      * another generation unit.
      *
      * @return the parents unit descriptor, or null if no parent exists.
      */
     public UnitDescriptor getInheritsFrom()
     {
         return inheritsFrom;
     }
 
     /**
      * Sets the descriptor of the generation unit from which this generation
      * unit inherits.
      *
      * @param inheritsFrom the parents unit descriptor,
      *        or null if no parent exists.
      */
     public void setInheritsFrom(UnitDescriptor inheritsFrom)
     {
         this.inheritsFrom = inheritsFrom;
     }
 
     /**
      * Returns the source provider overriding the source defined in the
      * control file, or null if the control file definition
      * is not overridden.
      *
      * @return the overriding source provider, or null.
      */
     public SourceProvider getOverrideSourceProvider()
     {
         return overrideSourceProvider;
     }
 
     /**
      * Sets the source provider overriding the source defined in the
      * control file.
      *
      * @param overrideSourceProvider the overriding source provider,
      *        or null if the control file definition is not overridden.
      */
     public void setOverrideSourceProvider(SourceProvider overrideSourceProvider)
     {
         this.overrideSourceProvider = overrideSourceProvider;
     }
 
     /**
      * Returns the configuration of the overriding options, if any.
      *
      * @return the configuration of the overriding options, or null.
      */
     public OptionsConfiguration getOverrideOptions()
     {
         return overrideOptions;
     }
 
     /**
      * Sets the configuration of the overriding options, if any.
      *
      * @param overrideOptions the configuration of the overriding options,
      *        or null.
      */
     public void setOverrideOptions(OptionsConfiguration overrideOptions)
     {
         this.overrideOptions = overrideOptions;
     }
 
     /**
      * Returns the log level overriding the loglevel defined in the
      * configuration unit.
      *
      * @return the log level, or null.
      */
     public Loglevel getLoglevel()
     {
         return loglevel;
     }
 
     /**
      * Sets the log level overriding the loglevel defined in the
      * configuration unit.
      *
      * @param loglevel the log level, or null.
      */
     public void setLoglevel(Loglevel loglevel)
     {
         this.loglevel = loglevel;
     }
 
     /**
      * Returns the output encoding if no specific encoding has been set
      * in the output.
      *
      * @return the default output encoding, null for the default
      *         platform encoding.
      */
     public String getDefaultOutputEncoding()
     {
         return defaultOutputEncoding;
     }
 
     /**
      * Sets the output encoding which is used if no specific encoding
      * has been set in the output.
      *
      * @param defaultOutputEncoding the default output encoding,
      *        null for the default platform encoding.
      */
     public void setDefaultOutputEncoding(String defaultOutputEncoding)
     {
         this.defaultOutputEncoding = defaultOutputEncoding;
     }
 }