org.codehaus.mojo.pomtools.helpers
Class MetadataHelper

java.lang.Object
  org.codehaus.mojo.pomtools.helpers.MetadataHelper

public class MetadataHelper
extends java.lang.Object

Wrapper library for Maven Artifact and Metadata routines.

Author:

David Hawkins * @version $Id: MetadataHelper.java 2166 2006-07-18 21:32:16Z carlos $

Constructor Summary

MetadataHelper(org.apache.maven.execution.MavenSession session, java.util.List remoteArtifactRepositories, org.apache.maven.artifact.repository.ArtifactRepository localRepository)

Method Summary

org.apache.maven.artifact.Artifact	createArtifact(ObjectWrapper obj)
org.apache.maven.artifact.Artifact	createArtifact(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.lang.String scope, java.lang.String type) Simple wrapper for ArtifactFactory.createArtifact(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository()
org.apache.maven.artifact.repository.metadata.RepositoryMetadata	getMetadata(org.apache.maven.artifact.Artifact artifact)
org.apache.maven.artifact.repository.metadata.RepositoryMetadata	getMetadata(ObjectWrapper obj)
java.util.List	getRemoteRepositories()
java.util.List	getTransitiveDependencies() Resolves all transitive dependencies for the current project and returns a list of TransitiveDependencyInfo objects.
boolean	isValidDependencyArtifact(org.apache.maven.artifact.Artifact artifact) Determines whether the artifact exists ( in that we are able to locate metadata for the groupId and artifactId) and that the version or version range specified refers to a version specified in the repository metadata.
boolean	isValidGroupIdArtifactId(org.apache.maven.artifact.Artifact artifact) Returns whether the groupId and artifactId appear to be valid.
protected void	recurseNode(java.util.Map dependencyMap, java.util.Set seen, java.util.Iterator nodeIter, int depth)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataHelper

public MetadataHelper(org.apache.maven.execution.MavenSession session,
                      java.util.List remoteArtifactRepositories,
                      org.apache.maven.artifact.repository.ArtifactRepository localRepository)
               throws PomToolsRTException

Throws:

PomToolsRTException

Method Detail

createArtifact

public org.apache.maven.artifact.Artifact createArtifact(java.lang.String groupId,
                                                         java.lang.String artifactId,
                                                         java.lang.String version,
                                                         java.lang.String scope,
                                                         java.lang.String type)

Simple wrapper for ArtifactFactory.createArtifact(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

createArtifact

public org.apache.maven.artifact.Artifact createArtifact(ObjectWrapper obj)

getMetadata

public org.apache.maven.artifact.repository.metadata.RepositoryMetadata getMetadata(ObjectWrapper obj)
                                                                             throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

getMetadata

public org.apache.maven.artifact.repository.metadata.RepositoryMetadata getMetadata(org.apache.maven.artifact.Artifact artifact)
                                                                             throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

isValidGroupIdArtifactId

public boolean isValidGroupIdArtifactId(org.apache.maven.artifact.Artifact artifact)

Returns whether the groupId and artifactId appear to be valid. This differs from isValidDependencyArtifact(Artifact) in that the version can be null or even invalid and still get a positive result

Parameters:

artifact -

Returns:

isValidDependencyArtifact

public boolean isValidDependencyArtifact(org.apache.maven.artifact.Artifact artifact)

Determines whether the artifact exists ( in that we are able to locate metadata for the groupId and artifactId) and that the version or version range specified refers to a version specified in the repository metadata.

Parameters:

artifact -

Returns:

getTransitiveDependencies

public java.util.List getTransitiveDependencies()
                                         throws PomToolsException,
                                                org.apache.maven.project.ProjectBuildingException

Resolves all transitive dependencies for the current project and returns a list of TransitiveDependencyInfo objects. Each object represents a distinct groupId:artifactId:type dependency. The TransitiveDependencyInfo.getResolutionNodes() represent all of the possible ResolutionNodes which resolve to this groupId:artifactId.

Returns:

Throws:

PomToolsException

org.apache.maven.project.ProjectBuildingException

recurseNode

protected void recurseNode(java.util.Map dependencyMap,
                           java.util.Set seen,
                           java.util.Iterator nodeIter,
                           int depth)
                    throws PomToolsException

Throws:

PomToolsException

getLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()

getRemoteRepositories

public java.util.List getRemoteRepositories()