Package org.apache.maven.plugins.site.render

Class CategorySummaryDocumentRenderer

java.lang.Object

org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer

All Implemented Interfaces:

org.apache.maven.doxia.siterenderer.DocumentRenderer, SitePluginReportDocumentRenderer

public class CategorySummaryDocumentRenderer
extends Object
implements SitePluginReportDocumentRenderer

Renders a Maven report.

Field Summary

Fields

Modifier and Type	Field	Description
private List<org.apache.maven.reporting.MavenReport>	categoryReports
private String	desc1
private String	desc2
private org.apache.maven.doxia.siterenderer.DocumentRenderingContext	docRenderingContext
private org.codehaus.plexus.i18n.I18N	i18n
private final org.apache.maven.plugin.logging.Log	log
private final String	reportMojoInfo
private String	title

Constructor Summary

Constructors

Constructor	Description
CategorySummaryDocumentRenderer(org.apache.maven.plugin.MojoExecution mojoExecution, org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext, String title, String desc1, String desc2, org.codehaus.plexus.i18n.I18N i18n, List<org.apache.maven.reporting.MavenReport> categoryReports, org.apache.maven.plugin.logging.Log log)

Method Summary

Modifier and Type	Method	Description
String	getOutputName()
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 java.lang.Object

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

Methods inherited from interface org.apache.maven.doxia.siterenderer.DocumentRenderer

getOutputPath

Field Details

docRenderingContext

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

reportMojoInfo

private final String reportMojoInfo

title

private String title

desc1

private String desc1

desc2

private String desc2

i18n

private org.codehaus.plexus.i18n.I18N i18n

categoryReports

private List<org.apache.maven.reporting.MavenReport> categoryReports

log

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

Constructor Details

CategorySummaryDocumentRenderer

public CategorySummaryDocumentRenderer(org.apache.maven.plugin.MojoExecution mojoExecution,
 org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext,
 String title,
 String desc1,
 String desc2,
 org.codehaus.plexus.i18n.I18N i18n,
 List<org.apache.maven.reporting.MavenReport> categoryReports,
 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

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

getReportMojoInfo

public String getReportMojoInfo()

Specified by:

getReportMojoInfo in interface SitePluginReportDocumentRenderer