org.linuxstuff.mojo.licensing.DependenciesTool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of licensing-maven-plugin Show documentation

Forked from http://github.com/idcmp/licensing-maven-plugin

There is a newer version: 1.7.11

Show newest version

/*
 * #%L
 * License Maven Plugin
 *
 * $Id: DependenciesTool.java 14409 2011-08-10 15:30:41Z tchemit $
 * $HeadURL: http://svn.codehaus.org/mojo/tags/license-maven-plugin-1.0/src/main/java/org/codehaus/mojo/license/DependenciesTool.java $
 * %%
 * Copyright (C) 2011 CodeLutin, Codehaus, Tony Chemit
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.linuxstuff.mojo.licensing;

import java.util.List;
import java.util.SortedMap;

import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.project.MavenProject;

/**
 * A tool to deal with dependencies of a project.
 * 
 * @author tchemit 
 * @since 1.0
 */
public interface DependenciesTool {

	/**
	 * For a given {@code project}, obtain the universe of his dependencies
	 * after applying transitivity and filtering rules given in the
	 * {@code configuration} object.
	 * 
	 * Result is given in a map where keys are unique artifact id
	 * 
	 * @param project
	 *            the project to scann
	 * @param configuration
	 *            the configuration
	 * @param localRepository
	 *            local repository used to resolv dependencies
	 * @param remoteRepositories
	 *            remote repositories used to resolv dependencies
	 * @param cache
	 *            a optional cache where to keep resolved dependencies
	 * @return the map of resolved dependencies indexed by their unique id.
	 * @see MavenProjectDependenciesConfigurator
	 */
	SortedMap loadProjectDependencies(MavenProject project, MavenProjectDependenciesConfigurator configuration, ArtifactRepository localRepository,
			List remoteRepositories, SortedMap cache);
}