org.codehaus.mojo.versions
Class AbstractVersionsReportRenderer

java.lang.Object
  org.apache.maven.reporting.AbstractMavenReportRenderer
      org.codehaus.mojo.versions.AbstractVersionsReportRenderer

All Implemented Interfaces:

org.apache.maven.reporting.MavenReportRenderer

Direct Known Subclasses:

DependencyUpdatesRenderer, PluginUpdatesRenderer, PropertyUpdatesRenderer

public abstract class AbstractVersionsReportRenderer
extends org.apache.maven.reporting.AbstractMavenReportRenderer

Base class for report renderers.

Since:

1.0-beta-1

Author:

Stephen Connolly

Field Summary

protected String	bundleName The name of the bundle containing our I18n resources.
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization component.
protected Locale	locale The locale we are rendering for.

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

sink

Constructor Summary

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

Method Summary

protected boolean	equals(org.apache.maven.artifact.versioning.ArtifactVersion v1, org.apache.maven.artifact.versioning.ArtifactVersion v2)
String	getText(String key) Gets the localized message for this report.
String	getTitle()
protected void	renderDependencyDetailTable(org.apache.maven.model.Dependency dependency, ArtifactVersions details)
protected void	renderDependencyDetailTable(org.apache.maven.model.Dependency dependency, ArtifactVersions details, boolean includeScope, boolean includeClassifier, boolean includeType)
protected void	renderDependencySummaryTable(Map map)
protected void	renderDependencySummaryTable(Map<org.apache.maven.model.Dependency,ArtifactVersions> map, boolean includeScope, boolean includeClassifier, boolean includeType)
protected void	renderDependencySummaryTableHeader()
protected void	renderDependencySummaryTableHeader(boolean includeScope, boolean includeClassifier, boolean includeType)
protected void	renderDependencySummaryTableRow(org.apache.maven.model.Dependency dependency, ArtifactVersions details)
protected void	renderDependencySummaryTableRow(org.apache.maven.model.Dependency dependency, ArtifactVersions details, boolean includeScope, boolean includeClassifier, boolean includeType)
protected void	renderPropertyDetailTable(Property property, PropertyVersions versions)
protected void	renderPropertySummaryTable(Map<Property,PropertyVersions> map)
protected void	renderPropertySummaryTableHeader()
protected void	renderPropertySummaryTableRow(Property property, PropertyVersions versions)
protected void	renderSuccessIcon()
protected void	renderWarningIcon()
protected void	safeBold_()
protected void	safeBold()
protected void	safeItalic_()
protected void	safeItalic()

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

createLinkPatternedText, endSection, endTable, javaScript, link, linkPatternedText, paragraph, propertiesToString, render, renderBody, startSection, 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

Field Detail

i18n

protected final org.codehaus.plexus.i18n.I18N i18n

Internationalization component.

Since:

1.0-beta-1

locale

protected final Locale locale

The locale we are rendering for.

Since:

1.0-beta-1

bundleName

protected final String bundleName

The name of the bundle containing our I18n resources.

Since:

1.0-beta-1

Constructor Detail

AbstractVersionsReportRenderer

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

Method Detail

getTitle

public String getTitle()

Specified by:

getTitle in interface org.apache.maven.reporting.MavenReportRenderer

Specified by:

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

getText

public String getText(String key)

Gets the localized message for this report.

Parameters:

key - the message key.

Returns:

the message.

renderWarningIcon

protected void renderWarningIcon()

renderSuccessIcon

protected void renderSuccessIcon()

equals

protected boolean equals(org.apache.maven.artifact.versioning.ArtifactVersion v1,
                         org.apache.maven.artifact.versioning.ArtifactVersion v2)

renderDependencySummaryTableRow

protected void renderDependencySummaryTableRow(org.apache.maven.model.Dependency dependency,
                                               ArtifactVersions details)

renderDependencySummaryTableRow

protected void renderDependencySummaryTableRow(org.apache.maven.model.Dependency dependency,
                                               ArtifactVersions details,
                                               boolean includeScope,
                                               boolean includeClassifier,
                                               boolean includeType)

safeBold

protected void safeBold()

safeBold_

protected void safeBold_()

safeItalic

protected void safeItalic()

safeItalic_

protected void safeItalic_()

renderDependencySummaryTableHeader

protected void renderDependencySummaryTableHeader()

renderDependencySummaryTableHeader

protected void renderDependencySummaryTableHeader(boolean includeScope,
                                                  boolean includeClassifier,
                                                  boolean includeType)

renderDependencyDetailTable

protected void renderDependencyDetailTable(org.apache.maven.model.Dependency dependency,
                                           ArtifactVersions details)

renderDependencyDetailTable

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

renderDependencySummaryTable

protected void renderDependencySummaryTable(Map map)

renderDependencySummaryTable

protected void renderDependencySummaryTable(Map<org.apache.maven.model.Dependency,ArtifactVersions> map,
                                            boolean includeScope,
                                            boolean includeClassifier,
                                            boolean includeType)

renderPropertySummaryTable

protected void renderPropertySummaryTable(Map<Property,PropertyVersions> map)

renderPropertySummaryTableRow

protected void renderPropertySummaryTableRow(Property property,
                                             PropertyVersions versions)

renderPropertySummaryTableHeader

protected void renderPropertySummaryTableHeader()

renderPropertyDetailTable

protected void renderPropertyDetailTable(Property property,
                                         PropertyVersions versions)