Class ReportDocumentRenderer

java.lang.Object

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

All Implemented Interfaces:

org.apache.maven.doxia.siterenderer.DocumentRenderer

public class ReportDocumentRenderer
extends Object
implements org.apache.maven.doxia.siterenderer.DocumentRenderer

Renders a Maven report in a Doxia site.

See Also:

• DoxiaDocumentRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ReportDocumentRenderer.MultiPageSinkFactory
private static class	ReportDocumentRenderer.MultiPageSubSink

Field Summary

Fields

Modifier and Type	Field	Description
private final ClassLoader	classLoader
private final org.apache.maven.doxia.siterenderer.DocumentRenderingContext	docRenderingContext
private final org.apache.maven.plugin.logging.Log	log
private final org.apache.maven.reporting.MavenReport	report
private final String	reportMojoInfo

Constructor Summary

Constructors

Constructor	Description
ReportDocumentRenderer(org.apache.maven.reporting.exec.MavenReportExecution mavenReportExecution, org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext, org.apache.maven.plugin.logging.Log log)

Method Summary

Modifier and Type	Method	Description
String	getOutputName()
String	getOutputPath()
org.apache.maven.doxia.siterenderer.DocumentRenderingContext	getRenderingContext()
String	getReportMojoInfo()
boolean	isExternalReport()
boolean	isOverwrite()
void	renderDocument(Writer writer, org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer, org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)

Methods inherited from class Object

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

Field Details

report

private final org.apache.maven.reporting.MavenReport report

docRenderingContext

private final org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext

reportMojoInfo

private final String reportMojoInfo

classLoader

private final ClassLoader classLoader

log

private final org.apache.maven.plugin.logging.Log log

Constructor Details

ReportDocumentRenderer

public ReportDocumentRenderer(org.apache.maven.reporting.exec.MavenReportExecution mavenReportExecution,
 org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext,
 org.apache.maven.plugin.logging.Log log)

Method Details

renderDocument

public void renderDocument(Writer writer,
 org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer,
 org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)
                    throws org.apache.maven.doxia.siterenderer.RendererException,
IOException

Specified by:

renderDocument in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

Throws:

org.apache.maven.doxia.siterenderer.RendererException

IOException

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

getOutputPath

public String getOutputPath()

Specified by:

getOutputPath in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

getRenderingContext

public org.apache.maven.doxia.siterenderer.DocumentRenderingContext getRenderingContext()

Specified by:

getRenderingContext in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

isOverwrite

public boolean isOverwrite()

Specified by:

isOverwrite in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

Returns:

true if the current report is external, false otherwise

getReportMojoInfo

public String getReportMojoInfo()