org.codehaus.mojo.versions

Class PropertyUpdatesReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

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

org.codehaus.mojo.versions.PropertyUpdatesReportMojo

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

Since:

1.0-beta-1

Author:

Stephen Connolly

Field Summary

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

allowSnapshots, artifactMetadataSource, artifactResolver, comparisonMethod, i18n, ignoredVersions, remoteArtifactRepositories, remotePluginRepositories, rendererFactory, repositorySystem, ruleSet, session

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	PropertyUpdatesReportMojo(org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver, org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource, org.apache.maven.artifact.manager.WagonManager wagonManager, ReportRendererFactory rendererFactory)

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) generates the report.
String	getOutputName()
boolean	isExternalReport()

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

executeReport, findLatestVersion, 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

PropertyUpdatesReportMojo

@Inject
protected PropertyUpdatesReportMojo(org.codehaus.plexus.i18n.I18N i18n,
                                            org.apache.maven.repository.RepositorySystem repositorySystem,
                                            org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver,
                                            org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource,
                                            org.apache.maven.artifact.manager.WagonManager wagonManager,
                                            ReportRendererFactory rendererFactory)

Method Detail

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

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.

getOutputName

public String getOutputName()