org.codehaus.mojo.versions

Class AbstractVersionsReport<T>

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

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

Type Parameters:

T - modelled report object

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:

AbstractDependencyUpdatesReportMojo, AbstractPluginUpdatesReportMojo, AbstractPropertyUpdatesReportMojo, ParentUpdatesReportMojo

public abstract class AbstractVersionsReport<T>
extends org.apache.maven.reporting.AbstractMavenReport

Base class for all versions reports.

Since:

1.0-alpha-3

Author:

Stephen Connolly

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.aether.RepositorySystem	aetherRepositorySystem The (injected) aetherRepositorySystem instance.
protected boolean	allowSnapshots Whether to allow snapshots when searching for the latest version of an artifact.
protected String	comparisonMethod The versioning rule to use when comparing versions.
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization component.
protected Set<String>	ignoredVersions Allows specifying ignored versions directly as an alternative to providing the ruleSet parameter; mainly created for -D property usage.
protected ReportRendererFactory	rendererFactory Renderer factory
protected org.apache.maven.repository.RepositorySystem	repositorySystem
protected RuleSet	ruleSet Allows specifying the RuleSet object describing rules on artifact versions to ignore when considering updates.
protected org.apache.maven.execution.MavenSession	session The Maven Session.
protected Map<String,org.apache.maven.wagon.Wagon>	wagonMap (injected) map of Wagon instances

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	AbstractVersionsReport(org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.repository.RepositorySystem repositorySystem, org.eclipse.aether.RepositorySystem aetherRepositorySystem, Map<String,org.apache.maven.wagon.Wagon> wagonMap, ReportRendererFactory rendererFactory)

Method Summary

Modifier and Type	Method and Description
protected abstract void	doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) generates the report.
protected void	executeReport(Locale locale)
Boolean	getAllowSnapshots()
String	getComparisonMethod()
String	getDescription(Locale locale)
VersionsHelper	getHelper()
org.codehaus.plexus.i18n.I18N	getI18n()
String	getName(Locale locale)
protected String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
String	getText(Locale locale, String key) Gets the localized message for this report.

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

canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, 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

Field Detail

i18n

protected org.codehaus.plexus.i18n.I18N i18n

Internationalization component.

Since:

1.0-alpha-3

repositorySystem

protected org.apache.maven.repository.RepositorySystem repositorySystem

aetherRepositorySystem

protected org.eclipse.aether.RepositorySystem aetherRepositorySystem

The (injected) aetherRepositorySystem instance.

comparisonMethod

@Parameter(property="comparisonMethod")
protected String comparisonMethod

The versioning rule to use when comparing versions. Valid values are maven, numeric which will handle long version numbers provided all components are numeric, or mercury which will use the mercury version number comparison rules.

Since:

1.0-alpha-1

allowSnapshots

@Parameter(property="allowSnapshots",
           defaultValue="false")
protected boolean allowSnapshots

Whether to allow snapshots when searching for the latest version of an artifact.

Since:

1.0-alpha-3

session

@Parameter(defaultValue="${session}",
           required=true,
           readonly=true)
protected org.apache.maven.execution.MavenSession session

The Maven Session.

Since:

1.0-beta-1

ruleSet

@Parameter
protected RuleSet ruleSet

Allows specifying the RuleSet object describing rules on artifact versions to ignore when considering updates.

Since:

2.13.0

See Also:

Using the ruleSet element in the POM

ignoredVersions

@Parameter(property="maven.version.ignore")
protected Set<String> ignoredVersions

Allows specifying ignored versions directly as an alternative to providing the ruleSet parameter; mainly created for -D property usage.

Example: "1\.0\.1,.+-M.,.*-SNAPSHOT"

Currently, this parameter will override the defined ruleSet

Since:

2.13.0

rendererFactory

protected ReportRendererFactory rendererFactory

Renderer factory

Since:

2.13.0

wagonMap

protected Map<String,org.apache.maven.wagon.Wagon> wagonMap

(injected) map of Wagon instances

Since:

2.14.0

Constructor Detail

AbstractVersionsReport

protected AbstractVersionsReport(org.codehaus.plexus.i18n.I18N i18n,
                                 org.apache.maven.repository.RepositorySystem repositorySystem,
                                 org.eclipse.aether.RepositorySystem aetherRepositorySystem,
                                 Map<String,org.apache.maven.wagon.Wagon> wagonMap,
                                 ReportRendererFactory rendererFactory)

Method Detail

getHelper

public VersionsHelper getHelper()
                         throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

doGenerateReport

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

generates the report.

Parameters:

locale - the locale to generate the report for.

sink - the report formatting tool.

Throws:

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

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

getProject

protected org.apache.maven.project.MavenProject getProject()

Overrides:

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

getOutputDirectory

protected String getOutputDirectory()

Overrides:

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

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Overrides:

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

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getText

public String getText(Locale locale,
                      String key)

Gets the localized message for this report.

Parameters:

locale - the locale.

key - the message key.

Returns:

the message.

getAllowSnapshots

public Boolean getAllowSnapshots()

getComparisonMethod

public String getComparisonMethod()

getI18n

public org.codehaus.plexus.i18n.I18N getI18n()