org.apache.maven.plugins.site.render

Class SitemapDocumentRenderer

java.lang.Object

org.apache.maven.plugins.site.render.SitemapDocumentRenderer

All Implemented Interfaces:

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

public class SitemapDocumentRenderer
extends Object
implements SitePluginReportDocumentRenderer

Renders a sitemap report.

Since:

2.1

Author:

ltheussl

Constructor Summary

Constructors

Constructor and Description
SitemapDocumentRenderer(org.apache.maven.plugin.MojoExecution mojoExecution, org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext, String title, org.apache.maven.doxia.site.SiteModel siteModel, org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.plugin.logging.Log log)

Method Summary

Modifier and Type	Method and 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 java.lang.Object

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

Constructor Detail

SitemapDocumentRenderer

public SitemapDocumentRenderer(org.apache.maven.plugin.MojoExecution mojoExecution,
                               org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext,
                               String title,
                               org.apache.maven.doxia.site.SiteModel siteModel,
                               org.codehaus.plexus.i18n.I18N i18n,
                               org.apache.maven.plugin.logging.Log log)

Method Detail

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

getReportMojoInfo

public String getReportMojoInfo()

Specified by:

getReportMojoInfo in interface SitePluginReportDocumentRenderer