com.google.cloud.tools.opensource.dependencies

Class DependencyGraphBuilder

java.lang.Object

com.google.cloud.tools.opensource.dependencies.DependencyGraphBuilder

public final class DependencyGraphBuilder
extends Object

Builds dependency graphs for Maven artifacts by querying repositories for pom.xml files and following the dependency chains therein.

Constructor Summary

Constructors

Constructor and Description
DependencyGraphBuilder()
DependencyGraphBuilder(Iterable<String> mavenRepositoryUrls)

Method Summary

Modifier and Type	Method and Description
DependencyGraph	buildFullDependencyGraph(List<org.eclipse.aether.artifact.Artifact> artifacts) Finds the full compile time, transitive dependency graph including duplicates, conflicting versions, and provided and optional dependencies.
DependencyGraph	buildMavenDependencyGraph(org.eclipse.aether.graph.Dependency dependency) Builds the transitive dependency graph as seen by Maven.
DependencyGraph	buildVerboseDependencyGraph(org.eclipse.aether.artifact.Artifact artifact) Finds the full compile time, transitive dependency graph including conflicting versions and provided dependencies.
DependencyGraph	buildVerboseDependencyGraph(List<org.eclipse.aether.artifact.Artifact> artifacts) Finds the full compile time, transitive dependency graph including duplicates and conflicting versions, but not optional dependencies.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyGraphBuilder

public DependencyGraphBuilder()

DependencyGraphBuilder

public DependencyGraphBuilder(Iterable<String> mavenRepositoryUrls)

Parameters:

mavenRepositoryUrls - remote Maven repositories to search for dependencies

Throws:

IllegalArgumentException - if a URL is malformed or does not have an allowed scheme

Method Detail

buildFullDependencyGraph

public DependencyGraph buildFullDependencyGraph(List<org.eclipse.aether.artifact.Artifact> artifacts)

Finds the full compile time, transitive dependency graph including duplicates, conflicting versions, and provided and optional dependencies. Each node's dependencies are resolved recursively. The scope of a dependency does not affect the scope of its children's dependencies. Provided and optional dependencies are not treated differently than any other dependency.

In the event of I/O errors, missing artifacts, and other problems, it can return an incomplete graph.

Parameters:

artifacts - Maven artifacts whose dependencies to retrieve

Returns:

dependency graph representing the tree of Maven artifacts

buildVerboseDependencyGraph

public DependencyGraph buildVerboseDependencyGraph(List<org.eclipse.aether.artifact.Artifact> artifacts)

Finds the full compile time, transitive dependency graph including duplicates and conflicting versions, but not optional dependencies. Each node's dependencies are resolved recursively. The scope of a dependency does not affect the scope of its children's dependencies.

In the event of I/O errors, missing artifacts, and other problems, it can return an incomplete graph.

Parameters:

artifacts - Maven artifacts whose dependencies to retrieve

Returns:

dependency graph representing the tree of Maven artifacts

buildVerboseDependencyGraph

public DependencyGraph buildVerboseDependencyGraph(org.eclipse.aether.artifact.Artifact artifact)

Finds the full compile time, transitive dependency graph including conflicting versions and provided dependencies. This includes direct optional dependencies of the root node but not optional dependencies of transitive dependencies. Each node's dependencies are resolved recursively. The scope of a dependency does not affect the scope of its children's dependencies. Provided and optional dependencies are not treated differently than any other dependency.

In the event of I/O errors, missing artifacts, and other problems, it can return an incomplete graph.

Parameters:

artifact - the root

Returns:

the graph as built by Maven before dependency mediation

buildMavenDependencyGraph

public DependencyGraph buildMavenDependencyGraph(org.eclipse.aether.graph.Dependency dependency)

Builds the transitive dependency graph as seen by Maven. It does not include duplicates and conflicting versions. That is, this resolves conflicting versions by picking the first version seen. This is how Maven normally operates. It does not contain provided-scope dependencies of transitive dependencies. It does not contain optional dependencies of transitive dependencies.

In the event of I/O errors, missing artifacts, and other problems, it can return an incomplete graph.