org.codehaus.mojo.versions
Class DisplayDependencyUpdatesReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.codehaus.mojo.versions.AbstractVersionsReport
              org.codehaus.mojo.versions.DisplayDependencyUpdatesReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenReport

public class DisplayDependencyUpdatesReport
extends AbstractVersionsReport

This report summarizes all project dependencies for which newer versions may exist. For convenience, the new versions are segregated by incremental, minor, and major changes, since each tends to have a different level of effort (and risk) involved when upgrading.

Since:

1.0-alpha-3

Author:

Matthew Beermann, Stephen Connolly

Is defined by the goal name:

display-dependency-updates-report

Requires the dependencies in this specified scope:

runtime

Requires a Maven project to run:

true

Nested Class Summary

protected static class

DisplayDependencyUpdatesReport.MultiVersionSummary

Field Summary

protected ArrayList	excludes A list of groupId:artifactId keys, which indicate that the corresponding artifact(s) should be omitted from the report (even when showAll is true).
protected Boolean	showAll If true, show all unexcluded dependencies in the report - even those that have no updates available.

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

artifactMetadataSource, comparisonMethod, localRepository, remoteArtifactRepositories, remotePluginRepositories

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

DisplayDependencyUpdatesReport()

Method Summary

boolean	canGenerateReport()
protected void	doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) generates the report.
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
protected boolean	hasUpdates(DisplayDependencyUpdatesReport.MultiVersionSummary summary)
protected boolean	isExcluded(Artifact artifact)
boolean	isExternalReport()

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

executeReport, findLatestVersion, getAllowSnapshots, getComparisonMethod, getHelper, getOutputDirectory, getProject, getResolver, getSiteRenderer, getText

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

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

Field Detail

excludes

protected ArrayList excludes

A list of groupId:artifactId keys, which indicate that the corresponding artifact(s) should be omitted from the report (even when showAll is true). For example:
<excludes>
<exclude>com.oracle:ojdbc14</exclude>
</excludes>

Is defined by:

expression:

${excludes}

showAll

protected Boolean showAll

If true, show all unexcluded dependencies in the report - even those that have no updates available.

Is defined by:

expression:

${showAll}

default-value:

false

Is required.

Constructor Detail

DisplayDependencyUpdatesReport

public DisplayDependencyUpdatesReport()

Method Detail

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractMavenReport

doGenerateReport

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

generates the report.

Specified by:

doGenerateReport in class AbstractVersionsReport

Parameters:

locale - the locale to generate the report for.

sink - the report formatting tool.

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface MavenReport

Overrides:

getCategoryName in class AbstractMavenReport

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface MavenReport

Overrides:

getDescription in class AbstractVersionsReport

See Also:

MavenReport.getDescription(java.util.Locale)

getName

public String getName(Locale locale)

Specified by:

getName in interface MavenReport

Overrides:

getName in class AbstractVersionsReport

See Also:

MavenReport.getName(java.util.Locale)

getOutputName

public String getOutputName()

hasUpdates

protected boolean hasUpdates(DisplayDependencyUpdatesReport.MultiVersionSummary summary)

isExcluded

protected boolean isExcluded(Artifact artifact)

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface MavenReport

Overrides:

isExternalReport in class AbstractMavenReport