Package org.codehaus.mojo.versions.reporting

Class VersionsReportRendererBase

java.lang.Object

org.apache.maven.reporting.AbstractMavenReportRenderer

org.codehaus.mojo.versions.reporting.VersionsReportRendererBase

All Implemented Interfaces:

org.apache.maven.reporting.MavenReportRenderer, ReportRenderer

Direct Known Subclasses:

AbstractVersionsReportRenderer

public abstract class VersionsReportRendererBase
extends org.apache.maven.reporting.AbstractMavenReportRenderer
implements ReportRenderer

Base class over AbstractVersionsReportRenderer providing base utility methods

Field Summary

Fields

Modifier and Type	Field	Description
protected String	bundleName	The name of the bundle containing our I18n resources.
protected final 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

Constructors

Modifier	Constructor	Description
protected	VersionsReportRendererBase(org.apache.maven.doxia.sink.Sink sink, org.codehaus.plexus.i18n.I18N i18n, Locale locale, String bundleName, boolean allowSnapshots)

Method Summary

Modifier and Type	Method	Description
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()
boolean	isAllowSnapshots()	If true, the report renderer will include snapshots in the report
protected void	renderBoldCell(boolean bold, Object object)	Renders a bold table cell containing the given text.
protected void	renderBoldCell(Object object)	Renders a bold table cell containing the given text.
protected void	renderBoldText(boolean bold, Object object)	Renders a bold text.
protected void	renderCell(Object object)	Renders a table cell containing the given text.
protected void	renderCells(Object... objects)	Renders multiple cells containing the given texts.
protected void	renderSuccessIcon()
protected void	renderTableHeaderCells(String... keys)	Renders a table header containing elements denoted by the given keys
protected void	renderWarningIcon()

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

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

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

render

Field Details

i18n

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

Internationalization component.

Since:

1.0-beta-1

locale

protected Locale locale

The locale we are rendering for.

Since:

1.0-beta-1

bundleName

protected String bundleName

The name of the bundle containing our I18n resources.

Since:

1.0-beta-1

Constructor Details

VersionsReportRendererBase

protected VersionsReportRendererBase(org.apache.maven.doxia.sink.Sink sink,
 org.codehaus.plexus.i18n.I18N i18n,
 Locale locale,
 String bundleName,
 boolean allowSnapshots)

Method Details

getTitle

public String getTitle()

Specified by:

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

Specified by:

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

isAllowSnapshots

public boolean isAllowSnapshots()

Description copied from interface: ReportRenderer

If true, the report renderer will include snapshots in the report

Specified by:

isAllowSnapshots in interface ReportRenderer

Returns:

if true, the report renderer will include snapshots in the report

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)

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

renderBoldCell

protected void renderBoldCell(Object object)

Renders a bold table cell containing the given text.

Parameters:

object - the text to be rendered, or null for an empty cell.

renderCell

protected void renderCell(Object object)

Renders a table cell containing the given text.

Parameters:

object - the text to be rendered, or null for an empty cell.

renderCells

protected void renderCells(Object... objects)

Renders multiple cells containing the given texts.

Parameters:

objects - the texts to be rendered, null for empty cells.

renderBoldCell

protected void renderBoldCell(boolean bold,
 Object object)

Renders a bold table cell containing the given text.

Parameters:

bold - true to render the cell in bold, false otherwise.

object - the text to be rendered, or null for an empty cell.

renderBoldText

protected void renderBoldText(boolean bold,
 Object object)

Renders a bold text.

Parameters:

bold - true to render the text in bold, false otherwise.

object - the text to be rendered, or null for an empty cell.