svn commit: r433771 - /geronimo/genesis/trunk/plugins/plugin-support/src/main/java/org/apache/geronimo/plugin/MojoSupport.java

[jd...@apache.org]

Author: jdillon
Date: Tue Aug 22 15:17:43 2006
New Revision: 433771

URL: http://svn.apache.org/viewvc?rev=433771&view=rev
Log:
Added javadocs

Modified:
    geronimo/genesis/trunk/plugins/plugin-support/src/main/java/org/apache/geronimo/plugin/MojoSupport.java

Modified: geronimo/genesis/trunk/plugins/plugin-support/src/main/java/org/apache/geronimo/plugin/MojoSupport.java
URL: http://svn.apache.org/viewvc/geronimo/genesis/trunk/plugins/plugin-support/src/main/java/org/apache/geronimo/plugin/MojoSupport.java?rev=433771&r1=433770&r2=433771&view=diff
==============================================================================
--- geronimo/genesis/trunk/plugins/plugin-support/src/main/java/org/apache/geronimo/plugin/MojoSupport.java (original)
+++ geronimo/genesis/trunk/plugins/plugin-support/src/main/java/org/apache/geronimo/plugin/MojoSupport.java Tue Aug 22 15:17:43 2006
@@ -39,12 +39,25 @@
 public abstract class MojoSupport
     extends AbstractMojo
 {
+    /**
+     * Instance logger.  This is initialized to the value of {@link #getLog}
+     * on execution.
+     */
     protected Log log;
 
+    /**
+     * Initializes logging.  Called by {@link #execute}.
+     */
     protected void init() {
         log = getLog();
     }
 
+    /**
+     * Main Mojo execution hook.  Sub-class should use {@link #doExecute} instead.
+     *
+     * @throws MojoExecutionException
+     * @throws MojoFailureException
+     */
     public void execute() throws MojoExecutionException, MojoFailureException {
         init();
 
@@ -69,22 +82,51 @@
         }
     }
 
+    /**
+     * Sub-class should override to provide custom execution logic.
+     *
+     * @throws Exception
+     */
     protected void doExecute() throws Exception {
-        // Sub-class should override
+        // Empty
     }
 
+    /**
+     * Get the Maven project.
+     *
+     * <p>
+     * Sub-class must overridde to provide access.
+     */
     protected MavenProject getProject() {
         throw new Error("Sub-class must override to provide access");
     }
 
+    /**
+     * Get the artifact factory..
+     *
+     * <p>
+     * Sub-class must overridde to provide access.
+     */
     protected ArtifactFactory getArtifactFactory() {
         throw new Error("Sub-class must override to provide access");
     }
 
+    /**
+     * Get the artifact resolver.
+     *
+     * <p>
+     * Sub-class must overridde to provide access.
+     */
     protected ArtifactResolver getArtifactResolver() {
         throw new Error("Sub-class must override to provide access");
     }
 
+    /**
+     * Get the artifact repository.
+     *
+     * <p>
+     * Sub-class must overridde to provide access.
+     */
     protected ArtifactRepository getArtifactRepository() {
         throw new Error("Sub-class must override to provide access");
     }