/*
    * Copyright 2007-2011 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.sort;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.Comparator;
  import java.util.List;
  
  import com.sun.javadoc.ClassDoc;
  import com.sun.javadoc.Doc;
  import com.sun.javadoc.FieldDoc;
  
  import de.smartics.analysis.javadoc.runtime.RuntimeUtils;
  import de.smartics.exceptions.core.Code;
  import de.smartics.exceptions.report.message.PlaceHolderHandler;
  import de.smartics.exceptions.report.message.PlaceHolderInfo;
  import de.smartics.report.conf.ProjectConfiguration;
  import de.smartics.report.util.JavadocUtils;
  
  /**
   * Utilities handling Javadocs representing codes.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public final class CodeUtils
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Utility class pattern.
     */
    private CodeUtils()
    {
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * Bundle of information about a code. This information includes
     * <ul>
     * <li>Javadoc-Information</li>
     * <li>An instance of the code</li>
     * <li>Annotated information</li>
     * </ul>
     */
    public static final class CodeContainer
    {
      /**
       * The instance of the code.
       */
      private final Code code;
  
      /**
       * The Javadoc information collected at class level.
       */
      private final ClassDoc classDoc;
  
      /**
       * The Javadoc information collected at field level.
       */
      private final FieldDoc fieldDoc;
  
      /**
       * The descriptions of the place holders.
       */
      private final PlaceHolderInfo placeHolderInfo;
  
      /**
       * Default constructor.
       *
       * @param code the instance of the code.
       * @param classDoc the Javadoc information collected at class level.
       * @param fieldDoc the Javadoc information collected at field level.
       * @param placeHolderInfo the descriptions of the place holders.
       */
     public CodeContainer(final Code code, final ClassDoc classDoc,
         final FieldDoc fieldDoc, final PlaceHolderInfo placeHolderInfo)
     {
       this.code = code;
       this.classDoc = classDoc;
       this.fieldDoc = fieldDoc;
       this.placeHolderInfo = placeHolderInfo;
     }
 
     /**
      * Returns the instance of the code.
      *
      * @return the instance of the code.
      */
     public Code getCode()
     {
       return code;
     }
 
     /**
      * Returns the Javadoc information collected at class level.
      *
      * @return the Javadoc information collected at class level.
      */
     public ClassDoc getClassDoc()
     {
       return classDoc;
     }
 
     /**
      * Returns the Javadoc information collected at field level.
      *
      * @return the Javadoc information collected at field level.
      */
     public FieldDoc getFieldDoc()
     {
       return fieldDoc;
     }
 
     /**
      * Returns the descriptions of the place holders.
      *
      * @return the descriptions of the place holders.
      */
     public PlaceHolderInfo getPlaceHolderInfo()
     {
       return placeHolderInfo;
     }
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   public static List<CodeContainer> getCodeList(
       final ProjectConfiguration<?> config, final Collection<Doc> javadocs)
   {
     return getCodeList(config, javadocs, new CodeComparator());
   }
 
   public static List<CodeContainer> getCodeList(
       final ProjectConfiguration<?> config, final Collection<Doc> javadocs,
       final Comparator<CodeContainer> comparator)
   {
     final ClassLoader classLoader = config.getProjectClassLoader();
     final PlaceHolderHandler placeHolderHandler =
         new PlaceHolderHandler(config);
 
     final List<CodeContainer> codeList =
         new ArrayList<CodeContainer>(javadocs.size());
     for (Doc doc : javadocs)
     {
       if (doc.isClass())
       {
         final ClassDoc classDoc = (ClassDoc) doc;
         for (FieldDoc fieldDoc : JavadocUtils.getClassElements(classDoc))
         {
           final Code code = loadCode(classLoader, fieldDoc);
           if (code != null)
           {
             final PlaceHolderInfo placeHolderInfo =
                 placeHolderHandler.readPlaceholderDesc(classLoader, fieldDoc);
             codeList.add(new CodeContainer(code, classDoc, fieldDoc,
                 placeHolderInfo));
           }
         }
       }
     }
 
     Collections.sort(codeList, comparator);
     return codeList;
   }
 
   private static Code loadCode(final ClassLoader classLoader,
       final FieldDoc fieldDoc)
   {
     try
     {
       final Code code = (Code) RuntimeUtils.loadInstance(classLoader, fieldDoc);
       return code;
     }
     catch (final Exception e)
     {
       // TODO LOG!!!
     }
     return null;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }