org.apache.maven.plugin.plugin.report

Class AbstractPluginReportRenderer

java.lang.Object

org.apache.maven.reporting.AbstractMavenReportRenderer

org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

All Implemented Interfaces:

org.apache.maven.reporting.MavenReportRenderer

Direct Known Subclasses:

GoalRenderer

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

Base class for all reports generated by the plugin report plugin.

Field Summary

Fields

Modifier and Type	Field and Description
protected Locale	locale
protected org.apache.maven.project.MavenProject	project

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

sink

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPluginReportRenderer(org.apache.maven.doxia.sink.Sink sink, Locale locale, org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.project.MavenProject project)

Method Summary

Modifier and Type	Method and Description
protected abstract String	getI18nSection()
protected String	getI18nString(String key) Returns
protected String	getI18nString(String section, String key)
String	getTitle()

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

Field Detail

locale

protected final Locale locale

project

protected final org.apache.maven.project.MavenProject project

Constructor Detail

AbstractPluginReportRenderer

protected AbstractPluginReportRenderer(org.apache.maven.doxia.sink.Sink sink,
                                       Locale locale,
                                       org.codehaus.plexus.i18n.I18N i18n,
                                       org.apache.maven.project.MavenProject project)

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

getI18nString

protected String getI18nString(String key)

Returns

Parameters:

key - The key .

Returns:

The translated string.

getI18nString

protected String getI18nString(String section,
                               String key)

Parameters:

section - The section.

key - The key to translate.

Returns:

the translated key.

getI18nSection

protected abstract String getI18nSection()

Returns:

the key prefix to be used with every key. Is prepended by report..