org.apache.maven.plugins.site.render

Class ReportDocumentRenderer

java.lang.Object

org.apache.maven.plugins.site.render.ReportDocumentRenderer

All Implemented Interfaces:

DocumentRenderer

public class ReportDocumentRenderer
extends Object
implements DocumentRenderer

Renders a Maven report in a Doxia site.

Author:

Brett Porter

See Also:

DoxiaDocumentRenderer

Constructor Summary

Constructors

Constructor and Description
ReportDocumentRenderer(MavenReportExecution mavenReportExecution, RenderingContext renderingContext, Log log)

Method Summary

Modifier and Type	Method and Description
String	getOutputName()
RenderingContext	getRenderingContext()
boolean	isExternalReport()
boolean	isOverwrite()
void	renderDocument(Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportDocumentRenderer

public ReportDocumentRenderer(MavenReportExecution mavenReportExecution,
                              RenderingContext renderingContext,
                              Log log)

Method Detail

renderDocument

public void renderDocument(Writer writer,
                           Renderer renderer,
                           SiteRenderingContext siteRenderingContext)
                    throws RendererException,
                           FileNotFoundException

Specified by:

renderDocument in interface DocumentRenderer

Throws:

RendererException

FileNotFoundException

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface DocumentRenderer

getRenderingContext

public RenderingContext getRenderingContext()

Specified by:

getRenderingContext in interface DocumentRenderer

isOverwrite

public boolean isOverwrite()

Specified by:

isOverwrite in interface DocumentRenderer

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface DocumentRenderer

Returns:

true if the current report is external, false otherwise