svn commit: r641509 - /myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/qdox/QdoxModelBuilder.java

[sk...@apache.org]

Author: skitching
Date: Wed Mar 26 12:37:08 2008
New Revision: 641509

URL: http://svn.apache.org/viewvc?rev=641509&view=rev
Log:
Remove System.out.println, improve comments.

Modified:
    myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/qdox/QdoxModelBuilder.java

Modified: myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/qdox/QdoxModelBuilder.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/qdox/QdoxModelBuilder.java?rev=641509&r1=641508&r2=641509&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/qdox/QdoxModelBuilder.java (original)
+++ myfaces/myfaces-build-tools/branches/skitching/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/qdox/QdoxModelBuilder.java Wed Mar 26 12:37:08 2008
@@ -10,13 +10,15 @@
 import java.util.Map;
 import java.util.Set;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.project.MavenProject;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.ModelBuilder;
+import org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.model.ComponentMeta;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.model.ConverterMeta;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.model.Model;
-import org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.model.PropertyMeta;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.model.ValidatorMeta;
 
@@ -29,8 +31,17 @@
 import com.thoughtworks.qdox.model.JavaMethod;
 import com.thoughtworks.qdox.model.Type;
 
+/**
+ * An implementation of the ModelBuilder interface that uses the Qdox java
+ * source-parsing library to scan a list of specified source directories for
+ * java files.
+ * <p>
+ * The java source files found can use either java15 annotations or doclet
+ * annotations to indicate what data should be added to the Model.
+ */
 public class QdoxModelBuilder implements ModelBuilder
 {
+    private final Log log = LogFactory.getLog(QdoxModelBuilder.class);
 
     private static final String DOC_CONVERTER = "JSFConverter";
     private static final String DOC_VALIDATOR = "JSFValidator";
@@ -75,14 +86,11 @@
         JavaDocBuilder builder = new JavaDocBuilder();
 
         // need a File object representing the original source tree
-        System.out.println("CompileSourceRoots begin..");
         for (Iterator i = sourceDirs.iterator(); i.hasNext();)
         {
             String srcDir = (String) i.next();
-            System.out.println("==" + srcDir);
             builder.addSourceTree(new File(srcDir));
         }
-        System.out.println("CompileSourceRoots end..");
 
         JavaClass[] classes = builder.getClasses();
 
@@ -128,7 +136,7 @@
         // ok, now we can mark this class as processed.
         processedClasses.add(clazz);
 
-        System.out.println("class:" + clazz.getName());
+        log.info("processed class:" + clazz.getName());
 
         DocletTag tag;
         Annotation anno;
@@ -209,8 +217,8 @@
     /**
      * Remove all leading whitespace and a quotemark if it exists.
      * <p>
-     * Qdox comments like <code>@foo val= "bar"</code> return a value with leading whitespace and
-     *      quotes, so remove them.
+     * Qdox comments like <code>foo val= "bar"</code> return a value with
+     * leading whitespace and quotes, so remove them.
      */
     private String clean(Object srcObj)
     {
@@ -246,9 +254,8 @@
     /**
      * Get the named attribute from a doc-annotation.
      * 
-     * @param clazz
-     *            is the class the annotation is attached to; only used when
-     *            reporting errors.
+     * Param clazz is the class the annotation is attached to; only used when
+     * reporting errors.
      */
     private String getString(JavaClass clazz, String key, Map map, String dflt)
     {
@@ -266,9 +273,8 @@
     /**
      * Get the named attribute from a doc-annotation and convert to a boolean.
      * 
-     * @param clazz
-     *            is the class the annotation is attached to; only used when
-     *            reporting errors.
+     * Param clazz is the class the annotation is attached to; only used when
+     * reporting errors.
      */
     private Boolean getBoolean(JavaClass clazz, String key, Map map,
             Boolean dflt)