/*

  * 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.renderer;

 import java.util.List;

 import com.thoughtworks.qdox.model.DocletTag;

 import com.thoughtworks.qdox.model.JavaAnnotatedElement;

 import de.smartics.exceptions.report.utils.InlineJavadocTags;

 /**

  * Renderer for Javadoc information.

  */

 public final class JavadocRenderer

 {

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

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

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

   /**

    * The factory to create the renderers to use.

    */

   private final RendererFactory factory;

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

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

   /**

    * Default constructor.

    *

    * @param factory the factory to create the renderers to use.

    */

   public JavadocRenderer(final RendererFactory factory)

   {

     this.factory = factory;

   }

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

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

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

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

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

   /**

    * Renders the information found in a Javadoc.

    *

    * @param doc the comment to render.

    * @return the rendered string.

    */

   public String render(final JavaAnnotatedElement doc)

   {

     final StringBuilder buffer = new StringBuilder(256);

     renderInlineTags(doc, buffer);

     renderTags(doc, buffer);

     return buffer.toString();

   }

   private void renderInlineTags(final JavaAnnotatedElement doc,

       final StringBuilder buffer)

   {

     final InlineJavadocTags tags = new InlineJavadocTags(doc);

     for (final DocletTag tag : tags)

     {

       final String tagName = tag.getName();

       if ("link".equals(tagName))

       {

         final LinkTagRenderer renderer = factory.createLinkTagRenderer();

         renderer.render(buffer, tag);

       }

       else if ("linkplain".equals(tagName))

       {

         final LinkPlainTagRenderer renderer =

             factory.createLinkPlainTagRenderer();

         renderer.render(buffer, tag);

       }

       else if ("literal".equals(tagName))

       {

         final LiteralTagRenderer renderer = factory.createLiteralTagRenderer();

         renderer.render(buffer, tag);

       }

       else if ("code".equals(tagName))

       {

         final CodeTagRenderer renderer = factory.createCodeTagRenderer();

         renderer.render(buffer, tag);

       }

       else if ("value".equals(tagName))

       {

         final ValueTagRenderer renderer = factory.createValueTagRenderer();

         renderer.render(buffer, tag);

       }

       else

       {

         final TextRenderer renderer = factory.createTextRenderer();

         renderer.render(buffer, tag.getValue());

       }

     }

   }

   private void renderTags(final JavaAnnotatedElement doc,

       final StringBuilder buffer)

   {

     final List<DocletTag> tags = doc.getTags();

     if (!tags.isEmpty())

     {

       final TagListRenderer listRenderer = factory.createTagListRenderer();

       listRenderer.renderListStart(buffer);

       for (final DocletTag tag : tags)

       {

         final String tagName = tag.getName();

         if ("see".equals(tagName))

         {

           final SeeTagRenderer renderer = factory.createSeeTagRenderer();

           renderer.render(buffer, tag);

         }

         else if ("version".equals(tagName))

         {

           final SinceTagRenderer renderer = factory.createSinceTagRenderer();

           renderer.render(buffer, tag);

         }

         else if ("since".equals(tagName))

         {

           final VersionTagRenderer renderer =

               factory.createVersionTagRenderer();

           renderer.render(buffer, tag);

         }

       }

       listRenderer.renderListEnd(buffer);

     }

   }

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

 }