Package 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

Field Summary

Fields

Modifier and Type	Field	Description
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 org.apache.maven.doxia.site.SiteModel	siteModel
(package private) String	title

Constructor Summary

Constructors

Constructor	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	Description
private static void	extractItems(List<org.apache.maven.doxia.site.MenuItem> items, org.apache.maven.doxia.sink.Sink sink)
String	getOutputName()
String	getOutputPath()
org.apache.maven.doxia.siterenderer.DocumentRenderingContext	getRenderingContext()
String	getReportMojoInfo()
boolean	isExternalReport()
boolean	isOverwrite()
private static String	relativePath(String href)
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

Field Details

docRenderingContext

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

reportMojoInfo

private final String reportMojoInfo

title

String title

siteModel

private org.apache.maven.doxia.site.SiteModel siteModel

i18n

private org.codehaus.plexus.i18n.I18N i18n

log

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

Constructor Details

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 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

extractItems

private static void extractItems(List<org.apache.maven.doxia.site.MenuItem> items,
 org.apache.maven.doxia.sink.Sink sink)

relativePath

private static String relativePath(String href)

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