org.scijava.maven.plugin

Class SnapshotFinder

java.lang.Object

org.scijava.maven.plugin.AbstractSciJavaDependencyChecker

org.scijava.maven.plugin.SnapshotFinder

All Implemented Interfaces:

DependencyNodeVisitor, SciJavaDependencyChecker

public class SnapshotFinder
extends AbstractSciJavaDependencyChecker

SciJavaDependencyChecker implementation that fails when it encounters a SNAPSHOT dependency or parent.

Options:

• verbose - prints full inheritance paths to all failures (default: false)
• failEarly - end execution after first failure (default: false)
• groupIds - an inclusive list of groupIds. Errors will only be reported for projects whose groupIds are contained this list.

Author:

Mark Hiner

Constructor Summary

Constructors

Constructor and Description
SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder, org.apache.maven.artifact.repository.ArtifactRepository localRepository, List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories)

Method Summary

Modifier and Type	Method and Description
String	makeExceptionMessage()
void	setReactorModules(List<org.apache.maven.project.MavenProject> modules) Using this method, a set of projects can be allowlisted to accept as SNAPSHOT couplings.
boolean	visit(DependencyNode node) Starts the visit to the specified dependency node.

Methods inherited from class org.scijava.maven.plugin.AbstractSciJavaDependencyChecker

debug, endVisit, error, failed, info, isFailFast, isRoot, matches, setFailed, setFailFast, setGroupIds, setLog, stopVisit

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotFinder

public SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder,
                      org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                      List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories)

Method Detail

setReactorModules

public void setReactorModules(List<org.apache.maven.project.MavenProject> modules)

Using this method, a set of projects can be allowlisted to accept as SNAPSHOT couplings. This is because, for a given reactor, building a Maven project from the top level is inherently reproducible even with inter-dependent SNAPSHOT-coupled modules.

NB: Reproducibility is NOT guaranteed if an individual module is built instead of the whole reactor. This could trigger the downloading of a remote SNAPSHOT dependency which may or may not be compatible.

Parameters:

modules - A list of all MavenProjects in the core project's reactor.

makeExceptionMessage

public String makeExceptionMessage()

Returns:

A formatted message reporting any encountered failures.

visit

public boolean visit(DependencyNode node)

Description copied from interface: DependencyNodeVisitor

Starts the visit to the specified dependency node.

Parameters:

node - the dependency node to visit

Returns:

true to visit the specified dependency node's children, false to skip the specified dependency node's children and proceed to its next sibling