org.apache.maven.plugins.site

Class CategorySummaryDocumentRenderer

java.lang.Object

org.apache.maven.plugins.site.CategorySummaryDocumentRenderer

All Implemented Interfaces:

org.apache.maven.doxia.siterenderer.DocumentRenderer

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

Renders a Maven report.

Author:

Brett Porter

Constructor Summary

Constructors

Constructor and Description
CategorySummaryDocumentRenderer(org.apache.maven.doxia.sink.render.RenderingContext renderingContext, String title, String desc1, String desc2, org.codehaus.plexus.i18n.I18N i18n, List categoryReports)
CategorySummaryDocumentRenderer(org.apache.maven.doxia.sink.render.RenderingContext renderingContext, String title, String desc1, String desc2, org.codehaus.plexus.i18n.I18N i18n, List categoryReports, org.apache.maven.plugin.logging.Log log)

Method Summary

Methods

Modifier and Type	Method and Description
String	getOutputName()
org.apache.maven.doxia.sink.render.RenderingContext	getRenderingContext()
boolean	isOverwrite()
void	renderDocument(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

Constructor Detail

CategorySummaryDocumentRenderer

public CategorySummaryDocumentRenderer(org.apache.maven.doxia.sink.render.RenderingContext renderingContext,
                               String title,
                               String desc1,
                               String desc2,
                               org.codehaus.plexus.i18n.I18N i18n,
                               List categoryReports)

CategorySummaryDocumentRenderer

public CategorySummaryDocumentRenderer(org.apache.maven.doxia.sink.render.RenderingContext renderingContext,
                               String title,
                               String desc1,
                               String desc2,
                               org.codehaus.plexus.i18n.I18N i18n,
                               List categoryReports,
                               org.apache.maven.plugin.logging.Log log)

Method Detail

renderDocument

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

Specified by:

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

Throws:

org.apache.maven.doxia.siterenderer.RendererException

FileNotFoundException

getOutputName

public String getOutputName()

Specified by:

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

getRenderingContext

public org.apache.maven.doxia.sink.render.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