org.codehaus.mojo.license.api

Class DependenciesTool

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.mojo.license.api.DependenciesTool

All Implemented Interfaces:

org.codehaus.plexus.logging.LogEnabled

@Component(role=DependenciesTool.class,
           hint="default")
public class DependenciesTool
extends org.codehaus.plexus.logging.AbstractLogEnabled

A tool to deal with dependencies of a project.

Since:

1.0

Author:

tchemit dev@tchemit.fr

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_PATTERN_MESSAGE Message used when an invalid expression pattern is found.

Constructor Summary

Constructors

Constructor and Description
DependenciesTool()

Method Summary

Modifier and Type	Method and Description
ResolvedProjectDependencies	loadProjectArtifacts(org.apache.maven.artifact.repository.ArtifactRepository localRepository, List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories, org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects) Load project artifacts.
SortedMap<String,org.apache.maven.project.MavenProject>	loadProjectDependencies(ResolvedProjectDependencies artifacts, MavenProjectDependenciesConfigurator configuration, org.apache.maven.artifact.repository.ArtifactRepository localRepository, List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories, SortedMap<String,org.apache.maven.project.MavenProject> cache) For a given project, obtain the universe of its dependencies after applying transitivity and filtering rules given in the configuration object.

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_PATTERN_MESSAGE

public static final String INVALID_PATTERN_MESSAGE

Message used when an invalid expression pattern is found.

See Also:

Constant Field Values

Constructor Detail

DependenciesTool

public DependenciesTool()

Method Detail

loadProjectDependencies

public SortedMap<String,org.apache.maven.project.MavenProject> loadProjectDependencies(ResolvedProjectDependencies artifacts,
                                                                                       MavenProjectDependenciesConfigurator configuration,
                                                                                       org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                                                       List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories,
                                                                                       SortedMap<String,org.apache.maven.project.MavenProject> cache)

For a given project, obtain the universe of its dependencies after applying transitivity and filtering rules given in the configuration object. Result is given in a map where keys are unique artifact id

Parameters:

dependencies - the project dependencies

configuration - the configuration

localRepository - local repository used to resolv dependencies

remoteRepositories - remote repositories used to resolv dependencies

cache - a optional cache where to keep resolved dependencies

Returns:

the map of resolved dependencies indexed by their unique id.

See Also:

MavenProjectDependenciesConfigurator

loadProjectArtifacts

public ResolvedProjectDependencies loadProjectArtifacts(org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                        List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories,
                                                        org.apache.maven.project.MavenProject project,
                                                        List<org.apache.maven.project.MavenProject> reactorProjects)
                                                 throws DependenciesToolException

Load project artifacts.

Parameters:

localRepository - local repository used to resolv dependencies

remoteRepositories - remote repositories used to resolv dependencies

project - the project to scan

reactorProjectDependencies - reactor projects. Optional, only relevant if there is more than one)

Returns:

the loaded project dependency artifacts

Throws:

DependenciesToolException - if could not load project dependencies