org.codehaus.mojo.license

Class AbstractLicenseReportRenderer

java.lang.Object

org.apache.maven.reporting.AbstractMavenReportRenderer

org.codehaus.mojo.license.AbstractLicenseReportRenderer

All Implemented Interfaces:

org.apache.maven.reporting.MavenReportRenderer

Direct Known Subclasses:

ThirdPartyReportRenderer

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

Base class for report renderers.

Since:

1.1

Author:

tchemit dev@tchemit.fr

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
AbstractLicenseReportRenderer(org.apache.maven.doxia.sink.Sink sink, String bundleName, org.codehaus.plexus.i18n.I18N i18n, Locale locale)

Method Summary

Modifier and Type	Method and Description
protected String	getGAV(ThirdPartyDetails details)
String	getText(String key) Gets the localized message for this report.
String	getTitle()
protected void	renderErrorIcon()
protected void	renderInfoIcon()
protected void	renderPropertySummaryTableHeader()
protected void	renderSuccessIcon()
protected void	renderThirdPartyDetailTable(ThirdPartyDetails details)
protected void	renderThirdPartyDetailTable(ThirdPartyDetails details, boolean includeScope, boolean includeClassifier, boolean includeType)
protected void	renderThirdPartySummaryTable(Collection<ThirdPartyDetails> collection)
protected void	renderThirdPartySummaryTable(Collection<ThirdPartyDetails> collection, boolean includeScope, boolean includeClassifier, boolean includeType)
protected void	renderThirdPartySummaryTableHeader()
protected void	renderThirdPartySummaryTableHeader(boolean includeScope, boolean includeClassifier, boolean includeType)
protected void	renderThirdPartySummaryTableRow(ThirdPartyDetails details)
protected void	renderThirdPartySummaryTableRow(ThirdPartyDetails details, boolean includeScope, boolean includeClassifier, boolean includeType)
protected void	renderWarningIcon()
protected void	safeBold_()
protected void	safeBold()
protected void	safeItalic_()
protected void	safeItalic()
protected void	sinkCellText(String text)
protected void	sinkCellText(String width, String text)
protected void	sinkHeaderCellText(String text)
protected void	sinkHeaderCellText(String width, String text)

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

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

1.1

locale

protected final Locale locale

The locale we are rendering for.

Since:

1.1

bundleName

protected final String bundleName

The name of the bundle containing our I18n resources.

Since:

1.1

Constructor Detail

AbstractLicenseReportRenderer

public AbstractLicenseReportRenderer(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()

renderErrorIcon

protected void renderErrorIcon()

renderSuccessIcon

protected void renderSuccessIcon()

renderInfoIcon

protected void renderInfoIcon()

getGAV

protected String getGAV(ThirdPartyDetails details)

renderThirdPartySummaryTableHeader

protected void renderThirdPartySummaryTableHeader()

renderThirdPartySummaryTableHeader

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

renderThirdPartySummaryTableRow

protected void renderThirdPartySummaryTableRow(ThirdPartyDetails details)

sinkHeaderCellText

protected void sinkHeaderCellText(String text)

sinkHeaderCellText

protected void sinkHeaderCellText(String width,
                                  String text)

sinkCellText

protected void sinkCellText(String width,
                            String text)

sinkCellText

protected void sinkCellText(String text)

renderThirdPartySummaryTableRow

protected void renderThirdPartySummaryTableRow(ThirdPartyDetails details,
                                               boolean includeScope,
                                               boolean includeClassifier,
                                               boolean includeType)

safeBold

protected void safeBold()

safeBold_

protected void safeBold_()

safeItalic

protected void safeItalic()

safeItalic_

protected void safeItalic_()

renderThirdPartyDetailTable

protected void renderThirdPartyDetailTable(ThirdPartyDetails details)

renderThirdPartyDetailTable

protected void renderThirdPartyDetailTable(ThirdPartyDetails details,
                                           boolean includeScope,
                                           boolean includeClassifier,
                                           boolean includeType)

renderThirdPartySummaryTable

protected void renderThirdPartySummaryTable(Collection<ThirdPartyDetails> collection)

renderThirdPartySummaryTable

protected void renderThirdPartySummaryTable(Collection<ThirdPartyDetails> collection,
                                            boolean includeScope,
                                            boolean includeClassifier,
                                            boolean includeType)

renderPropertySummaryTableHeader

protected void renderPropertySummaryTableHeader()