svn commit: r781120 - /maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuilder.java

[be...@apache.org]

Author: bentmann
Date: Tue Jun  2 18:49:44 2009
New Revision: 781120

URL: http://svn.apache.org/viewvc?rev=781120&view=rev
Log:
o Added some API docs

Modified:
    maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuilder.java

Modified: maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuilder.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuilder.java?rev=781120&r1=781119&r2=781120&view=diff
==============================================================================
--- maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuilder.java (original)
+++ maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuilder.java Tue Jun  2 18:49:44 2009
@@ -24,14 +24,39 @@
 import org.apache.maven.model.resolution.ModelResolver;
 
 /**
+ * Builds the effective model from a POM.
+ * 
  * @author Benjamin Bentmann
  */
 public interface ModelBuilder
 {
 
+    /**
+     * Builds the effective model of the specified POM file. Note that this method overload is meant to build the
+     * effective model for the build process of a project. Hence the effective model supports the notion of a project
+     * directory.
+     * 
+     * @param pomFile The POM file of the project to build the effective model from, must not be {@code null}.
+     * @param request The model building request that holds further settings, must not be {@code null}.
+     * @param modelResolver The model resolver used to resolve parent POMs that are not locally reachable from the
+     *            project directory, must not be {@code null}.
+     * @return The result of the model building, never {@code null}.
+     * @throws ModelBuildingException If the effective model could not be built.
+     */
     ModelBuildingResult build( File pomFile, ModelBuildingRequest request, ModelResolver modelResolver )
         throws ModelBuildingException;
 
+    /**
+     * Builds the effective model for the specified POM. In contrast to
+     * {@link #build(File, ModelBuildingRequest, ModelResolver)} the resulting model does not support the notion of a
+     * project directory. As a consequence, parent POMs are always resolved via the provided model resolver.
+     * 
+     * @param modelSource The source of the POM, must not be {@code null}.
+     * @param request The model building request that holds further settings, must not be {@code null}.
+     * @param modelResolver The model resolver used to resolve parent POMs, must not be {@code null}.
+     * @return The result of the model building, never {@code null}.
+     * @throws ModelBuildingException If the effective model could not be built.
+     */
     ModelBuildingResult build( ModelSource modelSource, ModelBuildingRequest request, ModelResolver modelResolver )
         throws ModelBuildingException;