org.codehaus.mojo.versions.reporting

Class AbstractVersionsReportRenderer<T>

java.lang.Object

org.apache.maven.reporting.AbstractMavenReportRenderer

org.codehaus.mojo.versions.reporting.VersionsReportRendererBase

org.codehaus.mojo.versions.reporting.AbstractVersionsReportRenderer<T>

Type Parameters:

T - modelled report object

All Implemented Interfaces:

org.apache.maven.reporting.MavenReportRenderer, ReportRenderer

Direct Known Subclasses:

DependencyUpdatesReportRenderer, PluginUpdatesReportRenderer, PropertyUpdatesReportRenderer

public abstract class AbstractVersionsReportRenderer<T>
extends VersionsReportRendererBase
implements ReportRenderer

Base class for report renderers.

Since:

1.0-beta-1

Author:

Stephen Connolly

Field Summary

Fields

Modifier and Type	Field and Description
protected ArtifactVersionsCache	allUpdatesCache
protected T	model Model of the object being rendered
protected ArtifactVersionsCache	newestUpdateCache

Fields inherited from class org.codehaus.mojo.versions.reporting.VersionsReportRendererBase

bundleName, i18n, locale

Fields inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

sink

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVersionsReportRenderer(org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.doxia.sink.Sink sink, Locale locale, String bundleName, T model) Constructor to be called by the dependency injection framework

Method Summary

Modifier and Type	Method and Description
protected abstract <Q extends OverviewStats> Q	computeOverviewStats() Computes the OverviewStats object needed to render the summary table row
protected String	getLabel(org.apache.maven.artifact.versioning.ArtifactVersion version, AbstractVersionDetails details)
protected void	renderBody()
protected void	renderDependencyDetailTable(org.apache.maven.model.Dependency artifact, ArtifactVersions details, boolean includeScope)
protected abstract void	renderDetails() Renders the details table
protected abstract void	renderManagementSummaryTable() Renders the "management" (dependencyManagement, pluginManagement, etc.) summary table
protected void	renderOverview() Renders the "Overview" table
protected <Q extends OverviewStats> void	renderOverviewTableRow(Q stats) Renders the singular summary table row
protected void	renderStatRow(String textKey, int statCount, boolean forceSuccessIcon)
protected abstract void	renderSummaryTable() Renders the regular ("dependencies", "plugins", etc.) summary table
protected void	renderSummaryTable(Map<org.apache.maven.model.Dependency,ArtifactVersions> contents, boolean hasScope)
protected void	renderSummaryTableHeader(boolean hasScope, boolean hasType)
protected void	renderSummaryTableRow(org.apache.maven.model.Dependency artifact, ArtifactVersions details, boolean includeScope)
protected void	renderTableHeaderCells(String... keys) Renders a table header containing elements denoted by the given keys

Methods inherited from class org.codehaus.mojo.versions.reporting.VersionsReportRendererBase

equals, getText, getTitle, renderSuccessIcon, renderWarningIcon, safeBold_, safeBold, safeItalic_, safeItalic

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

createLinkPatternedText, endSection, endTable, javaScript, link, linkPatternedText, paragraph, propertiesToString, render, startSection, startTable, startTable, tableCaption, tableCell, tableCell, tableHeader, tableHeaderCell, tableRow, text, verbatimLink, verbatimText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.mojo.versions.api.ReportRenderer

render

Field Detail

model

protected T model

Model of the object being rendered

Since:

2.13.0

newestUpdateCache

protected ArtifactVersionsCache newestUpdateCache

allUpdatesCache

protected ArtifactVersionsCache allUpdatesCache

Constructor Detail

AbstractVersionsReportRenderer

protected AbstractVersionsReportRenderer(org.codehaus.plexus.i18n.I18N i18n,
                                         org.apache.maven.doxia.sink.Sink sink,
                                         Locale locale,
                                         String bundleName,
                                         T model)

Constructor to be called by the dependency injection framework

Parameters:

i18n - i18n object to be injected

Method Detail

renderBody

protected void renderBody()

Specified by:

renderBody in class org.apache.maven.reporting.AbstractMavenReportRenderer

renderOverview

protected void renderOverview()

Renders the "Overview" table

renderManagementSummaryTable

protected abstract void renderManagementSummaryTable()

Renders the "management" (dependencyManagement, pluginManagement, etc.) summary table

renderSummaryTable

protected abstract void renderSummaryTable()

Renders the regular ("dependencies", "plugins", etc.) summary table

renderOverviewTableRow

protected <Q extends OverviewStats> void renderOverviewTableRow(Q stats)

Renders the singular summary table row

Type Parameters:

Q - concrete OverviewStats class

Parameters:

stats - summary statistics object to render

renderStatRow

protected void renderStatRow(String textKey,
                             int statCount,
                             boolean forceSuccessIcon)

computeOverviewStats

protected abstract <Q extends OverviewStats> Q computeOverviewStats()

Computes the OverviewStats object needed to render the summary table row

Type Parameters:

Q - concrete OverviewStats class

Returns:

stats object

renderDetails

protected abstract void renderDetails()

Renders the details table

renderSummaryTable

protected void renderSummaryTable(Map<org.apache.maven.model.Dependency,ArtifactVersions> contents,
                                  boolean hasScope)

renderSummaryTableHeader

protected void renderSummaryTableHeader(boolean hasScope,
                                        boolean hasType)

renderSummaryTableRow

protected void renderSummaryTableRow(org.apache.maven.model.Dependency artifact,
                                     ArtifactVersions details,
                                     boolean includeScope)

renderDependencyDetailTable

protected void renderDependencyDetailTable(org.apache.maven.model.Dependency artifact,
                                           ArtifactVersions details,
                                           boolean includeScope)

renderTableHeaderCells

protected void renderTableHeaderCells(String... keys)

Renders a table header containing elements denoted by the given keys

Parameters:

keys - variable argument list containing keys of the property file to retrieve the headers from

getLabel

protected String getLabel(org.apache.maven.artifact.versioning.ArtifactVersion version,
                          AbstractVersionDetails details)