maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bri...@apache.org
Subject svn commit: r661179 [1/2] - in /maven/enforcer/trunk: enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/ enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/ enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/ e...
Date Thu, 29 May 2008 02:07:02 GMT
Author: brianf
Date: Wed May 28 19:07:01 2008
New Revision: 661179

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

Modified:
    maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java
    maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java
    maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractBanDependencies.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractRequireFiles.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DefaultEnforcementRuleHelper.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EnforcerExpressionEvaluator.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EvaluateBeanshell.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/NoSnapshots.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireActiveProfile.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesDontExist.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesExist.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVersion.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireMavenVersion.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireOS.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireProperty.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireSize.java
    maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/EnforcerRuleUtils.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/EnforcerTestUtils.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPathTranslator.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPlexusContainer.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockProject.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockRuntimeInformation.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestAbstractVersionEnforcer.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestBannedDependencies.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestEvaluateBeanshell.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestMavenVersion.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestNoSnapshots.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestRequireJavaVersion.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestRequireOS.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestRequirePluginVersions.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestRequireProperty.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/TestRequireReleaseVersion.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/utils/MockEnforcerExpressionEvaluator.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/utils/TestEnforcerRuleUtils.java
    maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/utils/TestMockEnforcerExpressionEvaluator.java

