org.nuiton.config

Class ApplicationConfigReportRenderer

java.lang.Object

org.apache.maven.reporting.AbstractMavenReportRenderer

org.nuiton.config.ApplicationConfigReportRenderer

All Implemented Interfaces:

org.apache.maven.reporting.MavenReportRenderer

public class ApplicationConfigReportRenderer
extends org.apache.maven.reporting.AbstractMavenReportRenderer

Render the ApplicationConfigReport report.

Since:

2.6.10

Author:

Tony - chemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field and Description
protected String	bundleName The name of the bundle containing our I18n resources.
protected Set<org.nuiton.config.ApplicationConfigProvider>	configProviders Set of config providers to generate.
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization component.
protected Locale	locale The locale we are rendering for.
protected boolean	optionWithDetail To show option in detail.
protected String	reportName The report physical name (used to generated link).

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

sink

Constructor Summary

Constructors

Constructor and Description
ApplicationConfigReportRenderer(org.apache.maven.doxia.sink.Sink sink, org.codehaus.plexus.i18n.I18N i18n, Locale locale, String reportName, String bundleName, Set<org.nuiton.config.ApplicationConfigProvider> configProviders, boolean optionWithDetail)

Method Summary

Modifier and Type	Method and Description
protected String	getDefaultValue(org.nuiton.config.ConfigOptionDef option)
protected Collection<org.nuiton.config.ConfigOptionDef>	getOptions(org.nuiton.config.ApplicationConfigProvider configProvider)
protected String	getText(boolean key)
protected String	getText(String key) Gets the localized message for this report.
String	getTitle()
protected void	renderActionDefsTable(org.nuiton.config.ConfigActionDef... actions)
void	renderBody()
protected void	renderConfigProviderDetail(org.nuiton.config.ApplicationConfigProvider configProvider)
protected void	renderErrorIcon()
protected void	renderInfoIcon()
protected void	renderOptionDefsTable(org.nuiton.config.ApplicationConfigProvider configProvider, Collection<org.nuiton.config.ConfigOptionDef> options)
protected void	renderProviderOptionDetail(org.nuiton.config.ApplicationConfigProvider configProvider, org.nuiton.config.ConfigOptionDef option)
protected void	renderProviderSummaryTable()
protected void	renderSuccessIcon()
protected void	renderWarningIcon()
protected void	sinkCellLink(String text, String url)
protected void	sinkCellText(org.apache.maven.doxia.sink.SinkEventAttributes width, String text)
protected void	sinkCellText(String text)
protected void	sinkCellVerbatimText(String text)
protected void	sinkHeaderCellText(org.apache.maven.doxia.sink.SinkEventAttributes width, String text)
protected void	sinkHeaderCellText(String text)
protected void	sinkLinkToAnchor(String text, String anchor)

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

Field Detail

i18n

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

Internationalization component.

Since:

2.6.10

locale

protected final Locale locale

The locale we are rendering for.

Since:

2.6.10

reportName

protected final String reportName

The report physical name (used to generated link).

Since:

3.0

bundleName

protected final String bundleName

The name of the bundle containing our I18n resources.

Since:

2.6.10

configProviders

protected final Set<org.nuiton.config.ApplicationConfigProvider> configProviders

Set of config providers to generate.

Since:

2.6.10

optionWithDetail

protected final boolean optionWithDetail

To show option in detail.

Since:

2.6.10

Constructor Detail

ApplicationConfigReportRenderer

public ApplicationConfigReportRenderer(org.apache.maven.doxia.sink.Sink sink,
                                       org.codehaus.plexus.i18n.I18N i18n,
                                       Locale locale,
                                       String reportName,
                                       String bundleName,
                                       Set<org.nuiton.config.ApplicationConfigProvider> configProviders,
                                       boolean optionWithDetail)

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

renderBody

public void renderBody()

Specified by:

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

renderProviderSummaryTable

protected void renderProviderSummaryTable()

renderConfigProviderDetail

protected void renderConfigProviderDetail(org.nuiton.config.ApplicationConfigProvider configProvider)

renderOptionDefsTable

protected void renderOptionDefsTable(org.nuiton.config.ApplicationConfigProvider configProvider,
                                     Collection<org.nuiton.config.ConfigOptionDef> options)

renderActionDefsTable

protected void renderActionDefsTable(org.nuiton.config.ConfigActionDef... actions)

renderProviderOptionDetail

protected void renderProviderOptionDetail(org.nuiton.config.ApplicationConfigProvider configProvider,
                                          org.nuiton.config.ConfigOptionDef option)

getText

protected String getText(boolean key)

getText

protected String getText(String key)

Gets the localized message for this report.

Parameters:

key - the message key.

Returns:

the message.

getDefaultValue

protected String getDefaultValue(org.nuiton.config.ConfigOptionDef option)

renderWarningIcon

protected void renderWarningIcon()

renderErrorIcon

protected void renderErrorIcon()

renderSuccessIcon

protected void renderSuccessIcon()

renderInfoIcon

protected void renderInfoIcon()

sinkHeaderCellText

protected void sinkHeaderCellText(String text)

sinkHeaderCellText

protected void sinkHeaderCellText(org.apache.maven.doxia.sink.SinkEventAttributes width,
                                  String text)

sinkCellText

protected void sinkCellText(org.apache.maven.doxia.sink.SinkEventAttributes width,
                            String text)

sinkCellText

protected void sinkCellText(String text)

sinkCellVerbatimText

protected void sinkCellVerbatimText(String text)

sinkCellLink

protected void sinkCellLink(String text,
                            String url)

sinkLinkToAnchor

protected void sinkLinkToAnchor(String text,
                                String anchor)

getOptions

protected Collection<org.nuiton.config.ConfigOptionDef> getOptions(org.nuiton.config.ApplicationConfigProvider configProvider)