org.scijava.maven.plugin
Class SnapshotFinder

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

public class SnapshotFinder
extends Object

This class recursively checks a specified project, all dependencies, and parent poms of any of these projects, for SNAPSHOT couplings. Any such couplings are reported, and cause a SnapshotException to be thrown.

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

SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder, org.apache.maven.artifact.repository.ArtifactRepository localRepository)
Minimal constructor.

SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder, org.apache.maven.artifact.repository.ArtifactRepository localRepository, Boolean failEarly)
Sets: verbose = false groupIds = *

SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder, org.apache.maven.artifact.repository.ArtifactRepository localRepository, Boolean failEarly, Boolean verbose)
Sets: groupIds = *

SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder, org.apache.maven.artifact.repository.ArtifactRepository localRepository, Boolean failEarly, Boolean verbose, List groupIds)
Fully-specified constructor.

Method Summary

void	checkProject(org.apache.maven.project.MavenProject project) Recursively checks the given project for SNAPSHOT dependencies.
void	setLog(org.apache.maven.plugin.logging.Log log) Sets the Log for this instance.

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)

Minimal constructor. Sets:

• failEarly = false
• verbose = false
• groupIds = *

SnapshotFinder

public SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder,
                      org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                      Boolean failEarly)

Sets:

• verbose = false
• groupIds = *

SnapshotFinder

public SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder,
                      org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                      Boolean failEarly,
                      Boolean verbose)

Sets:

• groupIds = *

SnapshotFinder

public SnapshotFinder(org.apache.maven.project.MavenProjectBuilder projectBuilder,
                      org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                      Boolean failEarly,
                      Boolean verbose,
                      List groupIds)

Fully-specified constructor.

Parameters:

projectBuilder - - MavenProjectBuilder reference

localRepository - - ArtifactRepository corresponding to the local repo. Used to resolve dependencies.

failEarly - - If true, projects will fail after finding any SNAPSHOT problems.

verbose - - If true, full failing dependency paths will be printed.

groupIds - - List of zero or more groupIds. If any are specified, problems will only be reported if they are of one of these groupIds.

Method Detail

checkProject

public void checkProject(org.apache.maven.project.MavenProject project)
                  throws SnapshotException

Recursively checks the given project for SNAPSHOT dependencies.

Parameters:

project - - Base MavenProject (pom) to check.

Throws:

SnapshotException - If a SNAPSHOT dependency is discovered

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

Sets the Log for this instance. This is an optional field that will be used to report findings, but will not affect success or failure of a checkProject(MavenProject) execution.