doc improvements and shortening variable names in the hope of making it bit more readable

maven-plugin/src/main/java/hudson/maven/MavenEmbedderRequest.java

@@ -229,6 +229,11 @@ public class MavenEmbedderRequest
         return validationLevel;
     }
 
+    /**
+     * Controls the level of error checks done while parsing POM.
+     *
+     * @see ModelBuildingRequest#VALIDATION_LEVEL_MAVEN_3_0
+     */
     public MavenEmbedderRequest setValidationLevel( int validationLevel ) {
         this.validationLevel = validationLevel;
         return this;

maven-plugin/src/main/java/hudson/maven/MavenModuleSet.java

@@ -248,7 +248,9 @@ public class MavenModuleSet extends AbstractMavenProject<MavenModuleSet,MavenMod
     /**
      * parameter for validation level during pom parsing by default the one corresponding
      * to the maven version used (2 or 3)
+     *
      * @since 1.394
+     * @see DescriptorImpl#mavenValidationLevels
      */    
     private int mavenValidationLevel = -1;
 

maven-plugin/src/main/java/hudson/maven/MavenModuleSetBuild.java

@@ -25,6 +25,8 @@
 package hudson.maven;
 
 import static hudson.model.Result.FAILURE;
+import static org.apache.maven.model.building.ModelBuildingRequest.VALIDATION_LEVEL_MAVEN_3_0;
+
 import hudson.AbortException;
 import hudson.EnvVars;
 import hudson.FilePath;
@@ -1172,16 +1174,16 @@ public class MavenModuleSetBuild extends AbstractMavenBuild<MavenModuleSet,Maven
             }
 
             try {
-                MavenEmbedderRequest mavenEmbedderRequest = new MavenEmbedderRequest( listener, mavenHome.getHomeDir(),
+                MavenEmbedderRequest mer = new MavenEmbedderRequest( listener, mavenHome.getHomeDir(),
                                                                                       profiles, properties,
                                                                                       privateRepository, settingsLoc );
-                mavenEmbedderRequest.setTransferListener( new SimpleTransferListener(listener) );
-                mavenEmbedderRequest.setUpdateSnapshots( this.updateSnapshots );
+                mer.setTransferListener(new SimpleTransferListener(listener));
+                mer.setUpdateSnapshots(this.updateSnapshots);
                 
-                mavenEmbedderRequest.setProcessPlugins( this.processPlugins );
-                mavenEmbedderRequest.setResolveDependencies( this.resolveDependencies );
+                mer.setProcessPlugins(this.processPlugins);
+                mer.setResolveDependencies(this.resolveDependencies);
                 if (globalSettings != null) {
-                    mavenEmbedderRequest.setGlobalSettings( new File(globalSettings) );
+                    mer.setGlobalSettings(new File(globalSettings));
                 }
                 
                 // FIXME handle 3.1 level when version will be here : no rush :-)
@@ -1189,28 +1191,28 @@ public class MavenModuleSetBuild extends AbstractMavenBuild<MavenModuleSet,Maven
                 ReactorReader reactorReader = null;
                 boolean maven3OrLater = MavenUtil.maven3orLater(mavenVersion);
                 if (maven3OrLater) {
-                    mavenEmbedderRequest.setValidationLevel( ModelBuildingRequest.VALIDATION_LEVEL_MAVEN_3_0 );
+                    mer.setValidationLevel(VALIDATION_LEVEL_MAVEN_3_0);
                 } else {
                     reactorReader = new ReactorReader( new HashMap<String, MavenProject>(), new File(workspaceProper) );
-                    mavenEmbedderRequest.setWorkspaceReader( reactorReader );
+                    mer.setWorkspaceReader(reactorReader);
                 }
 
                 {// create a classloader that loads extensions
                     List<URL> urls = plexusContributors.getPlexusComponentJars();
                     if (!urls.isEmpty()) {
-                        mavenEmbedderRequest.setClassLoader(
+                        mer.setClassLoader(
                                 new URLClassLoader(urls.toArray(new URL[urls.size()]),
-                                mavenEmbedderRequest.getClassLoader()));
+                                        mer.getClassLoader()));
                     }
                 }
                 
                 if (this.mavenValidationLevel >= 0) {
-                    mavenEmbedderRequest.setValidationLevel( this.mavenValidationLevel );
+                    mer.setValidationLevel(this.mavenValidationLevel);
                 }
                 
                 //mavenEmbedderRequest.setClassLoader( MavenEmbedderUtils.buildClassRealm( mavenHome.getHomeDir(), null, null ) );
                 
-                MavenEmbedder embedder = MavenUtil.createEmbedder( mavenEmbedderRequest );
+                MavenEmbedder embedder = MavenUtil.createEmbedder( mer );
                 
                 MavenProject rootProject = null;
                 

maven-plugin/src/main/java/hudson/maven/MavenUtil.java

@@ -144,7 +144,7 @@ public class MavenUtil {
      *
      */
     @SuppressWarnings("RV_RETURN_VALUE_IGNORED_BAD_PRACTICE")
-    public static MavenEmbedder createEmbedder(MavenEmbedderRequest mavenEmbedderRequest) throws MavenEmbedderException, IOException {
+    public static MavenEmbedder createEmbedder(MavenEmbedderRequest mer) throws MavenEmbedderException, IOException {
         
         
         MavenRequest mavenRequest = new MavenRequest();
@@ -155,48 +155,48 @@ public class MavenUtil {
         if(!m2Home.exists())
             throw new AbortException("Failed to create "+m2Home);
 
-        if (mavenEmbedderRequest.getPrivateRepository()!=null)
-            mavenRequest.setLocalRepositoryPath( mavenEmbedderRequest.getPrivateRepository() );
+        if (mer.getPrivateRepository()!=null)
+            mavenRequest.setLocalRepositoryPath( mer.getPrivateRepository() );
 
-        if (mavenEmbedderRequest.getProfiles() != null) {
-            mavenRequest.setProfiles(Arrays.asList( StringUtils.split( mavenEmbedderRequest.getProfiles(), "," ) ));    
+        if (mer.getProfiles() != null) {
+            mavenRequest.setProfiles(Arrays.asList( StringUtils.split( mer.getProfiles(), "," ) ));
         }
         
 
-        if ( mavenEmbedderRequest.getAlternateSettings() != null ) {
-            mavenRequest.setUserSettingsFile( mavenEmbedderRequest.getAlternateSettings().getAbsolutePath() );
+        if ( mer.getAlternateSettings() != null ) {
+            mavenRequest.setUserSettingsFile( mer.getAlternateSettings().getAbsolutePath() );
         } else {
             mavenRequest.setUserSettingsFile( new File( m2Home, "settings.xml" ).getAbsolutePath() );
         }
 
-        if ( mavenEmbedderRequest.getGlobalSettings() != null) {
-            mavenRequest.setGlobalSettingsFile( mavenEmbedderRequest.getGlobalSettings().getAbsolutePath() );
+        if ( mer.getGlobalSettings() != null) {
+            mavenRequest.setGlobalSettingsFile( mer.getGlobalSettings().getAbsolutePath() );
         } else {
-            mavenRequest.setGlobalSettingsFile( new File( mavenEmbedderRequest.getMavenHome(), "conf/settings.xml" ).getAbsolutePath() );
+            mavenRequest.setGlobalSettingsFile( new File( mer.getMavenHome(), "conf/settings.xml" ).getAbsolutePath() );
         }
         
-        if (mavenEmbedderRequest.getWorkspaceReader() != null ) {
-            mavenRequest.setWorkspaceReader( mavenEmbedderRequest.getWorkspaceReader() );
+        if (mer.getWorkspaceReader() != null ) {
+            mavenRequest.setWorkspaceReader( mer.getWorkspaceReader() );
         }
         
-        mavenRequest.setUpdateSnapshots(mavenEmbedderRequest.isUpdateSnapshots());
+        mavenRequest.setUpdateSnapshots(mer.isUpdateSnapshots());
 
         // TODO olamy check this sould be userProperties 
-        mavenRequest.setSystemProperties(mavenEmbedderRequest.getSystemProperties());
+        mavenRequest.setSystemProperties(mer.getSystemProperties());
 
-        if (mavenEmbedderRequest.getTransferListener() != null) {
+        if (mer.getTransferListener() != null) {
             if (debugMavenEmbedder) {
-                mavenEmbedderRequest.getListener().getLogger()
-                    .println( "use transfertListener " + mavenEmbedderRequest.getTransferListener().getClass().getName() );
+                mer.getListener().getLogger()
+                    .println( "use transfertListener " + mer.getTransferListener().getClass().getName() );
             }
-            mavenRequest.setTransferListener( mavenEmbedderRequest.getTransferListener() );
+            mavenRequest.setTransferListener( mer.getTransferListener() );
         }
         EmbedderLoggerImpl logger =
-            new EmbedderLoggerImpl( mavenEmbedderRequest.getListener(), debugMavenEmbedder ? org.codehaus.plexus.logging.Logger.LEVEL_DEBUG
+            new EmbedderLoggerImpl( mer.getListener(), debugMavenEmbedder ? org.codehaus.plexus.logging.Logger.LEVEL_DEBUG
                             : org.codehaus.plexus.logging.Logger.LEVEL_INFO );
         mavenRequest.setMavenLoggerManager( logger );
         
-        ClassLoader mavenEmbedderClassLoader = mavenEmbedderRequest.getClassLoader();
+        ClassLoader mavenEmbedderClassLoader = mer.getClassLoader();
 
         {// are we loading the right components.xml? (and not from Maven that's running Jetty, if we are running in "mvn hudson-dev:run" or "mvn hpi:run"?
             Enumeration<URL> e = mavenEmbedderClassLoader.getResources("META-INF/plexus/components.xml");
@@ -206,9 +206,9 @@ public class MavenUtil {
             }
         }
 
-        mavenRequest.setProcessPlugins( mavenEmbedderRequest.isProcessPlugins() );
-        mavenRequest.setResolveDependencies( mavenEmbedderRequest.isResolveDependencies() );
-        mavenRequest.setValidationLevel( mavenEmbedderRequest.getValidationLevel() );
+        mavenRequest.setProcessPlugins( mer.isProcessPlugins() );
+        mavenRequest.setResolveDependencies( mer.isResolveDependencies() );
+        mavenRequest.setValidationLevel( mer.getValidationLevel() );
             
         // TODO check this MaskingClassLoader with maven 3 artifacts
         MavenEmbedder maven = new MavenEmbedder( mavenEmbedderClassLoader, mavenRequest );