org.codehaus.mojo.versions

Class DependencyUpdatesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.versions.AbstractVersionsReport

org.codehaus.mojo.versions.DependencyUpdatesReport

All Implemented Interfaces:

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

public class DependencyUpdatesReport
extends AbstractVersionsReport

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

allowSnapshots, artifactFactory, artifactMetadataSource, artifactResolver, comparisonMethod, localRepository, pathTranslator, remoteArtifactRepositories, remotePluginRepositories, session

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

Constructor and Description
DependencyUpdatesReport()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) generates an empty report in case there are no sources to generate a report with
String	getOutputName()
boolean	isExternalReport()

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

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

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

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

DependencyUpdatesReport

public DependencyUpdatesReport()

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

generates an empty report in case there are no sources to generate a report with

Specified by:

doGenerateReport in class AbstractVersionsReport

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()