Modified: maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java (original)
+++ maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java Wed May 28 19:07:01 2008
@@ -1,7 +1,3 @@
-package org.apache.maven.enforcer.rule.api;
-
-import org.apache.maven.plugin.MojoExecutionException;
-
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -20,6 +16,9 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+package org.apache.maven.enforcer.rule.api;
+
+import org.apache.maven.plugin.MojoExecutionException;
 
 /**
  * Inteface to be implemented by any rules executed by the enforcer.
@@ -29,17 +28,19 @@
  */
 public interface EnforcerRule
 {
+    
     /**
      * This is the interface into the rule. This method should throw an exception
      * containing a reason message if the rule fails the check. The plugin will
      * then decide based on the fail flag if it should stop or just log the
      * message as a warning.
      * 
-     * @param helper
-     *            The helper provides access to the log, MavenSession and has
-     *            helpers to get at common components. It is also able to look
-     *            up components by class name.
+     * @param helper The helper provides access to the log, MavenSession and has
+     * helpers to get at common components. It is also able to look
+     * up components by class name.
+     * 
      * @throws MojoExecutionException
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException;
@@ -49,15 +50,17 @@
      * the results will be remembered for future executions in the same build (ie children). Subsequent
      * iterations of the rule will be queried to see if they are also cacheable. This will allow the rule to be
      * uncached further down the tree if needed.
-     *        
-     * @return
+     * 
+     * @return true, if checks if is cacheable
      */
     public boolean isCacheable();
     
     /**
+     * Checks if is result valid.
      * 
-     * @param cachedRule the last cached instance of the rule. This is to be used by the rule to 
+     * @param cachedRule the last cached instance of the rule. This is to be used by the rule to
      * potentially determine if the results are still valid (ie if the configuration has been overridden)
+     * 
      * @return true if the stored results are valid for the same id.
      */
     public boolean isResultValid(EnforcerRule cachedRule);
@@ -65,7 +68,8 @@
     /**
      * If the rule is to be cached, this id is used as part of the key. This can allow rules to take parameters
      * that allow multiple results of the same rule to be cached.
-     * @return id to be used by the enforcer to determine uniqueness of cache results. The ids only need to be unique 
+     * 
+     * @return id to be used by the enforcer to determine uniqueness of cache results. The ids only need to be unique
      * within a given rule implementation as the full key will be [classname]-[id]
      */
     public String getCacheId();

Modified: maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java (original)
+++ maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleException.java Wed May 28 19:07:01 2008
@@ -1,5 +1,3 @@
-package org.apache.maven.enforcer.rule.api;
-
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -18,6 +16,8 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+package org.apache.maven.enforcer.rule.api;
+
 
 /**
  * An exception occuring during the execution of a rule. Based off of
@@ -31,20 +31,30 @@
     extends Exception
 {
 
-    /**
-     * serialVersionUID
-     */
+    /** serialVersionUID. */
     private static final long serialVersionUID = 1L;
 
+    /** The source. */
     protected Object source;
 
+    /** The long message. */
     protected String longMessage;
 
+    /**
+     * Gets the long message.
+     * 
+     * @return the long message
+     */
     public String getLongMessage()
     {
         return longMessage;
     }
 
+    /**
+     * Gets the source.
+     * 
+     * @return the source
+     */
     public Object getSource()
     {
         return source;
@@ -54,9 +64,9 @@
      * Construct a new <code>EnforcerRuleException</code> exception providing
      * the source and a short and long message.
      * 
-     * @param source
-     * @param shortMessage
-     * @param longMessage
+     * @param source the source
+     * @param shortMessage the short message
+     * @param longMessage the long message
      */
     public EnforcerRuleException( Object source, String shortMessage, String longMessage )
     {
@@ -70,8 +80,8 @@
      * an underlying <code>Exception</code> and providing a
      * <code>message</code>.
      * 
-     * @param message
-     * @param cause
+     * @param message the message
+     * @param cause the cause
      */
     public EnforcerRuleException( String message, Exception cause )
     {
@@ -83,8 +93,8 @@
      * an underlying <code>Throwable</code> and providing a
      * <code>message</code>.
      * 
-     * @param message
-     * @param cause
+     * @param message the message
+     * @param cause the cause
      */
     public EnforcerRuleException( String message, Throwable cause )
     {
@@ -95,7 +105,7 @@
      * Construct a new <code>EnforcerRuleException</code> exception providing
      * a <code>message</code>.
      * 
-     * @param message
+     * @param message the message
      */
     public EnforcerRuleException( String message )
     {

Modified: maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.java (original)
+++ maven/enforcer/trunk/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.java Wed May 28 19:07:01 2008
@@ -1,5 +1,3 @@
-package org.apache.maven.enforcer.rule.api;
-
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -18,6 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+package org.apache.maven.enforcer.rule.api;
 
 import java.util.List;
 import java.util.Map;
@@ -27,6 +26,7 @@
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
 import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
 
+
 /**
  * This is the interface that all helpers will use. This
  * provides access to the log, session and components to the
@@ -34,11 +34,17 @@
  * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  * @version $Id: EnforcerRuleHelper.java 571673 2007-09-01
- *          03:04:24Z brianf $
+ * 03:04:24Z brianf $
  */
 public interface EnforcerRuleHelper
     extends ExpressionEvaluator
 {
+    
+    /**
+     * Gets the log.
+     * 
+     * @return the log
+     */
     public Log getLog ();
 
     /*
@@ -46,20 +52,71 @@
      * 
      * @see org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper#getRuntimeInformation()
      */
+    /**
+     * Gets the component.
+     * 
+     * @param clazz the clazz
+     * 
+     * @return the component
+     * 
+     * @throws ComponentLookupException the component lookup exception
+     */
     public Object getComponent ( Class clazz )
         throws ComponentLookupException;
 
+    /**
+     * Gets the component.
+     * 
+     * @param componentKey the component key
+     * 
+     * @return the component
+     * 
+     * @throws ComponentLookupException the component lookup exception
+     */
     public Object getComponent ( String componentKey )
         throws ComponentLookupException;
 
+    /**
+     * Gets the component.
+     * 
+     * @param role the role
+     * @param roleHint the role hint
+     * 
+     * @return the component
+     * 
+     * @throws ComponentLookupException the component lookup exception
+     */
     public Object getComponent ( String role, String roleHint )
         throws ComponentLookupException;
 
+    /**
+     * Gets the component map.
+     * 
+     * @param role the role
+     * 
+     * @return the component map
+     * 
+     * @throws ComponentLookupException the component lookup exception
+     */
     public Map getComponentMap ( String role )
         throws ComponentLookupException;
 
+    /**
+     * Gets the component list.
+     * 
+     * @param role the role
+     * 
+     * @return the component list
+     * 
+     * @throws ComponentLookupException the component lookup exception
+     */
     public List getComponentList ( String role )
         throws ComponentLookupException;
     
+    /**
+     * Gets the container.
+     * 
+     * @return the container
+     */
     public PlexusContainer getContainer(); 
 }

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractBanDependencies.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractBanDependencies.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractBanDependencies.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractBanDependencies.java Wed May 28 19:07:01 2008
@@ -29,8 +29,9 @@
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
 
+// TODO: Auto-generated Javadoc
 /**
- * Abstract Rule for banning dependencies
+ * Abstract Rule for banning dependencies.
  * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  * @version $Id$
@@ -39,15 +40,15 @@
     extends AbstractStandardEnforcerRule
 {
 
-    /**
-     * Specify if transitive dependencies should be searched (default) or only look at direct dependencies
-     * 
-     * @parameter
-     */
+    /** Specify if transitive dependencies should be searched (default) or only look at direct dependencies. */
     public boolean searchTransitive = true;
 
     /**
      * Execute the rule.
+     * 
+     * @param helper the helper
+     * 
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
@@ -100,16 +101,21 @@
     }
 
     /**
-     * Checks the set of dependencies against the list of excludes
+     * Checks the set of dependencies against the list of excludes.
+     * 
+     * @param dependencies the dependencies
+     * @param log the log
      * 
-     * @param dependencies
-     * @return
-     * @throws EnforcerRuleException
+     * @return the sets the
+     * 
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     abstract protected Set checkDependencies( Set dependencies, Log log )
         throws EnforcerRuleException;
 
     /**
+     * Gets the message.
+     * 
      * @return the message
      */
     public String getMessage()
@@ -118,6 +124,8 @@
     }
 
     /**
+     * Sets the message.
+     * 
      * @param theMessage the message to set
      */
     public void setMessage( String theMessage )
@@ -126,6 +134,8 @@
     }
 
     /**
+     * Checks if is search transitive.
+     * 
      * @return the searchTransitive
      */
     public boolean isSearchTransitive()
@@ -134,6 +144,8 @@
     }
 
     /**
+     * Sets the search transitive.
+     * 
      * @param theSearchTransitive the searchTransitive to set
      */
     public void setSearchTransitive( boolean theSearchTransitive )

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractRequireFiles.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractRequireFiles.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractRequireFiles.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractRequireFiles.java Wed May 28 19:07:01 2008
@@ -26,23 +26,41 @@
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
 
+// TODO: Auto-generated Javadoc
 /**
+ * The Class AbstractRequireFiles.
+ * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  */
 abstract public class AbstractRequireFiles
     extends AbstractStandardEnforcerRule
 {
+
+    /** Array of files to check. */
+    File[] files;
+
+    // check the file for the specific condition
     /**
-     * Array of files to check.
+     * Check file.
+     * 
+     * @param file the file
+     * @return true, if successful
      */
-    File[] files;
+    abstract boolean checkFile( File file );
 
-    //check the file for the specific condition
-    abstract boolean checkFile(File file);
-    
-    //retun standard error message
+    // retun standard error message
+    /**
+     * Gets the error msg.
+     * 
+     * @return the error msg
+     */
     abstract String getErrorMsg();
-    
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
+     */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {
@@ -50,9 +68,9 @@
         ArrayList failures = new ArrayList();
         for ( int i = 0; i < files.length; i++ )
         {
-            if ( !checkFile(files[i]) )
+            if ( !checkFile( files[i] ) )
             {
-                failures.add( files[i]);
+                failures.add( files[i] );
             }
         }
 
@@ -70,7 +88,7 @@
             Iterator iter = failures.iterator();
             while ( iter.hasNext() )
             {
-                buf.append( ((File)(iter.next())).getAbsolutePath()+ "\n" );
+                buf.append( ( (File) ( iter.next() ) ).getAbsolutePath() + "\n" );
             }
 
             throw new EnforcerRuleException( buf.toString() );
@@ -82,6 +100,8 @@
      * result to be different. Multiple cached results are stored based on their id. The easiest way to do this is to
      * return a hash computed from the values of your parameters. If your rule is not cacheable, then the result here is
      * not important, you may return anything.
+     * 
+     * @return the cache id
      */
     public String getCacheId()
     {
@@ -114,6 +134,8 @@
      * This tells the system if the results are cacheable at all. Keep in mind that during forked builds and other
      * things, a given rule may be executed more than once for the same project. This means that even things that change
      * from project to project may still be cacheable in certain instances.
+     * 
+     * @return true, if checks if is cacheable
      */
     public boolean isCacheable()
     {
@@ -125,6 +147,9 @@
      * allow double checking of the results. Most of the time this can be done by generating unique ids, but sometimes
      * the results of objects returned by the helper need to be queried. You may for example, store certain objects in
      * your rule and then query them later.
+     * 
+     * @param arg0 the arg0
+     * @return true, if checks if is result valid
      */
     public boolean isResultValid( EnforcerRule arg0 )
     {

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.java Wed May 28 19:07:01 2008
@@ -20,14 +20,15 @@
 
 import org.apache.maven.enforcer.rule.api.EnforcerRule;
 
+// TODO: Auto-generated Javadoc
+/**
+ * The Class AbstractStandardEnforcerRule.
+ */
 public abstract class AbstractStandardEnforcerRule
     implements EnforcerRule
 {
-    /**
-     * Specify a friendly message if the rule fails.
-     * 
-     * @parameter
-     */
+
+    /** Specify a friendly message if the rule fails. */
     public String message = null;
 
 }

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.java Wed May 28 19:07:01 2008
@@ -30,6 +30,7 @@
 import org.apache.maven.plugin.logging.Log;
 import org.codehaus.plexus.util.StringUtils;
 
+// TODO: Auto-generated Javadoc
 /**
  * Containts the common code to compare a version against a version range.
  * 
@@ -49,20 +50,18 @@
      * <li><code>[2.0.5,)</code> Versions 2.0.5 and higher</li>
      * <li><code>(,2.0.5],[2.1.1,)</code> Versions up to 2.0.5 (included) and 2.1.1 or higher</li>
      * </ul>
-     * 
-     * @parameter
-     * @required
      */
     public String version = null;
 
     /**
      * Compares the specified version to see if it is allowed by the defined version range.
      * 
-     * @param log
+     * @param log the log
      * @param variableName name of variable to use in messages (Example: "Maven" or "Java" etc).
      * @param requiredVersionRange range of allowed versions.
      * @param actualVersion the version to be checked.
      * @throws MojoExecutionException if the version is not allowed.
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     public void enforceVersion( Log log, String variableName, String requiredVersionRange, ArtifactVersion actualVersion )
         throws EnforcerRuleException
@@ -188,6 +187,8 @@
     }
 
     /**
+     * Gets the version.
+     * 
      * @return the version
      */
     public String getVersion()
@@ -196,6 +197,8 @@
     }
 
     /**
+     * Sets the version.
+     * 
      * @param theVersion the version to set
      */
     public void setVersion( String theVersion )

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java Wed May 28 19:07:01 2008
@@ -31,6 +31,7 @@
 import org.apache.maven.plugin.logging.Log;
 import org.codehaus.plexus.util.StringUtils;
 
+// TODO: Auto-generated Javadoc
 /**
  * This rule checks that lists of dependencies are not included.
  * 
@@ -45,9 +46,6 @@
      * Specify the banned dependencies. This can be a list of artifacts in the format groupId[:artifactId][:version] Any
      * of the sections can be a wildcard by using '*' (ie group:*:1.0) <br>
      * The rule will fail if any dependencies match any exclude, unless it also matches an include rule.
-     * 
-     * @parameter
-     * @required
      */
     public List excludes = null;
 
@@ -57,9 +55,6 @@
      * Includes override the exclude rules. It is meant to allow wide exclusion rules with wildcards and still allow a
      * smaller set of includes. <br>
      * For example, to ban all xerces except xerces-api -> exclude "xerces", include "xerces:xerces-api"
-     * 
-     * @parameter default-value="*"
-     * @required
      */
     public List includes = null;
 
@@ -88,12 +83,12 @@
     }
 
     /**
-     * Checks the set of dependencies against the list of patterns
+     * Checks the set of dependencies against the list of patterns.
      * 
-     * @param thePatterns
-     * @param dependencies
-     * @return
-     * @throws EnforcerRuleException
+     * @param thePatterns the the patterns
+     * @param dependencies the dependencies
+     * @return the sets the
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     private Set checkDependencies( Set dependencies, List thePatterns )
         throws EnforcerRuleException
@@ -132,12 +127,12 @@
     }
 
     /**
-     * Compares the parsed array of substrings against the artifact
+     * Compares the parsed array of substrings against the artifact.
      * 
-     * @param pattern
-     * @param artifact
-     * @return
-     * @throws EnforcerRuleException
+     * @param pattern the pattern
+     * @param artifact the artifact
+     * @return true, if compare dependency
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     protected boolean compareDependency( String[] pattern, Artifact artifact )
         throws EnforcerRuleException
@@ -182,6 +177,8 @@
     }
 
     /**
+     * Gets the excludes.
+     * 
      * @return the excludes
      */
     public List getExcludes()
@@ -190,6 +187,8 @@
     }
 
     /**
+     * Sets the excludes.
+     * 
      * @param theExcludes the excludes to set
      */
     public void setExcludes( List theExcludes )
@@ -198,6 +197,8 @@
     }
 
     /**
+     * Gets the includes.
+     * 
      * @return the includes
      */
     public List getIncludes()
@@ -206,6 +207,8 @@
     }
 
     /**
+     * Sets the includes.
+     * 
      * @param theIncludes the includes to set
      */
     public void setIncludes( List theIncludes )

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DefaultEnforcementRuleHelper.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DefaultEnforcementRuleHelper.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DefaultEnforcementRuleHelper.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DefaultEnforcementRuleHelper.java Wed May 28 19:07:01 2008
@@ -30,6 +30,7 @@
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
 import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
 
+// TODO: Auto-generated Javadoc
 /**
  * Default implementation of the EnforcementRuleHelper interface. This is used to help retreive information from the
  * session and provide usefull elements like the log.
@@ -40,14 +41,27 @@
 public class DefaultEnforcementRuleHelper
     implements EnforcerRuleHelper
 {
+
+    /** The log. */
     Log log;
 
+    /** The evaluator. */
     ExpressionEvaluator evaluator;
 
+    /** The session. */
     MavenSession session;
 
+    /** The container. */
     PlexusContainer container;
 
+    /**
+     * Instantiates a new default enforcement rule helper.
+     * 
+     * @param session the session
+     * @param evaluator the evaluator
+     * @param log the log
+     * @param container the container
+     */
     public DefaultEnforcementRuleHelper( MavenSession session, ExpressionEvaluator evaluator, Log log,
                                          PlexusContainer container )
     {
@@ -64,6 +78,11 @@
         }
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRuleHelper#getLog()
+     */
     public Log getLog()
     {
         return log;

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EnforcerExpressionEvaluator.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EnforcerExpressionEvaluator.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EnforcerExpressionEvaluator.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EnforcerExpressionEvaluator.java Wed May 28 19:07:01 2008
@@ -25,7 +25,10 @@
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.project.path.PathTranslator;
 
+// TODO: Auto-generated Javadoc
 /**
+ * The Class EnforcerExpressionEvaluator.
+ * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a> This class wraps the PluginParameterExpressionEvaluator
  *         because it can't be accessed directly in 2.0.x so we must create a new one.
  */
@@ -34,10 +37,11 @@
 {
 
     /**
-     * @param theContext
-     * @param theMojoExecution
-     * @param thePathTranslator
-     * @param theProject
+     * The Constructor.
+     * 
+     * @param theContext the the context
+     * @param thePathTranslator the the path translator
+     * @param theProject the the project
      */
     public EnforcerExpressionEvaluator( MavenSession theContext, PathTranslator thePathTranslator,
                                         MavenProject theProject )

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EvaluateBeanshell.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EvaluateBeanshell.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EvaluateBeanshell.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/EvaluateBeanshell.java Wed May 28 19:07:01 2008
@@ -28,26 +28,27 @@
 import bsh.EvalError;
 import bsh.Interpreter;
 
+// TODO: Auto-generated Javadoc
 /**
+ * The Class EvaluateBeanshell.
+ * 
  * @author hugonnem Rule for Maven Enforcer using Beanshell to evaluate a conditional expression
  */
 public class EvaluateBeanshell
     extends AbstractStandardEnforcerRule
 {
 
-    /**
-     * Beanshell interpreter
-     */
+    /** Beanshell interpreter. */
     private static final Interpreter bsh = new Interpreter();
 
-    /**
-     * The condition to be evaluated.
-     * 
-     * @parameter
-     * @required
-     */
+    /** The condition to be evaluated. */
     public String condition;
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
+     */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {
@@ -75,7 +76,7 @@
     }
 
     /**
-     * Evaluate expression using Beanshell
+     * Evaluate expression using Beanshell.
      * 
      * @param script the expression to be evaluated
      * @param log the logger

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/NoSnapshots.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/NoSnapshots.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/NoSnapshots.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/NoSnapshots.java Wed May 28 19:07:01 2008
@@ -23,6 +23,7 @@
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.apache.maven.plugin.logging.Log;
 
+// TODO: Auto-generated Javadoc
 /**
  * This rule is deprecated. Use requireReleaseVersions
  * 
@@ -35,11 +36,12 @@
 {
 
     /**
-     * Checks the set of dependencies to see if any snapshots are included
+     * Checks the set of dependencies to see if any snapshots are included.
      * 
-     * @param dependencies
-     * @return
-     * @throws EnforcerRuleException
+     * @param dependencies the dependencies
+     * @param log the log
+     * @return the sets the
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     protected Set checkDependencies( Set dependencies, Log log )
         throws EnforcerRuleException

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireActiveProfile.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireActiveProfile.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireActiveProfile.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireActiveProfile.java Wed May 28 19:07:01 2008
@@ -30,21 +30,20 @@
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
 import org.codehaus.plexus.util.StringUtils;
 
+// TODO: Auto-generated Javadoc
 /**
+ * The Class RequireActiveProfile.
+ * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a> This rule checks that the current project is not a snapshot
  */
 public class RequireActiveProfile
     extends AbstractStandardEnforcerRule
 {
 
-    /**
-     * Comma separated list of profiles to check
-     */
+    /** Comma separated list of profiles to check. */
     public String profiles = null;
 
-    /**
-     * If all profiles must be active. If false, only one must be active
-     */
+    /** If all profiles must be active. If false, only one must be active */
     public boolean all = true;
 
     /*
@@ -114,6 +113,13 @@
 
     }
 
+    /**
+     * Checks if is profile active.
+     * 
+     * @param project the project
+     * @param profileName the profile name
+     * @return true, if is profile active
+     */
     protected boolean isProfileActive( MavenProject project, String profileName )
     {
         List activeProfiles = project.getActiveProfiles();

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesDontExist.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesDontExist.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesDontExist.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesDontExist.java Wed May 28 19:07:01 2008
@@ -20,15 +20,29 @@
 
 import java.io.File;
 
+// TODO: Auto-generated Javadoc
+/**
+ * The Class RequireFilesDontExist.
+ */
 public class RequireFilesDontExist
     extends AbstractRequireFiles
 {
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.plugins.enforcer.AbstractRequireFiles#checkFile(java.io.File)
+     */
     boolean checkFile( File file )
     {
         return !file.exists();
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.plugins.enforcer.AbstractRequireFiles#getErrorMsg()
+     */
     String getErrorMsg()
     {
         return "Some files should not exist:\n";

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesExist.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesExist.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesExist.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesExist.java Wed May 28 19:07:01 2008
@@ -20,15 +20,29 @@
 
 import java.io.File;
 
+// TODO: Auto-generated Javadoc
+/**
+ * The Class RequireFilesExist.
+ */
 public class RequireFilesExist
     extends AbstractRequireFiles
 {
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.plugins.enforcer.AbstractRequireFiles#checkFile(java.io.File)
+     */
     boolean checkFile( File file )
     {
         return file.exists();
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.plugins.enforcer.AbstractRequireFiles#getErrorMsg()
+     */
     String getErrorMsg()
     {
         return "Some required files are missing:\n";

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVersion.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVersion.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVersion.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVersion.java Wed May 28 19:07:01 2008
@@ -30,6 +30,7 @@
 import org.apache.maven.plugin.logging.Log;
 import org.codehaus.plexus.util.StringUtils;
 
+// TODO: Auto-generated Javadoc
 /**
  * This rule checks that the Java version is allowed.
  * 
@@ -40,6 +41,11 @@
     extends AbstractVersionEnforcer
 {
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
+     */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireMavenVersion.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireMavenVersion.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireMavenVersion.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireMavenVersion.java Wed May 28 19:07:01 2008
@@ -24,6 +24,7 @@
 import org.apache.maven.execution.RuntimeInformation;
 import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
 
+// TODO: Auto-generated Javadoc
 /**
  * This rule checks that the Maven version is allowd.
  * 
@@ -34,6 +35,11 @@
     extends AbstractVersionEnforcer
 {
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
+     */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java Wed May 28 19:07:01 2008
@@ -36,13 +36,21 @@
 import org.codehaus.plexus.util.StringUtils;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
+// TODO: Auto-generated Javadoc
 /**
+ * The Class RequireNoRepositories.
+ * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  */
 public class RequireNoRepositories
     extends AbstractStandardEnforcerRule
 {
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
+     */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {
@@ -103,6 +111,12 @@
         }
     }
 
+    /**
+     * Check models.
+     * 
+     * @param models the models
+     * @return the list
+     */
     private List checkModels( List models )
     {
         List badModels = new ArrayList();

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireOS.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireOS.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireOS.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireOS.java Wed May 28 19:07:01 2008
@@ -31,6 +31,7 @@
 import org.codehaus.plexus.util.Os;
 import org.codehaus.plexus.util.StringUtils;
 
+// TODO: Auto-generated Javadoc
 /**
  * This rule checks that the OS is allowed by combinations of family, name, version and cpu architecture. The behavior
  * is exactly the same as the Maven Os profile activation so the same values are allowed here.
@@ -56,40 +57,38 @@
      * <li>win9x</li>
      * <li>z/os</li>
      * <li>os/400</li>
-     * </ul>
+     * </ul>.
      */
     public String family = null;
 
-    /**
-     * Runtime information containing Maven Version.
-     */
+    /** Runtime information containing Maven Version. */
     public String name = null;
 
-    /**
-     * Runtime information containing Maven Version.
-     */
+    /** Runtime information containing Maven Version. */
     public String version = null;
 
-    /**
-     * Runtime information containing Maven Version.
-     */
+    /** Runtime information containing Maven Version. */
     public String arch = null;
 
-    /**
-     * Specify an optional message to the user if the rule fails.
-     */
+    /** Specify an optional message to the user if the rule fails. */
     public String message = "";
 
-    /**
-     * Display detected OS information.
-     */
+    /** Display detected OS information. */
     public boolean display = false;
 
+    /**
+     * Instantiates a new require os.
+     */
     public RequireOS()
     {
 
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
+     */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {
@@ -132,9 +131,10 @@
     }
 
     /**
-     * Log the current OS information
+     * Log the current OS information.
      * 
-     * @param log
+     * @param log the log
+     * @param info the info
      */
     public void displayOSInfo( Log log, boolean info )
     {
@@ -177,7 +177,7 @@
     }
 
     /**
-     * Creates a Profile object that contains the activation information
+     * Creates a Profile object that contains the activation information.
      * 
      * @return a properly populated profile to be used for OS validation.
      */
@@ -247,6 +247,8 @@
     }
 
     /**
+     * Gets the arch.
+     * 
      * @return the arch
      */
     public String getArch()
@@ -255,6 +257,8 @@
     }
 
     /**
+     * Sets the arch.
+     * 
      * @param theArch the arch to set
      */
     public void setArch( String theArch )
@@ -263,6 +267,8 @@
     }
 
     /**
+     * Gets the family.
+     * 
      * @return the family
      */
     public String getFamily()
@@ -271,6 +277,8 @@
     }
 
     /**
+     * Sets the family.
+     * 
      * @param theFamily the family to set
      */
     public void setFamily( String theFamily )
@@ -279,6 +287,8 @@
     }
 
     /**
+     * Gets the name.
+     * 
      * @return the name
      */
     public String getName()
@@ -287,6 +297,8 @@
     }
 
     /**
+     * Sets the name.
+     * 
      * @param theName the name to set
      */
     public void setName( String theName )
@@ -295,6 +307,8 @@
     }
 
     /**
+     * Gets the version.
+     * 
      * @return the version
      */
     public String getVersion()
@@ -303,6 +317,8 @@
     }
 
     /**
+     * Sets the version.
+     * 
      * @param theVersion the version to set
      */
     public void setVersion( String theVersion )

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java Wed May 28 19:07:01 2008
@@ -69,43 +69,33 @@
 import org.codehaus.plexus.util.StringUtils;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
+// TODO: Auto-generated Javadoc
 /**
+ * The Class RequirePluginVersions.
+ * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
- * @version $Id$ This rule will enforce that all plugins specified in the poms have a version declared.
+ * @version $Id$ This rule will enforce that all plugins
+ *          specified in the poms have a version declared.
  */
 public class RequirePluginVersions
     extends AbstractStandardEnforcerRule
 {
 
-    /**
-     * Don't allow the LATEST identifier
-     */
+    /** Don't allow the LATEST identifier. */
     public boolean banLatest = true;
 
-    /**
-     * Don't allow the RELEASE identifier
-     * 
-     * @required
-     * @parameter
-     */
+    /** Don't allow the RELEASE identifier. */
     public boolean banRelease = true;
 
-    /**
-     * Don't allow snapshot plugins.
-     */
+    /** Don't allow snapshot plugins. */
     public boolean banSnapshots = true;
 
-    /**
-     * Don't allow timestamp snapshot plugins.
-     */
+    /** Don't allow timestamp snapshot plugins. */
     public boolean banTimestamps = true;
-	
-	
+
     /**
      * The comma separated list of phases that should be used to find lifecycle plugin bindings. The default value is
      * "clean,deploy,site".
-     * 
-     * @parameter
      */
     public String phases = "clean,deploy,site";
 
@@ -116,26 +106,41 @@
      */
     public List additionalPlugins;
 
+    /** The plugin manager. */
     private PluginManager pluginManager;
 
+    /** The phase to lifecycle map. */
     private Map phaseToLifecycleMap;
 
+    /** The lifecycles. */
     private List lifecycles;
 
+    /** The factory. */
     ArtifactFactory factory;
 
+    /** The resolver. */
     ArtifactResolver resolver;
 
+    /** The local. */
     ArtifactRepository local;
 
+    /** The remote repositories. */
     List remoteRepositories;
 
+    /** The log. */
     Log log;
 
+    /** The session. */
     MavenSession session;
 
+    /** The utils. */
     EnforcerRuleUtils utils;
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
+     */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {
@@ -304,9 +309,12 @@
     }
 
     /**
-     * Add the additional plugins if they don't exist yet
+     * Add the additional plugins if they don't exist yet.
      * 
-     * @throws MojoExecutionException
+     * @param existing the existing
+     * @param additional the additional
+     * @return the sets the
+     * @throws MojoExecutionException the mojo execution exception
      */
     public Set addAdditionalPlugins( Set existing, List additional )
         throws MojoExecutionException
@@ -347,10 +355,10 @@
     }
 
     /**
-     * Finds the plugins that are listed in active profiles
+     * Finds the plugins that are listed in active profiles.
      * 
-     * @param project
-     * @return
+     * @param project the project
+     * @return the profile plugins
      */
     public Set getProfilePlugins( MavenProject project )
     {
@@ -381,8 +389,7 @@
      * 
      * @param plugin to lookup
      * @param project to search
-     * @return matching plugin, null if not found.
-     * @return matching plugin, null if not found.
+     * @return matching plugin, null if not found. matching plugin, null if not found.
      */
     protected Plugin findCurrentPlugin( Plugin plugin, MavenProject project )
     {
@@ -406,6 +413,13 @@
         return found;
     }
 
+    /**
+     * Resolve plugin.
+     * 
+     * @param plugin the plugin
+     * @param project the project
+     * @return the plugin
+     */
     protected Plugin resolvePlugin( Plugin plugin, MavenProject project )
     {
 
@@ -433,12 +447,13 @@
      * Gets the plugins that are bound to the defined phases. This does not find plugins bound in the pom to a phase
      * later than the plugin is executing.
      * 
-     * @param life
-     * @param project
-     * @return
-     * @throws PluginNotFoundException
-     * @throws LifecycleExecutionException
-     * @throws IllegalAccessException
+     * @param life the life
+     * @param project the project
+     * @param thePhases the the phases
+     * @return the bound plugins
+     * @throws PluginNotFoundException the plugin not found exception
+     * @throws LifecycleExecutionException the lifecycle execution exception
+     * @throws IllegalAccessException the illegal access exception
      */
     protected Set getBoundPlugins( LifecycleExecutor life, MavenProject project, String thePhases )
         throws PluginNotFoundException, LifecycleExecutionException, IllegalAccessException
@@ -477,9 +492,17 @@
      * Checks to see if the version is specified for the plugin. Can optionally ban "RELEASE" or "LATEST" even if
      * specified.
      */
+    /**
+     * Checks for valid version specified.
+     * 
+     * @param helper the helper
+     * @param source the source
+     * @param plugins the plugins
+     * @return true, if successful
+     */
     protected boolean hasValidVersionSpecified( EnforcerRuleHelper helper, Plugin source, List plugins )
-    {		
-		boolean found = false;
+    {
+        boolean found = false;
         boolean status = false;
         Iterator iter = plugins.iterator();
         while ( iter.hasNext() )
@@ -489,7 +512,7 @@
             if ( source.getArtifactId().equals( plugin.getArtifactId() ) &&
                 source.getGroupId().equals( plugin.getGroupId() ) )
             {
-				found = true;
+                found = true;
                 // found the entry. now see if the version
                 // is specified
                 String version = plugin.getVersion();
@@ -500,11 +523,11 @@
                 catch ( ExpressionEvaluationException e )
                 {
                     return false;
-				}
+                }
 
                 if ( StringUtils.isNotEmpty( version ) && !StringUtils.isWhitespace( version ) )
                 {
-				
+
                     if ( banRelease && version.equals( "RELEASE" ) )
                     {
                         return false;
@@ -533,29 +556,44 @@
                 }
             }
         }
-		if ( !found )
-		{
-			log.warn( "plugin " + source.getGroupId() + ":" + source.getArtifactId() + " not found" );
-		}
+        if ( !found )
+        {
+            log.warn( "plugin " + source.getGroupId() + ":" + source.getArtifactId() + " not found" );
+        }
         return status;
     }
 
+    /**
+     * Checks if is snapshot.
+     * 
+     * @param baseVersion the base version
+     * @return true, if is snapshot
+     */
     protected boolean isSnapshot( String baseVersion )
     {
-		if ( banTimestamps )
-		{
-			return Artifact.VERSION_FILE_PATTERN.matcher( baseVersion ).matches() ||
-				baseVersion.endsWith( Artifact.SNAPSHOT_VERSION );
-		}
-		else
-		{
-			return baseVersion.endsWith( Artifact.SNAPSHOT_VERSION );
-		}
+        if ( banTimestamps )
+        {
+            return Artifact.VERSION_FILE_PATTERN.matcher( baseVersion ).matches() ||
+                baseVersion.endsWith( Artifact.SNAPSHOT_VERSION );
+        }
+        else
+        {
+            return baseVersion.endsWith( Artifact.SNAPSHOT_VERSION );
+        }
     }
 
     /*
      * Uses borrowed lifecycle code to get a list of all plugins bound to the lifecycle.
      */
+    /**
+     * Gets the all plugins.
+     * 
+     * @param project the project
+     * @param lifecycle the lifecycle
+     * @return the all plugins
+     * @throws PluginNotFoundException the plugin not found exception
+     * @throws LifecycleExecutionException the lifecycle execution exception
+     */
     private Set getAllPlugins( MavenProject project, Lifecycle lifecycle )
         throws PluginNotFoundException, LifecycleExecutionException
 
@@ -602,6 +640,12 @@
      * NOTE: All the code following this point was scooped from the DefaultLifecycleExecutor. There must be a better way
      * but for now it should work.
      */
+    /**
+     * Gets the phase to lifecycle map.
+     * 
+     * @return the phase to lifecycle map
+     * @throws LifecycleExecutionException the lifecycle execution exception
+     */
     public Map getPhaseToLifecycleMap()
         throws LifecycleExecutionException
     {
@@ -634,6 +678,14 @@
         return phaseToLifecycleMap;
     }
 
+    /**
+     * Gets the lifecycle for phase.
+     * 
+     * @param phase the phase
+     * @return the lifecycle for phase
+     * @throws BuildFailureException the build failure exception
+     * @throws LifecycleExecutionException the lifecycle execution exception
+     */
     private Lifecycle getLifecycleForPhase( String phase )
         throws BuildFailureException, LifecycleExecutionException
     {
@@ -646,6 +698,15 @@
         return lifecycle;
     }
 
+    /**
+     * Find mappings for lifecycle.
+     * 
+     * @param project the project
+     * @param lifecycle the lifecycle
+     * @return the map
+     * @throws LifecycleExecutionException the lifecycle execution exception
+     * @throws PluginNotFoundException the plugin not found exception
+     */
     private Map findMappingsForLifecycle( MavenProject project, Lifecycle lifecycle )
         throws LifecycleExecutionException, PluginNotFoundException
     {
@@ -695,6 +756,15 @@
         return mappings;
     }
 
+    /**
+     * Find optional mojos for lifecycle.
+     * 
+     * @param project the project
+     * @param lifecycle the lifecycle
+     * @return the list
+     * @throws LifecycleExecutionException the lifecycle execution exception
+     * @throws PluginNotFoundException the plugin not found exception
+     */
     private List findOptionalMojosForLifecycle( MavenProject project, Lifecycle lifecycle )
         throws LifecycleExecutionException, PluginNotFoundException
     {
@@ -732,6 +802,18 @@
         return optionalMojos;
     }
 
+    /**
+     * Find extension.
+     * 
+     * @param project the project
+     * @param role the role
+     * @param roleHint the role hint
+     * @param settings the settings
+     * @param localRepository the local repository
+     * @return the object
+     * @throws LifecycleExecutionException the lifecycle execution exception
+     * @throws PluginNotFoundException the plugin not found exception
+     */
     private Object findExtension( MavenProject project, String role, String roleHint, Settings settings,
                                   ArtifactRepository localRepository )
         throws LifecycleExecutionException, PluginNotFoundException
@@ -768,6 +850,17 @@
         return pluginComponent;
     }
 
+    /**
+     * Verify plugin.
+     * 
+     * @param plugin the plugin
+     * @param project the project
+     * @param settings the settings
+     * @param localRepository the local repository
+     * @return the plugin descriptor
+     * @throws LifecycleExecutionException the lifecycle execution exception
+     * @throws PluginNotFoundException the plugin not found exception
+     */
     private PluginDescriptor verifyPlugin( Plugin plugin, MavenProject project, Settings settings,
                                            ArtifactRepository localRepository )
         throws LifecycleExecutionException, PluginNotFoundException
@@ -810,15 +903,15 @@
     }
 
     /**
-     * Gets all plugin entries in build.plugins or build.pluginManagement.plugins or profile.build.plugins 
-	 * in this project and all parents
+     * Gets all plugin entries in build.plugins or build.pluginManagement.plugins or profile.build.plugins in this
+     * project and all parents
      * 
-     * @param project
-     * @return
-     * @throws ArtifactResolutionException
-     * @throws ArtifactNotFoundException
-     * @throws IOException
-     * @throws XmlPullParserException
+     * @param project the project
+     * @return the all plugin entries
+     * @throws ArtifactResolutionException the artifact resolution exception
+     * @throws ArtifactNotFoundException the artifact not found exception
+     * @throws IOException Signals that an I/O exception has occurred.
+     * @throws XmlPullParserException the xml pull parser exception
      */
     protected List getAllPluginEntries( MavenProject project )
         throws ArtifactResolutionException, ArtifactNotFoundException, IOException, XmlPullParserException
@@ -843,22 +936,22 @@
             {
                 // guess there are no plugins here.
             }
-			
-			// Add plugins in profiles
-			Iterator it = model.getProfiles().iterator();
-			while ( it.hasNext() )
-			{
-				Profile profile = (Profile) it.next();
-				try
-				{
-					plugins.addAll( profile.getBuild().getPlugins() );				
-				}
-				catch ( NullPointerException e )
-				{
-					// guess there are no plugins here.
-				}
-				
-			}
+
+            // Add plugins in profiles
+            Iterator it = model.getProfiles().iterator();
+            while ( it.hasNext() )
+            {
+                Profile profile = (Profile) it.next();
+                try
+                {
+                    plugins.addAll( profile.getBuild().getPlugins() );
+                }
+                catch ( NullPointerException e )
+                {
+                    // guess there are no plugins here.
+                }
+
+            }
 
             try
             {
@@ -874,6 +967,8 @@
     }
 
     /**
+     * Checks if is ban latest.
+     * 
      * @return the banLatest
      */
     protected boolean isBanLatest()
@@ -882,6 +977,8 @@
     }
 
     /**
+     * Sets the ban latest.
+     * 
      * @param theBanLatest the banLatest to set
      */
     protected void setBanLatest( boolean theBanLatest )
@@ -890,6 +987,8 @@
     }
 
     /**
+     * Checks if is ban release.
+     * 
      * @return the banRelease
      */
     protected boolean isBanRelease()
@@ -898,6 +997,8 @@
     }
 
     /**
+     * Sets the ban release.
+     * 
      * @param theBanRelease the banRelease to set
      */
     protected void setBanRelease( boolean theBanRelease )
@@ -906,6 +1007,8 @@
     }
 
     /**
+     * Gets the message.
+     * 
      * @return the message
      */
     protected String getMessage()
@@ -914,6 +1017,8 @@
     }
 
     /**
+     * Sets the message.
+     * 
      * @param theMessage the message to set
      */
     protected void setMessage( String theMessage )
@@ -922,6 +1027,8 @@
     }
 
     /**
+     * Gets the utils.
+     * 
      * @return the utils
      */
     protected EnforcerRuleUtils getUtils()
@@ -930,6 +1037,8 @@
     }
 
     /**
+     * Sets the utils.
+     * 
      * @param theUtils the utils to set
      */
     protected void setUtils( EnforcerRuleUtils theUtils )
@@ -968,6 +1077,8 @@
     }
 
     /**
+     * Checks if is ban snapshots.
+     * 
      * @return the banSnapshots
      */
     public boolean isBanSnapshots()
