Author: carlos
Date: Fri Mar 23 10:50:03 2007
New Revision: 521826

URL: http://svn.apache.org/viewvc?view=rev&rev=521826
Log:
Merge 521825 from trunk. Add javadocs for getArtifacts and 
getDependencyArtifacts

Modified:
    
maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/MavenProject.java
    
maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java

Modified: 
maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/MavenProject.java
URL: 
http://svn.apache.org/viewvc/maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/MavenProject.java?view=diff&rev=521826&r1=521825&r2=521826
==============================================================================
--- 
maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/MavenProject.java
 (original)
+++ 
maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/MavenProject.java
 Fri Mar 23 10:50:03 2007
@@ -1096,6 +1096,13 @@
         this.artifactMap = null;
     }
 
+    /**
+     * All dependencies that this project has, including transitive ones.
+     * Contents are lazily populated, so depending on what phases have run 
dependencies in some scopes won't be included.
+     * eg. if only compile phase has run, dependencies with scope test won't 
be included. 
+     * @return [EMAIL PROTECTED] Set} < [EMAIL PROTECTED] Artifact} >
+     * @see #getDependencyArtifacts() to get only direct dependencies
+     */
     public Set getArtifacts()
     {
         return artifacts == null ? Collections.EMPTY_SET : artifacts;
@@ -1459,6 +1466,11 @@
         pomWriter.write( writer, getOriginalModel() );
     }
 
+    /**
+     * Direct dependencies that this project has.
+     * @return [EMAIL PROTECTED] Set} < [EMAIL PROTECTED] Artifact} >
+     * @see #getArtifacts() to get all transitive dependencies
+     */
     public Set getDependencyArtifacts()
     {
         return dependencyArtifacts;
@@ -1537,6 +1549,7 @@
 
     /**
      * @todo the lazy initialisation of this makes me uneasy.
+     * @return [EMAIL PROTECTED] Set} < [EMAIL PROTECTED] Artifact} >
      */
     public Set createArtifacts( ArtifactFactory artifactFactory, String 
inheritedScope,
                                 ArtifactFilter dependencyFilter )

Modified: 
maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java
URL: 
http://svn.apache.org/viewvc/maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java?view=diff&rev=521826&r1=521825&r2=521826
==============================================================================
--- 
maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java
 (original)
+++ 
maven/components/branches/maven-2.0.x/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java
 Fri Mar 23 10:50:03 2007
@@ -300,6 +300,7 @@
 
     /**
      * @todo desperately needs refactoring. It's just here because it's 
implementation is maven-project specific
+     * @return [EMAIL PROTECTED] Set} < [EMAIL PROTECTED] Artifact} >
      */
     public static Set createArtifacts( ArtifactFactory artifactFactory, List 
dependencies, String inheritedScope,
                                        ArtifactFilter dependencyFilter, 
MavenProject project )


Reply via email to