de.smartics.maven.apidoc
Class JavadocMessageReportRenderer

java.lang.Object
  org.apache.maven.reporting.AbstractMavenReportRenderer
      de.smartics.maven.apidoc.JavadocMessageReportRenderer

All Implemented Interfaces:

MavenReportRenderer

public class JavadocMessageReportRenderer
     
     

      
      extends 
      
      AbstractMavenReportRenderer
     
     

Renders the Javadoc tool messages to a Maven report.

Author:

Robert Reiner

Field Summary

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

sink

Constructor Summary

JavadocMessageReportRenderer(Sink sink, JavadocMessageConfig messageConfig, JavadocMessageLogger logger)
Default constructor.

Method Summary

String	getTitle()
protected void	renderBody()
protected void	renderFooter() Renders the footer text.
protected void	renderTitle(boolean hasResults) Renders the title block of the report.

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

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

Constructor Detail

JavadocMessageReportRenderer

public JavadocMessageReportRenderer(Sink sink,
                                    JavadocMessageConfig messageConfig,
                                    JavadocMessageLogger logger)

Default constructor.

Parameters:

sink - the sink to write to.

messageConfig - the configuration to control the report rendering.

logger - the information to render to the report.

Method Detail

getTitle

public String getTitle()

Specified by:

getTitle in interface MavenReportRenderer

Specified by:

getTitle in class AbstractMavenReportRenderer

See Also:

AbstractMavenReportRenderer.getTitle()

renderBody

protected void renderBody()

Specified by:

renderBody in class AbstractMavenReportRenderer

See Also:

AbstractMavenReportRenderer.renderBody()

renderTitle

protected void renderTitle(boolean hasResults)

Renders the title block of the report.

Parameters:

hasResults - true if the report renders results (at least one message issued by the Javadoc tool), false otherwise.

renderFooter

protected void renderFooter()

Renders the footer text.