@@ -976,15 +1087,18 @@
     }
 
     /**
+     * Sets the ban snapshots.
+     * 
      * @param theBanSnapshots the banSnapshots to set
      */
     public void setBanSnapshots( boolean theBanSnapshots )
     {
         this.banSnapshots = theBanSnapshots;
     }
-	
-	
+
     /**
+     * Checks if is ban timestamps.
+     * 
      * @return the banTimestamps
      */
     public boolean isBanTimestamps()
@@ -993,6 +1107,8 @@
     }
 
     /**
+     * Sets the ban timestamps.
+     * 
      * @param theBanTimestamps the banTimestamps to set
      */
     public void setBanTimestamps( boolean theBanTimestamps )

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireProperty.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireProperty.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireProperty.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireProperty.java Wed May 28 19:07:01 2008
@@ -24,6 +24,7 @@
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
 import org.codehaus.plexus.util.StringUtils;
 
+// TODO: Auto-generated Javadoc
 /**
  * This rule checks that certain properties are set.
  * 
@@ -33,30 +34,20 @@
     extends AbstractStandardEnforcerRule
 {
 
-    /**
-     * Specify the required property.
-     * 
-     * @parameter
-     * @required
-     */
+    /** Specify the required property. */
     public String property = null;
 
-    /**
-     * Match the property value to a given regular expresssion. Defaults to null (any value is ok).
-     * 
-     * @parameter
-     */
+    /** Match the property value to a given regular expresssion. Defaults to null (any value is ok). */
     public String regex = null;
 
