Package org.codehaus.mojo.versions

Class DependencyUpdatesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.versions.AbstractVersionsReport<DependencyUpdatesModel>

org.codehaus.mojo.versions.AbstractDependencyUpdatesReport

org.codehaus.mojo.versions.DependencyUpdatesReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

@Mojo(name="dependency-updates-report",
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class DependencyUpdatesReport
extends AbstractDependencyUpdatesReport

Generates a report of available updates for the dependencies of a project.

Since:

1.0-beta-1

Author:

Stephen Connolly

Field Summary

Fields inherited from class org.codehaus.mojo.versions.AbstractDependencyUpdatesReport

formats, onlyProjectDependencies, onlyUpgradable, processDependencyManagement, processDependencyManagementTransitive

Fields inherited from class org.codehaus.mojo.versions.AbstractVersionsReport

allowSnapshots, artifactHandlerManager, comparisonMethod, i18n, ignoredVersions, rendererFactory, repositorySystem, ruleSet, session, wagonMap

Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DependencyUpdatesReport(org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.eclipse.aether.RepositorySystem repositorySystem, Map<String,org.apache.maven.wagon.Wagon> wagonMap, ReportRendererFactory rendererFactory)

Method Summary

Modifier and Type	Method	Description
String	getOutputName()
protected void	populateDependencies(Set<org.apache.maven.model.Dependency> dependenciesCollector)	Implementations of AbstractDependencyUpdatesReport may use this to supply the main processing logic (see AbstractDependencyUpdatesReport.getDependencyManagement(Set)) with desired dependency data, which will be used in the creation of the report.
protected void	populateDependencyManagement(Set<org.apache.maven.model.Dependency> dependencyManagementCollector, Set<org.apache.maven.model.Dependency> dependencies)	Implementations of AbstractDependencyUpdatesReport may use this to supply the main processing logic (see AbstractDependencyUpdatesReport.getDependencyManagement(Set)) with desired managed dependencies data, which will be used in the creation of the report.

Methods inherited from class org.codehaus.mojo.versions.AbstractDependencyUpdatesReport

canGenerateReport, doGenerateReport, handleDependencyManagementTransitive, hasDependencyManagement, isExternalReport

Methods inherited from class org.codehaus.mojo.versions.AbstractVersionsReport

executeReport, getAllowSnapshots, getComparisonMethod, getDescription, getHelper, getI18n, getName, getText

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, setReportOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Constructor Details

DependencyUpdatesReport

@Inject
protected DependencyUpdatesReport(org.codehaus.plexus.i18n.I18N i18n,
 org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
 org.eclipse.aether.RepositorySystem repositorySystem,
 Map<String,org.apache.maven.wagon.Wagon> wagonMap,
 ReportRendererFactory rendererFactory)

Method Details

populateDependencies

protected void populateDependencies(Set<org.apache.maven.model.Dependency> dependenciesCollector)

Implementations of AbstractDependencyUpdatesReport may use this to supply the main processing logic (see AbstractDependencyUpdatesReport.getDependencyManagement(Set)) with desired dependency data, which will be used in the creation of the report.

Specified by:

populateDependencies in class AbstractDependencyUpdatesReport

Parameters:

dependenciesCollector - , a Set, initialized with a DependencyComparator comparator.

populateDependencyManagement

protected void populateDependencyManagement(Set<org.apache.maven.model.Dependency> dependencyManagementCollector,
 Set<org.apache.maven.model.Dependency> dependencies)
                                     throws org.apache.maven.reporting.MavenReportException

Implementations of AbstractDependencyUpdatesReport may use this to supply the main processing logic (see AbstractDependencyUpdatesReport.getDependencyManagement(Set)) with desired managed dependencies data, which will be used in the creation of the report.

Specified by:

populateDependencyManagement in class AbstractDependencyUpdatesReport

Parameters:

dependencyManagementCollector - , a Set initialized with a DependencyComparator

dependencies - an already populated set of dependencies(non-managed) comparator.

Throws:

org.apache.maven.reporting.MavenReportException - when things go wrong.

getOutputName

public String getOutputName()