Author: khmarbaise Date: Sun Apr 20 12:19:41 2014 New Revision: 1588746 URL: http://svn.apache.org/r1588746 Log: - Small code clean ups. - Fixed typos. - Added JavaDoc
Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergence.java maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergenceTest.java Modified: maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergence.java URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergence.java?rev=1588746&r1=1588745&r2=1588746&view=diff ============================================================================== --- maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergence.java (original) +++ maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergence.java Sun Apr 20 12:19:41 2014 @@ -277,6 +277,15 @@ public class ReactorModuleConvergence return isGAPartOfTheReactor( dependency.getGroupId(), dependency.getArtifactId(), sortedProjects ); } + /** + * This will check if the given <code>groupId/artifactId</code> is part of the + * current reactor. + * + * @param groupId The groupId + * @param artifactId The artifactId + * @param sortedProjects The list of projects within the reactor. + * @return true if the groupId/artifactId is part of the reactor false otherwise. + */ private boolean isGAPartOfTheReactor( String groupId, String artifactId, List<MavenProject> sortedProjects ) { boolean result = false; @@ -309,6 +318,7 @@ public class ReactorModuleConvergence logger.debug( "Project: " + mavenProject.getId() ); if ( !hasParent( mavenProject ) ) { + //TODO: Should add an option to force having a parent? if ( mavenProject.isExecutionRoot() ) { logger.debug( "The root does not need having a parent." ); @@ -324,6 +334,13 @@ public class ReactorModuleConvergence return result; } + /** + * Convenience method to handle adding a dependency to the Map of List. + * + * @param result The result List which should be handled. + * @param project The MavenProject which will be added. + * @param dependency The dependency which will be added. + */ private void addDep( Map<MavenProject, List<Dependency>> result, MavenProject project, Dependency dependency ) { if ( result.containsKey( project ) ) @@ -346,7 +363,7 @@ public class ReactorModuleConvergence /** * Go through the list of modules in the builds and check if we have dependencies. If yes we will check every - * dependency based on groupId/artifactId if it belong to the multi module build. In such a case it will be checked + * dependency based on groupId/artifactId if it belongs to the multi module build. In such a case it will be checked * if the version does fit the version in the rest of build. * * @param reactorVersion The version of the reactor. Modified: maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergenceTest.java URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergenceTest.java?rev=1588746&r1=1588745&r2=1588746&view=diff ============================================================================== --- maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergenceTest.java (original) +++ maven/enforcer/trunk/enforcer-rules/src/test/java/org/apache/maven/plugins/enforcer/ReactorModuleConvergenceTest.java Sun Apr 20 12:19:41 2014 @@ -86,9 +86,6 @@ public class ReactorModuleConvergenceTes MavenProject mp2 = createProjectChild1( mp1 ); MavenProject mp3 = createProjectChild2( mp1 ); - assertTrue( mp2.getParent() == mp1 ); - assertTrue( mp3.getParent() == mp1 ); - List<MavenProject> theList = Arrays.asList( mp1, mp2, mp3 ); when( session.getSortedProjects() ).thenReturn( theList ); @@ -231,7 +228,7 @@ public class ReactorModuleConvergenceTes MavenProject mp2 = createProjectChild1( mp1 ); Dependency goodDependency = createDependency( "org.junit", "junit", "2.0" ); - + Dependency wrongDepFromReactory = createDependency( "org.apache.enforcer", "m2", "1.1-SNAPSHOT" ); List<Dependency> depList = Arrays.asList( goodDependency, wrongDepFromReactory ); when( mp2.getDependencies() ).thenReturn( depList );