-    /**
-     * Specify a warning message if the regular expression is not matched.
-     * 
-     * @parameter
-     */
+    /** Specify a warning message if the regular expression is not matched. */
     public String regexMessage = null;
 
     /**
      * Execute the rule.
+     * 
+     * @param helper the helper
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java Wed May 28 19:07:01 2008
@@ -26,6 +26,7 @@
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.apache.maven.plugin.logging.Log;
 
+// TODO: Auto-generated Javadoc
 /**
  * This rule checks that no snapshots are included.
  * 
@@ -37,11 +38,12 @@
 {
 
     /**
-     * Checks the set of dependencies to see if any snapshots are included
+     * Checks the set of dependencies to see if any snapshots are included.
      * 
-     * @param dependencies
-     * @return
-     * @throws EnforcerRuleException
+     * @param dependencies the dependencies
+     * @param log the log
+     * @return the sets the
+     * @throws EnforcerRuleException the enforcer rule exception
      */
     protected Set checkDependencies( Set dependencies, Log log )
         throws EnforcerRuleException

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java Wed May 28 19:07:01 2008
@@ -24,7 +24,10 @@
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
 
+// TODO: Auto-generated Javadoc
 /**
+ * The Class RequireReleaseVersion.
+ * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a> This rule checks that the current project is not a snapshot
  */
 public class RequireReleaseVersion

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireSize.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireSize.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireSize.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireSize.java Wed May 28 19:07:01 2008
@@ -26,6 +26,7 @@
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
 
