/*

  * 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.exceptions.report;

 import java.util.Collection;

 import javax.annotation.concurrent.NotThreadSafe;

 import com.thoughtworks.qdox.model.JavaClass;

 import de.smartics.exceptions.report.data.ExceptionCodesReport;

 import de.smartics.exceptions.report.data.ReportProblem;

 import de.smartics.exceptions.report.qdox.ExceptionCodeSearcher;

 import de.smartics.util.lang.Arg;

 import de.smartics.util.lang.NullArgumentException;

 /**

  * Builder of reports on smartics exception codes.

  */

 @NotThreadSafe

 public final class ReportBuilder extends AbstractBuilder

 {

   // ********************************* Fields *********************************

   // --- constants ------------------------------------------------------------

   // --- members --------------------------------------------------------------

   // ****************************** Initializer *******************************

   // ****************************** Constructors ******************************

   private ReportBuilder(final ReportConfiguration configuration)

   {

     super(configuration);

   }

   // ****************************** Inner Classes *****************************

   // ********************************* Methods ********************************

   // --- init -----------------------------------------------------------------

   // --- create ---------------------------------------------------------------

   /**

    * Factory method to create an instance of a report builder.

    *

    * @param configuration the configuration to control the generation of the

    *          report.

    * @return the configured report builder.

    */

   public static ReportBuilder create(final ReportConfiguration configuration)

   {

     return new ReportBuilder(configuration);

   }

   // --- get&set --------------------------------------------------------------

   // --- business -------------------------------------------------------------

   /**

    * Runs the report process and writes to the given report.

    *

    * @param report the report to write to.

    * @throws NullArgumentException if {@code report} is <code>null</code>.

    */

   public void reportTo(final ExceptionCodesReport report)

     throws NullArgumentException

   {

     Arg.checkNotNull("report", report);

     notifyOfParseProblems(report);

     final ExceptionCodeSearcher searcher = new ExceptionCodeSearcher();

     final Collection<JavaClass> exceptionCodeTypes =

         javaProjectBuilder.search(searcher);

     final AddReportItemHelper helper =

         new AddReportItemHelper(runtimeUtils, report);

     for (final JavaClass exceptionCodeType : exceptionCodeTypes)

     {

       try

       {

         helper.addReportItems(exceptionCodeType);

       }

       catch (final Exception e)

       {

         report.addProblem(new ReportProblem("Cannot add report item.", e));

       }

     }

   }

   // --- object basics --------------------------------------------------------

 }