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

public class CategorySummaryDocumentRenderer
extends java.lang.Object
implements org.apache.maven.doxia.siterenderer.DocumentRenderer

Renders a Maven report.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<org.apache.maven.reporting.MavenReport>	categoryReports
private java.lang.String	desc1
private java.lang.String	desc2
private org.codehaus.plexus.i18n.I18N	i18n
private org.apache.maven.plugin.logging.Log	log
private org.apache.maven.doxia.siterenderer.RenderingContext	renderingContext
private java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
CategorySummaryDocumentRenderer(org.apache.maven.doxia.siterenderer.RenderingContext renderingContext, java.lang.String title, java.lang.String desc1, java.lang.String desc2, org.codehaus.plexus.i18n.I18N i18n, java.util.List<org.apache.maven.reporting.MavenReport> categoryReports)
CategorySummaryDocumentRenderer(org.apache.maven.doxia.siterenderer.RenderingContext renderingContext, java.lang.String title, java.lang.String desc1, java.lang.String desc2, org.codehaus.plexus.i18n.I18N i18n, java.util.List<org.apache.maven.reporting.MavenReport> categoryReports, org.apache.maven.plugin.logging.Log log)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOutputName()
org.apache.maven.doxia.siterenderer.RenderingContext	getRenderingContext()
boolean	isExternalReport()
boolean	isOverwrite()
void	renderDocument(java.io.Writer writer, org.apache.maven.doxia.siterenderer.Renderer renderer, 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

Field Detail

renderingContext

private org.apache.maven.doxia.siterenderer.RenderingContext renderingContext

title

private java.lang.String title

desc1

private java.lang.String desc1

desc2

private java.lang.String desc2

i18n

private org.codehaus.plexus.i18n.I18N i18n

categoryReports

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

log

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

Constructor Detail

CategorySummaryDocumentRenderer

public CategorySummaryDocumentRenderer(org.apache.maven.doxia.siterenderer.RenderingContext renderingContext,
                                       java.lang.String title,
                                       java.lang.String desc1,
                                       java.lang.String desc2,
                                       org.codehaus.plexus.i18n.I18N i18n,
                                       java.util.List<org.apache.maven.reporting.MavenReport> categoryReports)

CategorySummaryDocumentRenderer

public CategorySummaryDocumentRenderer(org.apache.maven.doxia.siterenderer.RenderingContext renderingContext,
                                       java.lang.String title,
                                       java.lang.String desc1,
                                       java.lang.String desc2,
                                       org.codehaus.plexus.i18n.I18N i18n,
                                       java.util.List<org.apache.maven.reporting.MavenReport> categoryReports,
                                       org.apache.maven.plugin.logging.Log log)

Method Detail

renderDocument

public void renderDocument(java.io.Writer writer,
                           org.apache.maven.doxia.siterenderer.Renderer renderer,
                           org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)
                    throws org.apache.maven.doxia.siterenderer.RendererException,
                           java.io.FileNotFoundException

Specified by:

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

Throws:

org.apache.maven.doxia.siterenderer.RendererException

java.io.FileNotFoundException

getOutputName

public java.lang.String getOutputName()

Specified by:

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

getRenderingContext

public org.apache.maven.doxia.siterenderer.RenderingContext 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