Package org.apache.maven.plugin.plugin.report

Class PluginOverviewRenderer

java.lang.Object

org.apache.maven.reporting.AbstractMavenReportRenderer

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

org.apache.maven.plugin.plugin.report.PluginOverviewRenderer

All Implemented Interfaces:

org.apache.maven.reporting.MavenReportRenderer

class PluginOverviewRenderer
extends AbstractPluginReportRenderer

Generates an overview page with the list of goals and a link to the goal's page.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	hasExtensionsToLoad
private org.apache.maven.plugin.descriptor.PluginDescriptor	pluginDescriptor
private java.util.List<RequirementsHistory>	requirementsHistories

Fields inherited from class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

locale, project

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

sink

Constructor Summary

Constructors

Constructor	Description
PluginOverviewRenderer(org.apache.maven.doxia.sink.Sink sink, org.codehaus.plexus.i18n.I18N i18n, java.util.Locale locale, org.apache.maven.project.MavenProject project, java.util.List<RequirementsHistory> requirementsHistories, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor, boolean hasExtensionsToLoad)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getI18nSection()
protected void	renderBody()
private void	renderGoalsSection(boolean hasMavenReport)
private void	renderRequirementsHistoriesSection()
private void	renderSystemRequirementsSection()
private void	renderUsageSection(boolean hasMavenReport)	Render the section about the usage of the plugin.

Methods inherited from class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

getI18nString, getI18nString, getTitle

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

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

requirementsHistories

private final java.util.List<RequirementsHistory> requirementsHistories

pluginDescriptor

private final org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor

hasExtensionsToLoad

private final boolean hasExtensionsToLoad

Constructor Detail

PluginOverviewRenderer

PluginOverviewRenderer(org.apache.maven.doxia.sink.Sink sink,
                       org.codehaus.plexus.i18n.I18N i18n,
                       java.util.Locale locale,
                       org.apache.maven.project.MavenProject project,
                       java.util.List<RequirementsHistory> requirementsHistories,
                       org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor,
                       boolean hasExtensionsToLoad)

Parameters:

sink - not null

i18n - not null

locale - not null

project - not null

requirementsHistories - not null

pluginDescriptor - not null

Method Detail

renderBody

protected void renderBody()

Specified by:

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

renderGoalsSection

private void renderGoalsSection(boolean hasMavenReport)

renderSystemRequirementsSection

private void renderSystemRequirementsSection()

renderRequirementsHistoriesSection

private void renderRequirementsHistoriesSection()

renderUsageSection

private void renderUsageSection(boolean hasMavenReport)

Render the section about the usage of the plugin.

Parameters:

hasMavenReport - If the plugin has a report or not

getI18nSection

protected java.lang.String getI18nSection()

Specified by:

getI18nSection in class AbstractPluginReportRenderer

Returns:

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