org.scijava.maven.plugin
Class DependencyUtils

java.lang.Object
  org.scijava.maven.plugin.DependencyUtils

public final class DependencyUtils
extends Object

Utility class for initiating Maven-based dependency checks.

• The checkDependencies(org.apache.maven.project.MavenProject, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.shared.dependency.tree.DependencyTreeBuilder, org.scijava.maven.plugin.SciJavaDependencyChecker...) methods can be used to initiate one or more SciJavaDependencyCheckers in visiting a Maven dependency tree. Uses DependencyTreeBuilder instead of DependencyGraphBuidler to get the more verbose Maven 2 dependency tree.

Author:

Mark Hiner

Constructor Summary

DependencyUtils()

Method Summary

static void

checkDependencies(org.apache.maven.project.MavenProject mavenProject, org.apache.maven.artifact.repository.ArtifactRepository artifactRepository, org.apache.maven.shared.dependency.tree.DependencyTreeBuilder dependencyTreeBuilder, SciJavaDependencyChecker... checkers) Convenience checkDependencies(org.apache.maven.project.MavenProject, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.shared.dependency.tree.DependencyTreeBuilder, org.scijava.maven.plugin.SciJavaDependencyChecker...) method.

static void

checkDependencies(org.apache.maven.project.MavenProject mavenProject, org.apache.maven.artifact.repository.ArtifactRepository artifactRepository, org.apache.maven.shared.dependency.tree.DependencyTreeBuilder dependencyTreeBuilder, String scope, SciJavaDependencyChecker... checkers)

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyUtils

public DependencyUtils()

Method Detail

checkDependencies

public static void checkDependencies(org.apache.maven.project.MavenProject mavenProject,
                                     org.apache.maven.artifact.repository.ArtifactRepository artifactRepository,
                                     org.apache.maven.shared.dependency.tree.DependencyTreeBuilder dependencyTreeBuilder,
                                     SciJavaDependencyChecker... checkers)
                              throws SciJavaDependencyException

Convenience checkDependencies(org.apache.maven.project.MavenProject, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.shared.dependency.tree.DependencyTreeBuilder, org.scijava.maven.plugin.SciJavaDependencyChecker...) method. Sets scope to Artifact.SCOPE_RUNTIME.

Parameters:

mavenProject - Base pom to check.

artifactRepository - Repository to use when resolving artifacts.

dependencyTreeBuilder - DependencyTreeBuilder instance to use to build a dependency tree.

checkers - A list of one or more SciJavaDependencyCheckers. Each will visit the constructed dependency tree.

Throws:

SciJavaDependencyException - If one or more of the given checkers visitations ultimately returns true, indicating a failed state was discovered.n

checkDependencies

public static void checkDependencies(org.apache.maven.project.MavenProject mavenProject,
                                     org.apache.maven.artifact.repository.ArtifactRepository artifactRepository,
                                     org.apache.maven.shared.dependency.tree.DependencyTreeBuilder dependencyTreeBuilder,
                                     String scope,
                                     SciJavaDependencyChecker... checkers)
                              throws SciJavaDependencyException

Parameters:

mavenProject - Base pom to check.

artifactRepository - Repository to use when resolving artifacts.

dependencyTreeBuilder - DependencyTreeBuilder instance to use to build a dependency tree.

scope - Dependency scope to use. See Artifact SCOPE constants.

checkers - A list of one or more SciJavaDependencyCheckers. Each will visit the constructed dependency tree.

Throws:

SciJavaDependencyException - If one or more of the given checkers visitations ultimately returns true, indicating a failed state was discovered.n