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 java.lang.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 org.apache.maven.plugin.logging.Log
log
private java.lang.String
reportMojoInfo
private org.apache.maven.doxia.site.SiteModel
siteModel
(package private) java.lang.String
title
-
Constructor Summary
Constructors Constructor Description SitemapDocumentRenderer(org.apache.maven.plugin.MojoExecution mojoExecution, org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext, java.lang.String title, org.apache.maven.doxia.site.SiteModel siteModel, org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.plugin.logging.Log log)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static void
extractItems(java.util.List<org.apache.maven.doxia.site.MenuItem> items, org.apache.maven.doxia.sink.Sink sink)
java.lang.String
getOutputName()
java.lang.String
getOutputPath()
org.apache.maven.doxia.siterenderer.DocumentRenderingContext
getRenderingContext()
java.lang.String
getReportMojoInfo()
boolean
isExternalReport()
boolean
isOverwrite()
private static java.lang.String
relativePath(java.lang.String href)
void
renderDocument(java.io.Writer writer, org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer, org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)
-
-
-
Field Detail
-
docRenderingContext
private org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext
-
reportMojoInfo
private final java.lang.String reportMojoInfo
-
title
java.lang.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 Detail
-
SitemapDocumentRenderer
public SitemapDocumentRenderer(org.apache.maven.plugin.MojoExecution mojoExecution, org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext, java.lang.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(java.io.Writer writer, org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer, org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext) throws org.apache.maven.doxia.siterenderer.RendererException, java.io.IOException
- Specified by:
renderDocument
in interfaceorg.apache.maven.doxia.siterenderer.DocumentRenderer
- Throws:
org.apache.maven.doxia.siterenderer.RendererException
java.io.IOException
-
extractItems
private static void extractItems(java.util.List<org.apache.maven.doxia.site.MenuItem> items, org.apache.maven.doxia.sink.Sink sink)
-
relativePath
private static java.lang.String relativePath(java.lang.String href)
-
getOutputName
public java.lang.String getOutputName()
- Specified by:
getOutputName
in interfaceorg.apache.maven.doxia.siterenderer.DocumentRenderer
-
getOutputPath
public java.lang.String getOutputPath()
- Specified by:
getOutputPath
in interfaceorg.apache.maven.doxia.siterenderer.DocumentRenderer
-
getRenderingContext
public org.apache.maven.doxia.siterenderer.DocumentRenderingContext getRenderingContext()
- Specified by:
getRenderingContext
in interfaceorg.apache.maven.doxia.siterenderer.DocumentRenderer
-
isOverwrite
public boolean isOverwrite()
- Specified by:
isOverwrite
in interfaceorg.apache.maven.doxia.siterenderer.DocumentRenderer
-
isExternalReport
public boolean isExternalReport()
- Specified by:
isExternalReport
in interfaceorg.apache.maven.doxia.siterenderer.DocumentRenderer
-
getReportMojoInfo
public java.lang.String getReportMojoInfo()
- Specified by:
getReportMojoInfo
in interfaceSitePluginReportDocumentRenderer
-
-