From 1329516567b8c552d9bb92f5dffa5c6d8bf2bdfa Mon Sep 17 00:00:00 2001
From: Benjamin Bentmann <bentmann@apache.org>
Date: Wed, 22 Jul 2009 10:00:43 +0000
Subject: [PATCH] o Added API docs

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@796656 13f79535-47bb-0310-9956-ffa450edef68
---
 .../project/DefaultModelBuildingListener.java | 31 +++++++++++++++++--
 1 file changed, 28 insertions(+), 3 deletions(-)

diff --git a/maven-core/src/main/java/org/apache/maven/project/DefaultModelBuildingListener.java b/maven-core/src/main/java/org/apache/maven/project/DefaultModelBuildingListener.java
index 68b7e58f35..23068a9f40 100644
--- a/maven-core/src/main/java/org/apache/maven/project/DefaultModelBuildingListener.java
+++ b/maven-core/src/main/java/org/apache/maven/project/DefaultModelBuildingListener.java
@@ -28,7 +28,7 @@ import org.apache.maven.model.building.ModelBuildingEvent;
 import org.codehaus.plexus.classworlds.realm.ClassRealm;
 
 /**
- * Processes events from the model builder.
+ * Processes events from the model builder while building the effective model for a {@link MavenProject} instance.
  * 
  * @author Benjamin Bentmann
  */
@@ -64,16 +64,39 @@ class DefaultModelBuildingListener
         this.pluginRepositories = projectBuildingRequest.getPluginArtifactRepositories();
     }
 
+    /**
+     * Gets the project realm that hosts the build extensions.
+     * 
+     * @return The project realm or {@code null} if the project requires no extensions.
+     */
     public ClassRealm getProjectRealm()
     {
         return projectRealm;
     }
 
+    /**
+     * Gets the effective remote artifact repositories for the project. The repository list is created from the
+     * repositories given by {@link ProjectBuildingRequest#getRemoteRepositories()} and the repositories given in the
+     * POM, i.e. {@link Model#getRepositories()}. The POM repositories themselves also contain any repositories
+     * contributed by external profiles as specified in {@link ProjectBuildingRequest#getProfiles()}. Furthermore, the
+     * repositories have already been mirrored.
+     * 
+     * @return The remote artifact repositories for the project.
+     */
     public List<ArtifactRepository> getRemoteRepositories()
     {
         return remoteRepositories;
     }
 
+    /**
+     * Gets the effective remote plugin repositories for the project. The repository list is created from the
+     * repositories given by {@link ProjectBuildingRequest#getPluginArtifactRepositories()} and the repositories given
+     * in the POM, i.e. {@link Model#getPluginRepositories()}. The POM repositories themselves also contain any
+     * repositories contributed by external profiles as specified in {@link ProjectBuildingRequest#getProfiles()}.
+     * Furthermore, the repositories have already been mirrored.
+     * 
+     * @return The remote plugin repositories for the project.
+     */
     public List<ArtifactRepository> getPluginRepositories()
     {
         return pluginRepositories;
@@ -85,9 +108,11 @@ class DefaultModelBuildingListener
     {
         Model model = event.getModel();
 
-        remoteRepositories = projectBuildingHelper.createArtifactRepositories( model.getRepositories(), remoteRepositories );
+        remoteRepositories =
+            projectBuildingHelper.createArtifactRepositories( model.getRepositories(), remoteRepositories );
 
-        pluginRepositories = projectBuildingHelper.createArtifactRepositories( model.getPluginRepositories(), pluginRepositories );
+        pluginRepositories =
+            projectBuildingHelper.createArtifactRepositories( model.getPluginRepositories(), pluginRepositories );
 
         if ( event.getRequest().isProcessPlugins() )
         {