Jenkinsfile

+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+asfMavenTlpStdBuild()

debian/changelog

-maven-enforcer (1.4.2-2) UNRELEASED; urgency=medium
+maven-enforcer (3.0.0~M2-1) unstable; urgency=medium
 
+  * Team upload.
+
+  [ Geert Stappers ]
   * VCS now at Salsa
 
- -- Geert Stappers <stappers@debian.org>  Sat, 30 Jun 2018 21:28:35 +0200
+  [ Emmanuel Bourg ]
+  * New upstream release
+    - Refreshed the patch
+  * Fixed the build failure with maven-dependency-tree 3.0 (Closes: #880888)
+  * Modified debian/watch to mangle the milestone versions
+  * Use XZ compression for the upstream tarball
+  * Track and download the new releases from GitHub
+  * Standards-Version updated to 4.2.1
+  * Switch to debhelper level 11
+
+ -- Emmanuel Bourg <ebourg@apache.org>  Thu, 11 Oct 2018 02:24:00 +0200
 
 maven-enforcer (1.4.2-1) unstable; urgency=medium
 

debian/compat

-10
+11

debian/control

@@ -3,8 +3,10 @@ Section: java
 Priority: optional
 Maintainer: Debian Java Maintainers <pkg-java-maintainers@lists.alioth.debian.org>
 Uploaders: tony mancill <tmancill@debian.org>
-Build-Depends: debhelper (>= 10), default-jdk, maven-debian-helper
-Build-Depends-Indep: bsh,
+Build-Depends:
+ bsh,
+ debhelper (>= 11),
+ default-jdk,
  libcommons-lang-java,
  libhamcrest-java,
  libjsr305-java,
@@ -15,8 +17,9 @@ Build-Depends-Indep: bsh,
  libmaven-plugin-tools-java (>= 2.5),
  libmaven3-core-java,
  libplexus-container-default1.5-java,
-                     libplexus-utils-java
-Standards-Version: 4.0.0
+ libplexus-utils-java,
+ maven-debian-helper
+Standards-Version: 4.2.1
 Vcs-Git: https://salsa.debian.org/java-team/maven-enforcer.git
 Vcs-Browser: https://salsa.debian.org/java-team/maven-enforcer/
 Homepage: https://maven.apache.org/enforcer/maven-enforcer-plugin/

debian/orig-tar.sh

-#!/bin/sh -e
-
-VERSION=$2
-TAR=../maven-enforcer_$VERSION.orig.tar.gz
-DIR=maven-enforcer-$VERSION
-TAG=$(echo "enforcer-$VERSION" | sed -re's/~(alpha|beta)/-\1-/')
-
-svn export http://svn.apache.org/repos/asf/maven/enforcer/tags/${TAG}/ $DIR
-GZIP=--best tar -c -z -f $TAR --exclude '*.jar' --exclude '*.class' $DIR
-rm -rf $DIR ../$TAG
-
-# move to directory 'tarballs'
-if [ -r .svn/deb-layout ]; then
-  . .svn/deb-layout
-  mv $TAR $origDir && echo "moved $TAR to $origDir"
-fi

debian/patches/maven-dependency-tree-compatibility.patch

+Description: Fixes the compatibility with maven-dependency-tree 3.x.
+ This patch is derived from the Maven 3 patch in Fedora.
+Author: Mikolaj Izdebski <mizdebsk@redhat.com>
+Forwarded: no
+Origin: fedora, https://src.fedoraproject.org/cgit/rpms/maven-enforcer.git/plain/0001-Port-to-Maven-3-API.patch
+Bug-Debian: https://bugs.debian.org/880888
+--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractBanDependencies.java
++++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractBanDependencies.java
+@@ -23,7 +23,9 @@
+ import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
+ import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
+ import org.apache.maven.plugin.logging.Log;
++import org.apache.maven.project.DefaultProjectBuildingRequest;
+ import org.apache.maven.project.MavenProject;
++import org.apache.maven.project.ProjectBuildingRequest;
+ import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
+ import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException;
+ import org.apache.maven.shared.dependency.graph.DependencyNode;
+@@ -53,10 +55,10 @@
+     {
+ 
+         // get the project
+-        MavenProject project = null;
++        ProjectBuildingRequest buildingRequest = null;
+         try
+         {
+-            project = (MavenProject) helper.evaluate( "${project}" );
++            buildingRequest = (ProjectBuildingRequest) helper.evaluate( "${session.projectBuildingRequest}" );
+         }
+         catch ( ExpressionEvaluationException eee )
+         {
+@@ -83,7 +85,7 @@
+         }
+ 
+         // get the correct list of dependencies
+-        Set<Artifact> dependencies = getDependenciesToCheck( project );
++        Set<Artifact> dependencies = getDependenciesToCheck( buildingRequest );
+ 
+         // look for banned dependencies
+         Set<Artifact> foundExcludes = checkDependencies( dependencies, helper.getLog() );
+@@ -114,12 +116,12 @@
+         return "Found Banned Dependency: " + artifact.getId() + "\n";
+     }
+ 
+-    protected Set<Artifact> getDependenciesToCheck( MavenProject project )
++    protected Set<Artifact> getDependenciesToCheck( ProjectBuildingRequest buildingRequest )
+     {
+         Set<Artifact> dependencies = null;
+         try
+         {
+-            DependencyNode node = graphBuilder.buildDependencyGraph( project, null );
++            DependencyNode node = graphBuilder.buildDependencyGraph( buildingRequest, null );
+             if ( searchTransitive )
+             {
+                 dependencies = getAllDescendants( node );
+--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BanTransitiveDependencies.java
++++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BanTransitiveDependencies.java
+@@ -27,7 +27,9 @@
+ import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
+ import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
+ import org.apache.maven.plugins.enforcer.utils.ArtifactMatcher;
++import org.apache.maven.project.DefaultProjectBuildingRequest;
+ import org.apache.maven.project.MavenProject;
++import org.apache.maven.project.ProjectBuildingRequest;
+ import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
+ import org.apache.maven.shared.dependency.graph.DependencyNode;
+ import org.apache.maven.shared.dependency.graph.internal.DefaultDependencyGraphBuilder;
+@@ -157,8 +159,8 @@
+ 
+         try
+         {
+-            MavenProject project = (MavenProject) helper.evaluate( "${project}" );
+-            rootNode = createDependencyGraphBuilder().buildDependencyGraph( project, null );
++            ProjectBuildingRequest buildingRequest = (ProjectBuildingRequest) helper.evaluate( "${session.projectBuildingRequest}" );
++            rootNode = createDependencyGraphBuilder().buildDependencyGraph( buildingRequest, null );
+         }
+         catch ( Exception e )
+         {
+--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DependencyConvergence.java
++++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DependencyConvergence.java
+@@ -34,10 +34,12 @@
+ import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
+ import org.apache.maven.plugin.logging.Log;
+ import org.apache.maven.plugins.enforcer.utils.DependencyVersionMap;
++import org.apache.maven.project.DefaultProjectBuildingRequest;
+ import org.apache.maven.project.MavenProject;
+-import org.apache.maven.shared.dependency.tree.DependencyNode;
+-import org.apache.maven.shared.dependency.tree.DependencyTreeBuilder;
+-import org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException;
++import org.apache.maven.project.ProjectBuildingRequest;
++import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
++import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException;
++import org.apache.maven.shared.dependency.graph.DependencyNode;
+ import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
+ import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
+ 
+@@ -74,17 +76,13 @@
+     {
+         try
+         {
+-            MavenProject project = (MavenProject) helper.evaluate( "${project}" );
+-            DependencyTreeBuilder dependencyTreeBuilder =
+-                (DependencyTreeBuilder) helper.getComponent( DependencyTreeBuilder.class );
++            ProjectBuildingRequest buildingRequest = (ProjectBuildingRequest) helper.evaluate( "${session.projectBuildingRequest}" );
++            DependencyGraphBuilder dependencyGraphBuilder =
++                (DependencyGraphBuilder) helper.getComponent( DependencyGraphBuilder.class );
+             ArtifactRepository repository = (ArtifactRepository) helper.evaluate( "${localRepository}" );
+-            ArtifactFactory factory = (ArtifactFactory) helper.getComponent( ArtifactFactory.class );
+-            ArtifactMetadataSource metadataSource =
+-                (ArtifactMetadataSource) helper.getComponent( ArtifactMetadataSource.class );
+-            ArtifactCollector collector = (ArtifactCollector) helper.getComponent( ArtifactCollector.class );
+             ArtifactFilter filter = null; // we need to evaluate all scopes
+-            DependencyNode node = dependencyTreeBuilder.buildDependencyTree( project, repository, factory,
+-                                                                             metadataSource, filter, collector );
++            buildingRequest.setLocalRepository( repository );
++            DependencyNode node = dependencyGraphBuilder.buildDependencyGraph( buildingRequest, filter );
+             return node;
+         }
+         catch ( ExpressionEvaluationException e )
+@@ -95,9 +93,9 @@
+         {
+             throw new EnforcerRuleException( "Unable to lookup a component " + e.getLocalizedMessage(), e );
+         }
+-        catch ( DependencyTreeBuilderException e )
++        catch ( DependencyGraphBuilderException e )
+         {
+-            throw new EnforcerRuleException( "Could not build dependency tree " + e.getLocalizedMessage(), e );
++            throw new EnforcerRuleException( "Could not build dependency graph " + e.getLocalizedMessage(), e );
+         }
+     }
+ 
+--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireUpperBoundDeps.java
++++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireUpperBoundDeps.java
+@@ -37,11 +37,13 @@
+ import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
+ import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
+ import org.apache.maven.plugin.logging.Log;
++import org.apache.maven.project.DefaultProjectBuildingRequest;
+ import org.apache.maven.project.MavenProject;
+-import org.apache.maven.shared.dependency.tree.DependencyNode;
+-import org.apache.maven.shared.dependency.tree.DependencyTreeBuilder;
+-import org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException;
+-import org.apache.maven.shared.dependency.tree.traversal.DependencyNodeVisitor;
++import org.apache.maven.project.ProjectBuildingRequest;
++import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
++import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException;
++import org.apache.maven.shared.dependency.graph.DependencyNode;
++import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
+ import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
+ import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
+ 
+@@ -105,18 +107,10 @@
+     {
+         try
+         {
+-            MavenProject project = (MavenProject) helper.evaluate( "${project}" );
+-            DependencyTreeBuilder dependencyTreeBuilder =
+-                (DependencyTreeBuilder) helper.getComponent( DependencyTreeBuilder.class );
+-            ArtifactRepository repository = (ArtifactRepository) helper.evaluate( "${localRepository}" );
+-            ArtifactFactory factory = (ArtifactFactory) helper.getComponent( ArtifactFactory.class );
+-            ArtifactMetadataSource metadataSource =
+-                (ArtifactMetadataSource) helper.getComponent( ArtifactMetadataSource.class );
+-            ArtifactCollector collector = (ArtifactCollector) helper.getComponent( ArtifactCollector.class );
+-            ArtifactFilter filter = null; // we need to evaluate all scopes
+-            DependencyNode node =
+-                dependencyTreeBuilder.buildDependencyTree( project, repository, factory, metadataSource, filter,
+-                                                           collector );
++            ProjectBuildingRequest buildingRequest = (ProjectBuildingRequest) helper.evaluate( "${session.projectBuildingRequest}" );
++            DependencyGraphBuilder dependencyGraphBuilder =
++                (DependencyGraphBuilder) helper.getComponent( DependencyGraphBuilder.class );
++            DependencyNode node = dependencyGraphBuilder.buildDependencyGraph( buildingRequest, null );
+             return node;
+         }
+         catch ( ExpressionEvaluationException e )
+@@ -127,7 +121,7 @@
+         {
+             throw new EnforcerRuleException( "Unable to lookup a component " + e.getLocalizedMessage(), e );
+         }
+-        catch ( DependencyTreeBuilderException e )
++        catch ( DependencyGraphBuilderException e )
+         {
+             throw new EnforcerRuleException( "Could not build dependency tree " + e.getLocalizedMessage(), e );
+         }
+--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/DependencyVersionMap.java
++++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/DependencyVersionMap.java
+@@ -26,8 +26,8 @@
+ 
+ import org.apache.maven.artifact.Artifact;
+ import org.apache.maven.plugin.logging.Log;
+-import org.apache.maven.shared.dependency.tree.DependencyNode;
+-import org.apache.maven.shared.dependency.tree.traversal.DependencyNodeVisitor;
++import org.apache.maven.shared.dependency.graph.DependencyNode;
++import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
+ 
+ /**
+  * @author Brian Fox
+--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedPlugins.java
++++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedPlugins.java
+@@ -23,6 +23,7 @@
+ 
+ import org.apache.maven.artifact.Artifact;
+ import org.apache.maven.project.MavenProject;
++import org.apache.maven.project.ProjectBuildingRequest;
+ 
+ /**
+  * This rule checks that lists of plugins are not included.
+@@ -33,9 +34,9 @@
+     extends BannedDependencies
+ {
+     @Override
+-    protected Set<Artifact> getDependenciesToCheck( MavenProject project )
++    protected Set<Artifact> getDependenciesToCheck( ProjectBuildingRequest buildingRequest )
+     {
+-        return project.getPluginArtifacts();
++        return buildingRequest.getProject().getPluginArtifacts();
+     }
+ 
+     @Override

debian/patches/maven-plugin-tools-dependency-version.patch

@@ -10,7 +10,7 @@ Forwarded: no
 
 --- a/maven-enforcer-plugin/pom.xml
 +++ b/maven-enforcer-plugin/pom.xml
-@@ -81,6 +81,7 @@
+@@ -77,6 +77,7 @@
        <groupId>org.apache.maven.plugin-tools</groupId>
        <artifactId>maven-plugin-annotations</artifactId>
        <scope>provided</scope>

debian/patches/series

 maven-plugin-tools-dependency-version.patch
+maven-dependency-tree-compatibility.patch

debian/rules

 #!/usr/bin/make -f
 
 %:
-	dh $@ --buildsystem=maven
-
-get-orig-source:
-	uscan --download-current-version --force-download --rename
+	dh $@

debian/watch

 version=4
-opts="uversionmangle=s/-(alpha|beta)-/~$1/" \
-  http://svn.apache.org/repos/asf/maven/enforcer/tags/ \
-  enforcer-(\d.*)/ debian debian/orig-tar.sh
+opts="repack,compression=xz,uversionmangle=s/-(alpha|beta|M)/~$1/" \
+https://github.com/apache/maven-enforcer/tags .*/enforcer-(\d.*).tar.gz

enforcer-api/pom.xml

@@ -24,7 +24,7 @@
   <parent>
     <groupId>org.apache.maven.enforcer</groupId>
     <artifactId>enforcer</artifactId>
-    <version>1.4.2</version>
+    <version>3.0.0-M2</version>
   </parent>
 
   <artifactId>enforcer-api</artifactId>

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java

@@ -26,7 +26,7 @@ import javax.annotation.Nullable;
  * Interface to be implemented by any rules executed by the enforcer.
  *
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
- * @version $Id: EnforcerRule.java 1663790 2015-03-03 21:07:38Z khmarbaise $
+ * @version $Id$
  */
 public interface EnforcerRule
 {
@@ -57,7 +57,10 @@ public interface EnforcerRule
     boolean isCacheable();
 
     /**
-     * Checks if cached result is valid.
+     * If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to
+     * 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 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)

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule2.java

@@ -25,7 +25,7 @@ import javax.annotation.Nonnull;
  * Interface to be implemented by any rules as of version 2.0 executed by the enforcer.
  *
  * @author Mirko Friedenhagen
- * @version $Id: EnforcerRule2.java 1663790 2015-03-03 21:07:38Z khmarbaise $
+ * @version $Id$
  * @since 1.4
  */
 public interface EnforcerRule2 extends EnforcerRule

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.java

@@ -59,7 +59,7 @@ public interface EnforcerRuleHelper
      * @throws ComponentLookupException the component lookup exception
      */
     @Nonnull
-    Object getComponent ( Class clazz )
+    <T> T getComponent ( Class<T> clazz )
         throws ComponentLookupException;
 
     /**
@@ -88,6 +88,19 @@ public interface EnforcerRuleHelper
     Object getComponent ( String role, String roleHint )
         throws ComponentLookupException;
 
+    /**
+     * Gets the component.
+     *
+     * @param clazz the clazz
+     * @param roleHint the role hint
+     *
+     * @return the component
+     *
+     * @throws ComponentLookupException the component lookup exception
+     */
+    <T> T getComponent ( Class<T> clazz, String roleHint )
+        throws ComponentLookupException;
+    
     /**
      * Gets the component map.
      *
@@ -97,7 +110,7 @@ public interface EnforcerRuleHelper
      *
      * @throws ComponentLookupException the component lookup exception
      */
-    Map getComponentMap ( String role )
+    Map<String, ?> getComponentMap ( String role )
         throws ComponentLookupException;
 
     /**
@@ -109,7 +122,7 @@ public interface EnforcerRuleHelper
      *
      * @throws ComponentLookupException the component lookup exception
      */
-    List getComponentList ( String role )
+    List<?> getComponentList ( String role )
         throws ComponentLookupException;
 
     /**

enforcer-rules/pom.xml

@@ -24,7 +24,7 @@
   <parent>
     <groupId>org.apache.maven.enforcer</groupId>
     <artifactId>enforcer</artifactId>
-    <version>1.4.2</version>
+    <version>3.0.0-M2</version>
   </parent>
 
   <artifactId>enforcer-rules</artifactId>
@@ -61,7 +61,6 @@
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-lang3</artifactId>
-      <version>3.5</version>
     </dependency>
     <dependency>
       <groupId>commons-codec</groupId>
@@ -90,11 +89,6 @@
       <groupId>org.apache.maven.shared</groupId>
       <artifactId>maven-dependency-tree</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.codehaus.plexus</groupId>
-      <artifactId>plexus-i18n</artifactId>
-      <version>1.0-beta-6</version>
-    </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
       <artifactId>maven-compat</artifactId>

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractBanDependencies.java

@@ -36,7 +36,7 @@ import java.util.Set;
  * Abstract Rule for banning dependencies.
  *
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
- * @version $Id: AbstractBanDependencies.java 1630934 2014-10-10 16:35:26Z khmarbaise $
+ * @version $Id$
  */
 public abstract class AbstractBanDependencies
     extends AbstractNonCacheableEnforcerRule
@@ -47,12 +47,7 @@ public abstract class AbstractBanDependencies
 
     private transient DependencyGraphBuilder graphBuilder;
 
-    /**
-     * Execute the rule.
-     *
-     * @param helper the helper
-     * @throws EnforcerRuleException the enforcer rule exception
-     */
+    @Override
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.java

@@ -26,40 +26,26 @@ import org.apache.maven.enforcer.rule.api.EnforcerRule;
  * that don't need caching... it saves implementing a bunch of methods.
  *
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
- * @version $Id: AbstractNonCacheableEnforcerRule.java 805190 2009-08-17 22:30:49Z hboutemy $
+ * @version $Id$
  */
 public abstract class AbstractNonCacheableEnforcerRule
     extends AbstractStandardEnforcerRule
 {
-
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#getCacheId()
-     */
+    @Override
     public String getCacheId()
     {
         return "0";
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isCacheable()
-     */
+    @Override
     public boolean isCacheable()
     {
         return false;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule)
-     */
+    @Override
     public boolean isResultValid( EnforcerRule cachedRule )
     {
         return false;
     }
-
 }

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java

@@ -27,7 +27,7 @@ import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
  *
  * @author Paul Gier
  * @author <a href='mailto:marvin[at]marvinformatics[dot]com'>Marvin Froeder</a>
- * @version $Id: AbstractPropertyEnforcerRule.java 1697215 2015-08-23 16:27:17Z khmarbaise $
+ * @version $Id$
  */
 public abstract class AbstractPropertyEnforcerRule
     extends AbstractNonCacheableEnforcerRule
@@ -94,13 +94,7 @@ public abstract class AbstractPropertyEnforcerRule
         return regexMessage;
     }
 
-
-    /**
-     * Execute the rule.
-     *
-     * @param helper the helper
-     * @throws EnforcerRuleException the enforcer rule exception
-     */
+    @Override
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractRequireFiles.java

@@ -59,11 +59,7 @@ public abstract class AbstractRequireFiles
      */
     abstract String getErrorMsg();
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)
-     */
+    @Override
     public void execute( EnforcerRuleHelper helper )
         throws EnforcerRuleException
     {
@@ -114,14 +110,7 @@ public abstract class AbstractRequireFiles
         }
     }
 
-    /**
-     * If your rule is cacheable, you must return a unique id when parameters or conditions change that would cause the
-     * 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
-     */
+    @Override
     public String getCacheId()
     {
         return Integer.toString( hashCode( files ) );
@@ -149,27 +138,13 @@ public abstract class AbstractRequireFiles
         return hash;
     }
 
-    /**
-     * 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 <code>true</code> if rule is cacheable
-     */
+    @Override
     public boolean isCacheable()
     {
         return true;
     }
 
-    /**
-     * If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to
-     * 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 cachedRule the cached rule
-     * @return <code>true</code> if the stored results are valid for the same id.
-     */
+    @Override
     public boolean isResultValid( EnforcerRule cachedRule )
     {
         return true;

enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.java

@@ -49,11 +49,7 @@ public abstract class AbstractStandardEnforcerRule
         return message;
     }
 
-    /**
-     * Returns the level of enforcement.
-     *
-     * @return level
-     */
+    @Override
     public EnforcerLevel getLevel()
     {
         return level;