svn commit: r781137 - in /maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model: ModelBuildingRequest.java inheritance/InheritanceAssembler.java profile/ProfileInjector.java

[be...@apache.org]

Author: bentmann
Date: Tue Jun  2 19:39:12 2009
New Revision: 781137

URL: http://svn.apache.org/viewvc?rev=781137&view=rev
Log:
o Extended API docs

Modified:
    maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuildingRequest.java
    maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/InheritanceAssembler.java
    maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/profile/ProfileInjector.java

Modified: maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuildingRequest.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuildingRequest.java?rev=781137&r1=781136&r2=781137&view=diff
==============================================================================
--- maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuildingRequest.java (original)
+++ maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelBuildingRequest.java Tue Jun  2 19:39:12 2009
@@ -25,7 +25,7 @@
 import org.apache.maven.model.profile.ProfileActivationContext;
 
 /**
- * Collects settings that control building of effective models.
+ * Collects settings that control the building of effective models.
  * 
  * @author Benjamin Bentmann
  */
@@ -41,7 +41,9 @@
     boolean istLenientValidation();
 
     /**
-     * Sets the level of validation to perform on processed models. By default, models are validated in strict mode.
+     * Sets the level of validation to perform on processed models. For building of projects, strict validation should
+     * be used to ensure proper building. For the mere retrievel of dependencies during artifact resolution, lenient
+     * validation should be used to account for models of poor quality. By default, models are validated in strict mode.
      * 
      * @param lenientValidation A flag whether validation should be lenient instead of strict. For building of projects,
      *            strict validation should be used to ensure proper building. For the mere retrievel of dependencies

Modified: maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/InheritanceAssembler.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/InheritanceAssembler.java?rev=781137&r1=781136&r2=781137&view=diff
==============================================================================
--- maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/InheritanceAssembler.java (original)
+++ maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/InheritanceAssembler.java Tue Jun  2 19:39:12 2009
@@ -31,7 +31,9 @@
 {
 
     /**
-     * Merges values from the specified parent model into the given child model.
+     * Merges values from the specified parent model into the given child model. Implementations are expected to keep
+     * parent and child completely decoupled by injecting deep copies of objects into the child rather than the original
+     * objects from the parent.
      * 
      * @param child The child model into which to merge the values inherited from the parent, must not be
      *            <code>null</code>.

Modified: maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/profile/ProfileInjector.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/profile/ProfileInjector.java?rev=781137&r1=781136&r2=781137&view=diff
==============================================================================
--- maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/profile/ProfileInjector.java (original)
+++ maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/profile/ProfileInjector.java Tue Jun  2 19:39:12 2009
@@ -32,7 +32,8 @@
 {
 
     /**
-     * Merges values from the specified profile into the given model.
+     * Merges values from the specified profile into the given model. Implementations are expected to keep the profile
+     * and model completely decoupled by injecting deep copies rather than the original objects from the profile.
      * 
      * @param model The model into which to merge the values defined by the profile, must not be <code>null</code>.
      * @param profile The (read-only) profile whose values should be injected, may be <code>null</code>.