+// TODO: Auto-generated Javadoc
 /**
  * Rule to validate the main artifact is within certain size constraints.
  * 
@@ -35,21 +36,21 @@
 public class RequireSize
     extends AbstractStandardEnforcerRule
 {
-    /**
-     * the max size allowed
-     */
+
+    /** the max size allowed. */
     long maxsize = 10000;
 
-    /**
-     * the max size allowed
-     */
+    /** the max size allowed. */
     long minsize = 0;
 
-    /**
-     * the artifact file to check
-     */
+    /** the artifact file to check. */
     File artifact;
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
+     */
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {
@@ -84,12 +85,12 @@
             {
 
                 helper.getLog().debug(
-                               artifact +
-                                   " size (" +
-                                   length +
-                                   ") is OK (" +
-                                   ( minsize == maxsize || minsize == 0 ? ( "max. " + maxsize ) : ( "between " +
-                                       minsize + " and " + maxsize ) ) + " byte)." );
+                                       artifact +
+                                           " size (" +
+                                           length +
+                                           ") is OK (" +
+                                           ( minsize == maxsize || minsize == 0 ? ( "max. " + maxsize ) : ( "between " +
+                                               minsize + " and " + maxsize ) ) + " byte)." );
 
             }
         }
@@ -99,16 +100,31 @@
         }
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#getCacheId()
+     */
     public String getCacheId()
     {
         return "0";
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isCacheable()
+     */
     public boolean isCacheable()
     {
         return false;
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule)
+     */
     public boolean isResultValid( EnforcerRule cachedRule )
     {
         return false;

Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/EnforcerRuleUtils.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/EnforcerRuleUtils.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/EnforcerRuleUtils.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/EnforcerRuleUtils.java Wed May 28 19:07:01 2008
@@ -42,24 +42,43 @@
 import org.codehaus.plexus.util.StringUtils;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
+// TODO: Auto-generated Javadoc
 /**
- * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
+ * The Class EnforcerRuleUtils.
  * 
+ * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  */
 public class EnforcerRuleUtils
 {
+    
+    /** The factory. */
     ArtifactFactory factory;
 
+    /** The resolver. */
     ArtifactResolver resolver;
 
+    /** The local. */
     ArtifactRepository local;
 
+    /** The remote repositories. */
     List remoteRepositories;
 
+    /** The log. */
     Log log;
 
+    /** The project. */
     MavenProject project;
 
+    /**
+     * Instantiates a new enforcer rule utils.
+     * 
+     * @param theFactory the the factory
+     * @param theResolver the the resolver
+     * @param theLocal the the local
+     * @param theRemoteRepositories the the remote repositories
+     * @param project the project
+     * @param theLog the the log
+     */
     public EnforcerRuleUtils( ArtifactFactory theFactory, ArtifactResolver theResolver, ArtifactRepository theLocal,
                               List theRemoteRepositories, MavenProject project, Log theLog )
     {
@@ -72,6 +91,11 @@
         this.project = project;
     }
 
+    /**
+     * Instantiates a new enforcer rule utils.
+     * 
+     * @param helper the helper
+     */
     public EnforcerRuleUtils( EnforcerRuleHelper helper )
     {
         // get the various expressions out of the
@@ -100,10 +124,12 @@
     /**
      * Gets the pom model for this file.
      * 
-     * @param pom
-     * @return
-     * @throws IOException
-     * @throws XmlPullParserException
+     * @param pom the pom
+     * 
+     * @return the model
+     * 
+     * @throws IOException Signals that an I/O exception has occurred.
+     * @throws XmlPullParserException the xml pull parser exception
      */
     private Model readModel ( File pom )
         throws IOException, XmlPullParserException
@@ -128,15 +154,17 @@
      * Looks first in the filesystem, then tries to get it
      * from the repo.
      * 
-     * @param factory
-     * @param groupId
-     * @param artifactId
-     * @param version
-     * @return
-     * @throws ArtifactResolutionException
-     * @throws ArtifactNotFoundException
-     * @throws XmlPullParserException
-     * @throws IOException
+     * @param groupId the group id
+     * @param artifactId the artifact id
+     * @param version the version
+     * @param pom the pom
+     * 
+     * @return the pom model
+     * 
+     * @throws ArtifactResolutionException the artifact resolution exception
+     * @throws ArtifactNotFoundException the artifact not found exception
+     * @throws XmlPullParserException the xml pull parser exception
+     * @throws IOException Signals that an I/O exception has occurred.
      */
     private Model getPomModel ( String groupId, String artifactId, String version, File pom )
         throws ArtifactResolutionException, ArtifactNotFoundException, IOException, XmlPullParserException
@@ -187,14 +215,17 @@
      * This method loops through all the parents, getting
      * each pom model and then its parent.
      * 
-     * @param groupId
-     * @param artifactId
-     * @param version
-     * @return
-     * @throws ArtifactResolutionException
-     * @throws ArtifactNotFoundException
-     * @throws IOException
-     * @throws XmlPullParserException
+     * @param groupId the group id
+     * @param artifactId the artifact id
+     * @param version the version
+     * @param pom the pom
+     * 
+     * @return the models recursively
+     * 
+     * @throws ArtifactResolutionException the artifact resolution exception
+     * @throws ArtifactNotFoundException the artifact not found exception
+     * @throws IOException Signals that an I/O exception has occurred.
+     * @throws XmlPullParserException the xml pull parser exception
      */
     public List getModelsRecursively ( String groupId, String artifactId, String version, File pom )
         throws ArtifactResolutionException, ArtifactNotFoundException, IOException, XmlPullParserException
@@ -231,11 +262,12 @@
     /**
      * Make sure the model is the one I'm expecting.
      * 
-     * @param groupId
-     * @param artifactId
-     * @param version
+     * @param groupId the group id
+     * @param artifactId the artifact id
+     * @param version the version
      * @param model Model being checked.
-     * @return
+     * 
+     * @return true, if check if model matches
      */
     protected boolean checkIfModelMatches ( String groupId, String artifactId, String version, Model model )
     {

Modified: maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/EnforcerTestUtils.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/EnforcerTestUtils.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/EnforcerTestUtils.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/EnforcerTestUtils.java Wed May 28 19:07:01 2008
@@ -29,32 +29,65 @@
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
 
+// TODO: Auto-generated Javadoc
 /**
+ * The Class EnforcerTestUtils.
+ * 
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  */
 public class EnforcerTestUtils
 {
+
+    /**
+     * Gets the maven session.
+     * 
+     * @return the maven session
+     */
     public static MavenSession getMavenSession()
     {
         return new MavenSession( new MockPlexusContainer(), null, null, null, null, null, null, new Properties(),
                                  new Date() );
     }
 
+    /**
+     * Gets the helper.
+     * 
+     * @return the helper
+     */
     public static EnforcerRuleHelper getHelper()
     {
         return getHelper( new MockProject(), false );
     }
 
+    /**
+     * Gets the helper.
+     * 
+     * @param mockExpression the mock expression
+     * @return the helper
+     */
     public static EnforcerRuleHelper getHelper( boolean mockExpression )
     {
         return getHelper( new MockProject(), mockExpression );
     }
 
+    /**
+     * Gets the helper.
+     * 
+     * @param project the project
+     * @return the helper
+     */
     public static EnforcerRuleHelper getHelper( MavenProject project )
     {
         return getHelper( project, false );
     }
-    
+
+    /**
+     * Gets the helper.
+     * 
+     * @param project the project
+     * @param mockExpression the mock expression
+     * @return the helper
+     */
     public static EnforcerRuleHelper getHelper( MavenProject project, boolean mockExpression )
     {
         MavenSession session = getMavenSession();
@@ -70,6 +103,14 @@
         return new DefaultEnforcementRuleHelper( session, eval, new SystemStreamLog(), null );
     }
 
+    /**
+     * New plugin.
+     * 
+     * @param groupId the group id
+     * @param artifactId the artifact id
+     * @param version the version
+     * @return the plugin
+     */
     public static Plugin newPlugin( String groupId, String artifactId, String version )
     {
         Plugin plugin = new Plugin();

Modified: maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPathTranslator.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPathTranslator.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPathTranslator.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPathTranslator.java Wed May 28 19:07:01 2008
@@ -23,9 +23,11 @@
 import org.apache.maven.model.Model;
 import org.apache.maven.project.path.PathTranslator;
 
+// TODO: Auto-generated Javadoc
 /**
- * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
+ * The Class MockPathTranslator.
  * 
+ * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  */
 public class MockPathTranslator
     implements PathTranslator
@@ -44,8 +46,7 @@
     /*
      * (non-Javadoc)
      * 
-     * @see org.apache.maven.project.path.PathTranslator#alignToBaseDirectory(java.lang.String,
-     *      java.io.File)
+     * @see org.apache.maven.project.path.PathTranslator#alignToBaseDirectory(java.lang.String, java.io.File)
      */
     public String alignToBaseDirectory( String thePath, File theBasedir )
     {
@@ -65,8 +66,7 @@
     /*
      * (non-Javadoc)
      * 
-     * @see org.apache.maven.project.path.PathTranslator#unalignFromBaseDirectory(java.lang.String,
-     *      java.io.File)
+     * @see org.apache.maven.project.path.PathTranslator#unalignFromBaseDirectory(java.lang.String, java.io.File)
      */
     public String unalignFromBaseDirectory( String theDirectory, File theBasedir )
     {

Modified: maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPlexusContainer.java
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPlexusContainer.java?rev=661179&r1=661178&r2=661179&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPlexusContainer.java (original)
+++ maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/MockPlexusContainer.java Wed May 28 19:07:01 2008
@@ -42,9 +42,11 @@
 import org.codehaus.plexus.logging.Logger;
 import org.codehaus.plexus.logging.LoggerManager;
 
+// TODO: Auto-generated Javadoc
 /**
- * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
+ * The Class MockPlexusContainer.
  * 
+ * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  */
 public class MockPlexusContainer
     implements PlexusContainer
@@ -85,8 +87,7 @@
     /*
      * (non-Javadoc)
      * 
-     * @see org.codehaus.plexus.PlexusContainer#addContextValue(java.lang.Object,
-     *      java.lang.Object)
+     * @see org.codehaus.plexus.PlexusContainer#addContextValue(java.lang.Object, java.lang.Object)
      */
     public void addContextValue( Object theKey, Object theValue )
     {
@@ -133,8 +134,7 @@
     /*
      * (non-Javadoc)
      * 
-     * @see org.codehaus.plexus.PlexusContainer#createChildContainer(java.lang.String,
-     *      java.util.List, java.util.Map)
+     * @see org.codehaus.plexus.PlexusContainer#createChildContainer(java.lang.String, java.util.List, java.util.Map)
      */
     public PlexusContainer createChildContainer( String theName, List theClasspathJars, Map theContext )
         throws PlexusContainerException
@@ -146,8 +146,8 @@
     /*
      * (non-Javadoc)
      * 
-     * @see org.codehaus.plexus.PlexusContainer#createChildContainer(java.lang.String,
-     *      java.util.List, java.util.Map, java.util.List)
+     * @see org.codehaus.plexus.PlexusContainer#createChildContainer(java.lang.String, java.util.List, java.util.Map,
+     *      java.util.List)
      */
     public PlexusContainer createChildContainer( String theName, List theClasspathJars, Map theContext,
                                                  List theDiscoveryListeners )
@@ -315,8 +315,7 @@
     /*
      * (non-Javadoc)
      * 
-     * @see org.codehaus.plexus.PlexusContainer#hasComponent(java.lang.String,
-     *      java.lang.String)
+     * @see org.codehaus.plexus.PlexusContainer#hasComponent(java.lang.String, java.lang.String)
      */
     public boolean hasComponent( String theRole, String theRoleHint )
     {
@@ -361,8 +360,7 @@
     /*
      * (non-Javadoc)
      * 
-     * @see org.codehaus.plexus.PlexusContainer#lookup(java.lang.String,
-     *      java.lang.String)
+     * @see org.codehaus.plexus.PlexusContainer#lookup(java.lang.String, java.lang.String)
      */
     public Object lookup( String theRole, String theRoleHint )
         throws ComponentLookupException



Mime
View raw message