Class SitemapDocumentRenderer
java.lang.Object
org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- All Implemented Interfaces:
org.apache.maven.doxia.siterenderer.DocumentRenderer
,SitePluginReportDocumentRenderer
Renders a sitemap report.
- Since:
- 2.1
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionSitemapDocumentRenderer
(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 TypeMethodDescriptionprivate static void
extractItems
(List<org.apache.maven.doxia.site.MenuItem> items, org.apache.maven.doxia.sink.Sink sink) org.apache.maven.doxia.siterenderer.DocumentRenderingContext
boolean
boolean
private static String
relativePath
(String href) void
renderDocument
(Writer writer, org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer, org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)
-
Field Details
-
docRenderingContext
private org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext -
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 interfaceorg.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
-
getOutputName
- Specified by:
getOutputName
in interfaceorg.apache.maven.doxia.siterenderer.DocumentRenderer
-
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
- Specified by:
getReportMojoInfo
in interfaceSitePluginReportDocumentRenderer
-