Add javadocs for getArtifacts and getDependencyArtifacts

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@521825 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Carlos Sanchez Gonzalez 2007-03-23 17:47:47 +00:00
parent 589c23e289
commit 04d3f322fe
2 changed files with 14 additions and 0 deletions

View File

@ -1096,6 +1096,13 @@ public class MavenProject
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 {@link Set} < {@link Artifact} >
* @see #getDependencyArtifacts() to get only direct dependencies
*/
public Set getArtifacts()
{
return artifacts == null ? Collections.EMPTY_SET : artifacts;
@ -1465,6 +1472,11 @@ public class MavenProject
pomWriter.write( writer, getOriginalModel() );
}
/**
* Direct dependencies that this project has.
* @return {@link Set} < {@link Artifact} >
* @see #getArtifacts() to get all transitive dependencies
*/
public Set getDependencyArtifacts()
{
return dependencyArtifacts;
@ -1543,6 +1555,7 @@ public class MavenProject
/**
* @todo the lazy initialisation of this makes me uneasy.
* @return {@link Set} < {@link Artifact} >
*/
public Set createArtifacts( ArtifactFactory artifactFactory, String inheritedScope,
ArtifactFilter dependencyFilter )

View File

@ -312,6 +312,7 @@ public class MavenMetadataSource
/**
* @todo desperately needs refactoring. It's just here because it's implementation is maven-project specific
* @return {@link Set} < {@link Artifact} >
*/
public static Set createArtifacts( ArtifactFactory artifactFactory, List dependencies, String inheritedScope,
ArtifactFilter dependencyFilter, MavenProject project )