Package org.codehaus.mojo.versions

Class AbstractPropertyUpdatesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

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

org.codehaus.mojo.versions.AbstractPropertyUpdatesReport

All Implemented Interfaces:

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

Direct Known Subclasses:

PropertyUpdatesAggregateReport, PropertyUpdatesReport

public abstract class AbstractPropertyUpdatesReport
extends AbstractVersionsReport<PropertyUpdatesModel>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	formats	Report formats (html and/or xml).

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	AbstractPropertyUpdatesReport(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
boolean	canGenerateReport()
protected void	doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink)	generates the report.
protected VersionsHelper.VersionPropertiesMapRequest	getRequest(org.apache.maven.project.MavenProject project)
protected boolean	haveBuildProperties()
boolean	isExternalReport()
protected abstract void	populateUpdateSet(Map<Property,PropertyVersions> propertyCollector)	Method used to supply PropertyUpdatesModel with data about updated properties.

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

getOutputName, getOutputPath

Field Details

formats

@Parameter(property="propertyUpdatesReportFormats",
           defaultValue="html")
protected String[] formats

Report formats (html and/or xml). HTML by default.

Since:

2.14.0

Constructor Details

AbstractPropertyUpdatesReport

protected AbstractPropertyUpdatesReport(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

isExternalReport

public boolean isExternalReport()

Specified by:

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

Overrides:

isExternalReport in class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

haveBuildProperties

protected boolean haveBuildProperties()

doGenerateReport

protected void doGenerateReport(Locale locale,
 org.apache.maven.doxia.sink.Sink sink)
                         throws org.apache.maven.reporting.MavenReportException

Description copied from class: AbstractVersionsReport

generates the report.

Specified by:

doGenerateReport in class AbstractVersionsReport<PropertyUpdatesModel>

Parameters:

locale - the locale to generate the report for.

sink - the report formatting tool.

Throws:

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

populateUpdateSet

protected abstract 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.

Parameters:

propertyCollector - map for collecting properties in implementations

Throws:

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

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

getRequest

protected VersionsHelper.VersionPropertiesMapRequest getRequest(org.apache.maven.project.MavenProject project)