Author: carlos
Date: Fri Mar 23 10:47:47 2007
New Revision: 521825
URL: http://svn.apache.org/viewvc?view=rev&rev=521825
Log:
Add javadocs for getArtifacts and getDependencyArtifacts
Modified:
maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/MavenProject.java
maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java
Modified:
maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/MavenProject.java
URL:
http://svn.apache.org/viewvc/maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/MavenProject.java?view=diff&rev=521825&r1=521824&r2=521825
==============================================================================
---
maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/MavenProject.java
(original)
+++
maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/MavenProject.java
Fri Mar 23 10:47:47 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;
@@ -1465,6 +1472,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;
@@ -1543,6 +1555,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/trunk/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java
URL:
http://svn.apache.org/viewvc/maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java?view=diff&rev=521825&r1=521824&r2=521825
==============================================================================
---
maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java
(original)
+++
maven/components/trunk/maven-project/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java
Fri Mar 23 10:47:47 2007
@@ -312,6 +312,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 )
