Package org.codehaus.mojo.versions

Class PluginUpdatesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

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

org.codehaus.mojo.versions.AbstractPluginUpdatesReport

org.codehaus.mojo.versions.PluginUpdatesReport

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="plugin-updates-report",
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class PluginUpdatesReport
extends AbstractPluginUpdatesReport

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

Since:

1.0-beta-1

Author:

Stephen Connolly

Field Summary

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

onlyProjectPlugins, onlyUpgradable

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	PluginUpdatesReport(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	populatePluginManagement(Set<org.apache.maven.model.Plugin> pluginManagementCollector)	Implementations of AbstractPluginUpdatesReport may use this to supply the main processing logic with desired pluginManagement data, which will be used in the creation of the report.
protected void	populatePlugins(Set<org.apache.maven.model.Plugin> pluginsCollector)	Implementations of AbstractPluginUpdatesReport may use this to supply the main processing logic with desired build plugin information, which will be used to create the report.

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

canGenerateReport, doGenerateReport, haveBuildPluginManagementPlugins, haveBuildPlugins, 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

PluginUpdatesReport

@Inject
protected PluginUpdatesReport(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

populatePluginManagement

protected void populatePluginManagement(Set<org.apache.maven.model.Plugin> pluginManagementCollector)

Implementations of AbstractPluginUpdatesReport may use this to supply the main processing logic with desired pluginManagement data, which will be used in the creation of the report.

Specified by:

populatePluginManagement in class AbstractPluginUpdatesReport

Parameters:

pluginManagementCollector - , a set initialized with a PluginComparator comparator.

populatePlugins

protected void populatePlugins(Set<org.apache.maven.model.Plugin> pluginsCollector)

Implementations of AbstractPluginUpdatesReport may use this to supply the main processing logic with desired build plugin information, which will be used to create the report.

Specified by:

populatePlugins in class AbstractPluginUpdatesReport

Parameters:

pluginsCollector - , a set initialized with a PluginComparator comparator.

getOutputName

public String getOutputName()