Class PropertyUpdatesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

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

org.codehaus.mojo.versions.AbstractPropertyUpdatesReport

org.codehaus.mojo.versions.PropertyUpdatesReport

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="property-updates-report",
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class PropertyUpdatesReport
extends AbstractPropertyUpdatesReport

Generates a report of available updates for properties of a project which are linked to the dependencies and/or plugins of a project.

Since:

1.0-beta-1

Author:

Stephen Connolly

Field Summary

Fields inherited from class AbstractPropertyUpdatesReport

formats

Fields inherited from class AbstractVersionsReport

allowSnapshots, 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	PropertyUpdatesReport(org.codehaus.plexus.i18n.I18N i18n, ArtifactFactory artifactFactory, org.eclipse.aether.RepositorySystem repositorySystem, Map<String, org.apache.maven.wagon.Wagon> wagonMap, ReportRendererFactory rendererFactory)	Creates a new report instance.

Method Summary

Modifier and Type	Method	Description
String	getOutputPath()
protected void	populateUpdateSet(Map<Property, PropertyVersions> propertyCollector)	Method used to supply PropertyUpdatesModel with data about updated properties.

Methods inherited from class AbstractPropertyUpdatesReport

canGenerateReport, doGenerateReport, getRequest, haveBuildProperties, isExternalReport

Methods inherited from class AbstractVersionsReport

executeReport, getAllowSnapshots, getDescription, getHelper, getI18n, getName, getOutputName, 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 Object

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

Constructor Details

PropertyUpdatesReport

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

Creates a new report instance.

Parameters:

i18n - an I18N instance

artifactFactory - a ArtifactFactory instance

repositorySystem - a RepositorySystem instance

wagonMap - a map of wagon implementations

rendererFactory - a ReportRendererFactory instance

Method Details

populateUpdateSet

protected void populateUpdateSet(Map<Property, PropertyVersions> propertyCollector)
                          throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.reporting.MavenReportException

Method used to supply PropertyUpdatesModel with data about updated properties.

Specified by:

populateUpdateSet in class AbstractPropertyUpdatesReport

Parameters:

propertyCollector - map for collecting properties in implementations

Throws:

org.apache.maven.plugin.MojoExecutionException - if something goes wrong.

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

getOutputPath

public String getOutputPath()