org.codehaus.mojo.versions

Class DependencyUpdatesReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

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

org.codehaus.mojo.versions.AbstractDependencyUpdatesReportMojo

org.codehaus.mojo.versions.DependencyUpdatesReportMojo

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 DependencyUpdatesReportMojo
extends AbstractDependencyUpdatesReportMojo

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.AbstractDependencyUpdatesReportMojo

formats, onlyProjectDependencies, onlyUpgradable, processDependencyManagement, processDependencyManagementTransitive

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

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

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

localRepository, outputDirectory, project, remoteRepositories, 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 and Description
protected	DependencyUpdatesReportMojo(org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.repository.RepositorySystem repositorySystem, org.eclipse.aether.RepositorySystem aetherRepositorySystem, Map<String,org.apache.maven.wagon.Wagon> wagonMap, ReportRendererFactory rendererFactory)

Method Summary

Modifier and Type	Method and Description
String	getOutputName()
protected void	populateDependencies(Set<org.apache.maven.model.Dependency> dependenciesCollector) Implementations of AbstractDependencyUpdatesReportMojo may use this to supply the main processing logic (see AbstractDependencyUpdatesReportMojo.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 AbstractDependencyUpdatesReportMojo may use this to supply the main processing logic (see AbstractDependencyUpdatesReportMojo.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.AbstractDependencyUpdatesReportMojo

canGenerateReport, doGenerateReport, handleDependencyManagementTransitive, hasDependencyManagement, isExternalReport

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

executeReport, getAllowSnapshots, getComparisonMethod, getDescription, getHelper, getI18n, getName, getOutputDirectory, getProject, getSiteRenderer, getText

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

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, 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

Constructor Detail

DependencyUpdatesReportMojo

@Inject
protected DependencyUpdatesReportMojo(org.codehaus.plexus.i18n.I18N i18n,
                                              org.apache.maven.repository.RepositorySystem repositorySystem,
                                              org.eclipse.aether.RepositorySystem aetherRepositorySystem,
                                              Map<String,org.apache.maven.wagon.Wagon> wagonMap,
                                              ReportRendererFactory rendererFactory)

Method Detail

populateDependencies

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

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

Specified by:

populateDependencies in class AbstractDependencyUpdatesReportMojo

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 AbstractDependencyUpdatesReportMojo may use this to supply the main processing logic (see AbstractDependencyUpdatesReportMojo.getDependencyManagement(Set)) with desired managed dependencies data, which will be used in the creation of the report.

Specified by:

populateDependencyManagement in class AbstractDependencyUpdatesReportMojo

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

Throws:

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

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

Overrides:

getOutputName in class AbstractDependencyUpdatesReportMojo