/*
    * Copyright 2007-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed 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.
   */
  package de.smartics.maven.exceptions.conf;
  
  import java.io.File;
  import java.lang.reflect.Constructor;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.List;
  import java.util.ResourceBundle;
  
  import org.apache.commons.lang.StringUtils;
  
  import de.smartics.exceptions.report.data.ProjectConfiguration;
  import de.smartics.exceptions.report.generator.ReportGenerator;
  import de.smartics.exceptions.report.utils.JavadocUtils;
  import de.smartics.maven.exceptions.runtime.ProjectClassLoader;
  import de.smartics.messages.core.BundleMapper;
  
  /**
   * Default implementation.
   *
   * @param <O> the type of the output instance that handles the writing.
   */
  public final class DefaultProjectConfiguration<O> implements // NOPMD Builder
      ProjectConfiguration<O>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The name of the project this configuration is for.
     */
    private final String projectName;
  
    /**
     * The classpath used by the tool.
     */
    private final List<String> toolClassPath;
  
    /**
     * The list of class path root elements of this project.
     */
    private final Collection<String> classRootDirectoryNames;
  
    /**
     * The class loader to load project classes.
     */
    private final ClassLoader projectClassLoader;
  
    /**
     * The encoding of the source files in this project.
     */
    private final String sourceEncoding;
  
    /**
     * The Java version specified for the sources in the project.
     */
    private final String sourceVersion;
  
    /**
     * The list of source path root elements of this project.
     */
    private final Collection<String> sourceRootDirectoryNames;
  
    /**
     * The includes for the scanner.
     */
    private final List<String> includes;
  
    /**
     * The excludes for the scanner.
     */
    private final List<String> excludes;
  
    /**
     * The encoding of the generated report.
     */
    private final String reportEncoding;
  
    /**
     * The reference to the reporter that generates the report document.
     */
   private final ReportGenerator<O> reporterInstance;
 
   /**
    * The class name of the reporter.
    */
   private final String reporter;
 
   /**
    * The name of the file the report will be written to.
    */
   private final String report;
 
   /**
    * The bundle set for this report execution.
    */
   private final ResourceBundle bundle;
 
   /**
    * The directory where the Javadoc pages are found. This information is used
    * to make relative links from the exceptions report to the Javadocs.
    */
   private final File javadocDir;
 
   /**
    * The reference to the style sheet to add as link element to the head of the
    * XHTML document.
    */
   private final String styleSheet;
 
   /**
    * The mapper to the resource bundles of a given item class. The item is to be
    * documented.
    */
   private final BundleMapper bundleMapper;
 
   // ****************************** Initializer *******************************
 
   // ****************************** Constructors ******************************
 
   /**
    * Default constructor.
    *
    * @param builder the information to set to the value object.
    */
   private DefaultProjectConfiguration(final Builder<O> builder)
   {
     this.projectName = builder.projectName;
     this.toolClassPath = builder.toolClassPath;
     this.bundle = builder.bundle;
     this.sourceEncoding = builder.sourceEncoding;
     this.sourceVersion = builder.sourceVersion;
     this.excludes =
         builder.excludes != null ? Collections
             .unmodifiableList(builder.excludes) : null;
     this.includes =
         builder.includes != null ? Collections
             .unmodifiableList(builder.includes) : null;
     this.javadocDir = builder.javadocDir;
     this.report = builder.report;
     this.reportEncoding = builder.reportEncoding;
     this.reporter = builder.reporter;
     this.reporterInstance = builder.reporterInstance;
     this.classRootDirectoryNames =
         Collections.unmodifiableCollection(builder.classRootDirectoryNames);
     this.projectClassLoader = builder.projectClassLoader;
     this.sourceRootDirectoryNames =
         Collections.unmodifiableCollection(builder.sourceRootDirectoryNames);
     this.styleSheet = builder.styleSheet;
     this.bundleMapper = builder.bundleMapper;
   }
 
   // ****************************** Inner Classes *****************************
 
   /**
    * The configuration builder.
    */
   public static final class Builder<O>
   {
     // ******************************** Fields ********************************
 
     // --- constants ----------------------------------------------------------
 
     // --- members ------------------------------------------------------------
 
     /**
      * The name of the project this configuration is for.
      */
     private final String projectName;
 
     /**
      * The classpath used by the tool.
      */
     private List<String> toolClassPath;
 
     /**
      * The list of class path root elements of this project.
      */
     private Collection<String> classRootDirectoryNames;
 
     /**
      * The class loader to load project classes.
      */
     private ClassLoader projectClassLoader;
 
     /**
      * The encoding of the source files in this project.
      */
     private String sourceEncoding = "UTF-8";
 
     /**
      * The Java version specified for the sources in the project.
      */
     private String sourceVersion;
 
     /**
      * The list of source path root elements of this project.
      */
     private Collection<String> sourceRootDirectoryNames;
 
     /**
      * The includes for the scanner.
      */
     private List<String> includes;
 
     /**
      * The excludes for the scanner.
      */
     private List<String> excludes;
 
     /**
      * The encoding of the generated report.
      */
     private String reportEncoding = "UTF-8";
 
     /**
      * The reference to the reporter that generates the report document.
      */
     private ReportGenerator<O> reporterInstance;
 
     /**
      * The class name of the reporter.
      */
     private String reporter;
 
     /**
      * The name of the file the report will be written to.
      */
     private String report;
 
     /**
      * The bundle set for this report execution.
      */
     private ResourceBundle bundle;
 
     /**
      * The directory where the Javadoc pages are found. This information is used
      * to make relative links from the exceptions report to the Javadocs.
      */
     private File javadocDir;
 
     /**
      * The reference to the style sheet to add as link element to the head of
      * the XHTML document.
      */
     private String styleSheet;
 
     /**
      * The class of the mapper to the resource bundles of a given item class.
      * The item is to be documented.
      */
     private String bundleMapperClassName;
 
     /**
      * The mapper to the resource bundles of a given item class. The item is to
      * be documented.
      */
     private BundleMapper bundleMapper;
 
     // ***************************** Initializer ******************************
 
     // ***************************** Constructors *****************************
 
     /**
      * Default constructor.
      *
      * @param projectName the name of the project this configuration is for.
      */
     public Builder(final String projectName)
     {
       this.projectName = projectName;
     }
 
     // ***************************** Inner Classes ****************************
 
     // ******************************** Methods *******************************
 
     // --- init ---------------------------------------------------------------
 
     // --- get&set ------------------------------------------------------------
 
     /**
      * Sets the classpath used by the tool.
      *
      * @param toolClassPath the classpath used by the tool.
      */
     public void setToolClassPath(final List<String> toolClassPath)
     {
       this.toolClassPath = toolClassPath;
     }
 
     /**
      * Sets the list of class path root elements of this project.
      *
      * @param classRootDirectoryNames the list of class path root elements of
      *          this project.
      */
     public void setClassRootDirectoryNames(
         final Collection<String> classRootDirectoryNames)
     {
       this.classRootDirectoryNames = classRootDirectoryNames;
     }
 
     /**
      * Sets the list of source path root elements of this project.
      *
      * @param sourceRootDirectoryNames the list of source path root elements of
      *          this project.
      */
     public void setSourceRootDirectoryNames(
         final Collection<String> sourceRootDirectoryNames)
     {
       this.sourceRootDirectoryNames = sourceRootDirectoryNames;
     }
 
     /**
      * Sets the includes for the scanner.
      *
      * @param includes the includes for the scanner.
      */
     public void setIncludes(final List<String> includes)
     {
       this.includes = includes;
     }
 
     /**
      * Sets the excludes for the scanner.
      *
      * @param excludes the excludes for the scanner.
      */
     public void setExcludes(final List<String> excludes)
     {
       this.excludes = excludes;
     }
 
     /**
      * Sets the encoding of the source files in this project.
      *
      * @param sourceEncoding the encoding of the source files in this project.
      */
     public void setSourceEncoding(final String sourceEncoding)
     {
       this.sourceEncoding = sourceEncoding;
     }
 
     /**
      * Sets the Java version specified for the sources in the project.
      *
      * @param sourceEncoding the Java version specified for the sources in the
      *          project.
      */
     public void setSourceVersion(final String sourceVersion)
     {
       this.sourceVersion = sourceVersion;
     }
 
     /**
      * Sets the encoding of the generated report.
      *
      * @param reportEncoding the encoding of the generated report.
      */
     public void setReportEncoding(final String reportEncoding)
     {
       this.reportEncoding = reportEncoding;
     }
 
     /**
      * Sets the class name of the reporter.
      *
      * @param reporterClass the class name of the reporter.
      */
     public void setReporter(final String reporterClass)
     {
       this.reporter = reporterClass;
     }
 
     /**
      * Sets the name of the file the report will be written to.
      *
      * @param report the name of the file the report will be written to.
      */
     public void setReport(final String report)
     {
       this.report = report;
     }
 
     /**
      * Sets the bundle set for this report execution.
      *
      * @param bundle the bundle set for this report execution.
      */
     public void setBundle(final ResourceBundle bundle)
     {
       this.bundle = bundle;
     }
 
     /**
      * Sets the directory where the Javadoc pages are found. This information is
      * used to make relative links from the exceptions report to the Javadocs.
      *
      * @param javadocDir the directory where the Javadoc pages are found.
      */
     public void setJavadocDir(final File javadocDir)
     {
       this.javadocDir = javadocDir;
     }
 
     /**
      * Sets the reference to the style sheet to add as link element to the head
      * of the XHTML document.
      *
      * @param styleSheet the reference to the style sheet to add as link element
      *          to the head of the XHTML document.
      */
     public void setStyleSheet(final String styleSheet)
     {
       this.styleSheet = styleSheet;
     }
 
     /**
      * Sets the class of the mapper to the resource bundles of a given item
      * class. The item is to be documented.
      *
      * @param bundleMapperClassName the class of the mapper to the resource
      *          bundles of a given item class.
      */
     public void setBundleMapperClassName(final String bundleMapperClassName)
     {
       this.bundleMapperClassName = bundleMapperClassName;
     }
 
     // --- business -----------------------------------------------------------
 
     /**
      * Creates the project configuration.
      *
      * @return the project configuration.
      * @throws IllegalArgumentException if any property is not valid.
      */
     public ProjectConfiguration<O> build() throws IllegalArgumentException
     {
       checkConstraints();
 
       // Please note that the parent class loader is required to be the one
       // loading these classes since we have to match the ones returned by the
       // Javadoc tool with the ones loaded from this class path.
       projectClassLoader =
           new ProjectClassLoader(getClass().getClassLoader(),
               this.classRootDirectoryNames);
       this.bundleMapper = createCodeBundleMapper(projectClassLoader);
 
       final ProjectConfiguration<O> config =
           new DefaultProjectConfiguration<O>(this);
       return config;
     }
 
     @SuppressWarnings("unchecked")
     private BundleMapper createCodeBundleMapper(final ClassLoader loader)
       throws IllegalArgumentException
     {
       if (StringUtils.isNotBlank(bundleMapperClassName))
       {
         try
         {
           final Class<BundleMapper> clazz =
               (Class<BundleMapper>) Class.forName(bundleMapperClassName);
           final Constructor<BundleMapper> constructor =
               clazz.getConstructor(ClassLoader.class);
           final BundleMapper mapper =
               (BundleMapper) constructor.newInstance(loader);
           return mapper;
         }
         catch (final Exception e)
         {
           throw new IllegalArgumentException(
               "Cannot create code bundle mapper for class '"
                   + bundleMapperClassName + "'.", e);
         }
       }
       return null;
     }
 
     /**
      * Checks that the builder constraints are met.
      *
      * @throws IllegalArgumentException if at least one constraint is offended.
      */
     private void checkConstraints() throws IllegalArgumentException
     {
       final StringBuilder buffer = new StringBuilder();
 
       ConfigUtils.checkStringValueProvided(buffer, projectName,
           "Project name must not be 'null'.");
       ConfigUtils.checkCollectionValueProvided(buffer, classRootDirectoryNames,
           "Class root directory names must be provided.");
       ConfigUtils.checkCollectionValueProvided(buffer,
           sourceRootDirectoryNames,
           "Source root directory names must be provided.");
       ConfigUtils.checkStringValueProvided(buffer, report,
           "The name for the report must be provided.");
 
       try
       {
         final Class<ReportGenerator<O>> clazz = getClassForName(reporter);
         this.reporterInstance = clazz.newInstance();
         this.reporterInstance.setEncoding(reportEncoding);
       }
       catch (final Exception e)
       {
         buffer.append('\n').append(
             "Cannot create reporter instance '" + reporter + "': "
                 + e.getMessage());
       }
 
       ConfigUtils.checkStringValueProvided(buffer, reporter,
           "The reporter class must be provided.");
       ConfigUtils.checkValueProvided(buffer, bundle,
           "The message bundle must be provided.");
 
       if (buffer.length() > 0)
       {
         throw new IllegalArgumentException(
             "The following arguments are invalid:" + buffer);
       }
     }
 
     /**
      * Returns the class for the given class name.
      * <p>
      * Implementation note: this method is used to not inline annotate the
      * unchecked cast.
      *
      * @param reporterClass the name of the class to fetch.
      * @return the class instance for the given name.
      * @throws ClassNotFoundException if the class cannot be found.
      */
     @SuppressWarnings("unchecked")
     private Class<ReportGenerator<O>> getClassForName(final String reporterClass)
       throws ClassNotFoundException
     {
       return (Class<ReportGenerator<O>>) Class.forName(reporterClass);
     }
 
     // --- object basics ------------------------------------------------------
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the classpath used by the tool.
    *
    * @return the classpath used by the tool.
    */
   public List<String> getToolClassPath()
   {
     return toolClassPath;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getClassRootDirectoryNames()
    */
   public Collection<String> getClassRootDirectoryNames()
   {
     return classRootDirectoryNames;
   }
 
   /**
    * Returns the class loader to load project classes.
    *
    * @return the class loader to load project classes.
    */
   public ClassLoader getProjectClassLoader()
   {
     return projectClassLoader;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getSourceRootDirectoryNames()
    */
   public Collection<String> getSourceRootDirectoryNames()
   {
     return sourceRootDirectoryNames;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getProjectName()
    */
   public String getProjectName()
   {
     return projectName;
   }
 
   /**
    * Returns the includes for the scanner.
    *
    * @return the includes for the scanner.
    */
   public List<String> getIncludes()
   {
     return includes;
   }
 
   /**
    * Returns the excludes for the scanner.
    *
    * @return the excludes for the scanner.
    */
   public List<String> getExcludes()
   {
     return excludes;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getSourceEncoding()
    */
   public String getSourceEncoding()
   {
     return sourceEncoding;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getReportEncoding()
    */
   public String getReportEncoding()
   {
     return reportEncoding;
   }
 
   /**
    * {@inheritDoc}
    */
   public String getReporter()
   {
     return reporter;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getReporterInstance()
    */
   public ReportGenerator<O> getReporterInstance()
   {
     return reporterInstance;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getReport()
    */
   public String getReport()
   {
     return report;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getBundle()
    */
   public ResourceBundle getBundle()
   {
     return bundle;
   }
 
   /**
    * Returns the directory where the Javadoc pages are found. This information
    * is used to make relative links from the exceptions report to the Javadocs.
    *
    * @return the directory where the Javadoc pages are found.
    */
   public File getJavadocDir()
   {
     return javadocDir;
   }
 
   /**
    * {@inheritDoc}
    * <p>
    * This value is optional and may be <code>null</code>.
    * </p>
    *
    * @see de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration#getJavadocRelativeDir()
    */
   public String getJavadocRelativeDir()
   {
     final File dir = getJavadocDir();
     if (dir != null)
     {
       final File reportLocation = new File(getReport());
       final String relativePath;
       if (reportLocation.isDirectory())
       {
         relativePath =
             JavadocUtils.constructRelativePath(dir.getAbsolutePath(),
                 reportLocation.getAbsolutePath());
       }
       else
       {
         relativePath =
             JavadocUtils.constructRelativePath(dir.getAbsolutePath(),
                 reportLocation.getParent());
       }
       return relativePath;
     }
     else
     {
       return null;
     }
   }
 
   /**
    * Returns the reference to the style sheet to add as link element to the head
    * of the XHTML document.
    *
    * @return the reference to the style sheet to add as link element to the head
    *         of the XHTML document.
    */
   public String getStyleSheet()
   {
     return styleSheet;
   }
 
   public String getSourceVersion()
   {
     return sourceVersion;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.report.conf.ProjectConfiguration#getBundleMapper()
    */
   public BundleMapper getBundleMapper()
   {
     return bundleMapper;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }