Modified:
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html
==============================================================================
---
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html
(original)
+++
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html
Sat Apr 8 16:33:46 2023
@@ -34,9 +34,9 @@
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.DocumentRenderer;
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.Renderer;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.RendererException;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.RenderingContext;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.SiteRenderer;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.SiteRenderingContext;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.plugin.logging.Log;
@@ -49,7 +49,7 @@
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment"> * @author <a href="<a
href="mailto:[email protected]";
target="alexandria_uri">mailto:[email protected]</a>">Brett
Porter</a></em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a name="CategorySummaryDocumentRenderer"
href="../../../../../../org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer">CategorySummaryDocumentRenderer</a>
<strong class="jxr_keyword">implements</strong> DocumentRenderer {
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">private</strong> RenderingContext docRenderingContext;
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">private</strong> DocumentRenderingContext
docRenderingContext;
<a class="jxr_linenumber" name="L45" href="#L45">45</a>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong
class="jxr_keyword">private</strong> String title;
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
@@ -64,7 +64,7 @@
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
Log log;
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong
class="jxr_keyword">public</strong> <a name="CategorySummaryDocumentRenderer"
href="../../../../../../org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer">CategorySummaryDocumentRenderer</a>(
-<a class="jxr_linenumber" name="L59" href="#L59">59</a>
RenderingContext docRenderingContext,
+<a class="jxr_linenumber" name="L59" href="#L59">59</a>
DocumentRenderingContext docRenderingContext,
<a class="jxr_linenumber" name="L60" href="#L60">60</a> String
title,
<a class="jxr_linenumber" name="L61" href="#L61">61</a> String
desc1,
<a class="jxr_linenumber" name="L62" href="#L62">62</a> String
desc2,
@@ -74,7 +74,7 @@
<a class="jxr_linenumber" name="L66" href="#L66">66</a> }
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong
class="jxr_keyword">public</strong> <a name="CategorySummaryDocumentRenderer"
href="../../../../../../org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer">CategorySummaryDocumentRenderer</a>(
-<a class="jxr_linenumber" name="L69" href="#L69">69</a>
RenderingContext docRenderingContext,
+<a class="jxr_linenumber" name="L69" href="#L69">69</a>
DocumentRenderingContext docRenderingContext,
<a class="jxr_linenumber" name="L70" href="#L70">70</a> String
title,
<a class="jxr_linenumber" name="L71" href="#L71">71</a> String
desc1,
<a class="jxr_linenumber" name="L72" href="#L72">72</a> String
desc2,
@@ -90,7 +90,7 @@
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong
class="jxr_keyword">this</strong>.log = log;
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext
siteRenderingContext)
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext
siteRenderingContext)
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong
class="jxr_keyword">throws</strong> RendererException, FileNotFoundException {
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
SiteRendererSink sink = <strong class="jxr_keyword">new</strong>
SiteRendererSink(docRenderingContext);
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
@@ -184,7 +184,7 @@
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong
class="jxr_keyword">return</strong> docRenderingContext.getOutputName();
<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
<a class="jxr_linenumber" name="L178" href="#L178">178</a>
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong
class="jxr_keyword">public</strong> RenderingContext getRenderingContext() {
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong
class="jxr_keyword">public</strong> DocumentRenderingContext
getRenderingContext() {
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong
class="jxr_keyword">return</strong> docRenderingContext;
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
<a class="jxr_linenumber" name="L182" href="#L182">182</a>
Modified:
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/ReportDocumentRenderer.html
==============================================================================
---
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/ReportDocumentRenderer.html
(original)
+++
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/ReportDocumentRenderer.html
Sat Apr 8 16:33:46 2023
@@ -35,21 +35,21 @@
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.SinkFactory;
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.DocumentRenderer;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.Renderer;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.RendererException;
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.RenderingContext;
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.SiteRenderingContext;
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.plugin.logging.Log;
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.MavenMultiPageReport;
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport;
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.MavenReportException;
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.exec.MavenReportExecution;
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.PathTool;
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.SinkFactory;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.DocumentRenderer;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.RendererException;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.SiteRenderer;
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.SiteRenderingContext;
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.plugin.logging.Log;
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.MavenMultiPageReport;
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport;
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.MavenReportException;
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.exec.MavenReportExecution;
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.PathTool;
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.WriterFactory;
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong
class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong>
org.apache.maven.shared.utils.logging.MessageUtils.buffer;
@@ -63,7 +63,7 @@
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a name="ReportDocumentRenderer"
href="../../../../../../org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#ReportDocumentRenderer">ReportDocumentRenderer</a>
<strong class="jxr_keyword">implements</strong> DocumentRenderer {
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
MavenReport report;
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
RenderingContext docRenderingContext;
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
DocumentRenderingContext docRenderingContext;
<a class="jxr_linenumber" name="L59" href="#L59">59</a>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
String reportMojoInfo;
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
@@ -72,7 +72,7 @@
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
Log log;
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong
class="jxr_keyword">public</strong> <a name="ReportDocumentRenderer"
href="../../../../../../org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#ReportDocumentRenderer">ReportDocumentRenderer</a>(
-<a class="jxr_linenumber" name="L67" href="#L67">67</a>
MavenReportExecution mavenReportExecution, RenderingContext
docRenderingContext, Log log) {
+<a class="jxr_linenumber" name="L67" href="#L67">67</a>
MavenReportExecution mavenReportExecution, DocumentRenderingContext
docRenderingContext, Log log) {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong
class="jxr_keyword">this</strong>.report =
mavenReportExecution.getMavenReport();
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong
class="jxr_keyword">this</strong>.docRenderingContext = docRenderingContext;
@@ -94,7 +94,7 @@
<a class="jxr_linenumber" name="L86" href="#L86">86</a>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong
class="jxr_keyword">private</strong> String outputName;
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a>
MultiPageSubSink(File outputDir, String outputName, RenderingContext
docRenderingContext) {
+<a class="jxr_linenumber" name="L89" href="#L89">89</a>
MultiPageSubSink(File outputDir, String outputName, DocumentRenderingContext
docRenderingContext) {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong
class="jxr_keyword">super</strong>(docRenderingContext);
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong
class="jxr_keyword">this</strong>.outputName = outputName;
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong
class="jxr_keyword">this</strong>.outputDir = outputDir;
@@ -116,16 +116,16 @@
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong
class="jxr_keyword">private</strong> MavenReport report;
<a class="jxr_linenumber" name="L109" href="#L109">109</a>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em
class="jxr_javadoccomment"> * The main RenderingContext, which is the
base for the RenderingContext of subpages</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em
class="jxr_javadoccomment"> * The main DocumentRenderingContext, which
is the base for the DocumentRenderingContext of subpages</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong
class="jxr_keyword">private</strong> RenderingContext docRenderingContext;
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong
class="jxr_keyword">private</strong> DocumentRenderingContext
docRenderingContext;
<a class="jxr_linenumber" name="L114" href="#L114">114</a>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em
class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em
class="jxr_javadoccomment"> * List of sinks (subpages) associated to
this report</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em
class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong
class="jxr_keyword">private</strong> List<MultiPageSubSink> sinks =
<strong class="jxr_keyword">new</strong> ArrayList<MultiPageSubSink>();
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
-<a class="jxr_linenumber" name="L120" href="#L120">120</a>
MultiPageSinkFactory(MavenReport report, RenderingContext docRenderingContext) {
+<a class="jxr_linenumber" name="L120" href="#L120">120</a>
MultiPageSinkFactory(MavenReport report, DocumentRenderingContext
docRenderingContext) {
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong
class="jxr_keyword">this</strong>.report = report;
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong
class="jxr_keyword">this</strong>.docRenderingContext = docRenderingContext;
<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
@@ -136,7 +136,7 @@
<a class="jxr_linenumber" name="L128" href="#L128">128</a> String
outputRelativeToTargetSite = PathTool.getRelativeFilePath(
<a class="jxr_linenumber" name="L129" href="#L129">129</a>
report.getReportOutputDirectory().getPath(), <strong
class="jxr_keyword">new</strong> File(outputDir, outputName).getPath());
<a class="jxr_linenumber" name="L130" href="#L130">130</a>
-<a class="jxr_linenumber" name="L131" href="#L131">131</a>
RenderingContext subSinkContext = <strong class="jxr_keyword">new</strong>
RenderingContext(
+<a class="jxr_linenumber" name="L131" href="#L131">131</a>
DocumentRenderingContext subSinkContext = <strong
class="jxr_keyword">new</strong> DocumentRenderingContext(
<a class="jxr_linenumber" name="L132" href="#L132">132</a>
docRenderingContext.getBasedir(),
<a class="jxr_linenumber" name="L133" href="#L133">133</a>
docRenderingContext.getBasedirRelativePath(),
<a class="jxr_linenumber" name="L134" href="#L134">134</a>
outputRelativeToTargetSite,
@@ -178,7 +178,7 @@
<a class="jxr_linenumber" name="L170" href="#L170">170</a> }
<a class="jxr_linenumber" name="L171" href="#L171">171</a>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> @Override
-<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext
siteRenderingContext)
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext
siteRenderingContext)
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong
class="jxr_keyword">throws</strong> RendererException, FileNotFoundException {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> Locale
locale = siteRenderingContext.getLocale();
<a class="jxr_linenumber" name="L176" href="#L176">176</a> String
localReportName = report.getName(locale);
@@ -277,7 +277,7 @@
<a class="jxr_linenumber" name="L269" href="#L269">269</a> }
<a class="jxr_linenumber" name="L270" href="#L270">270</a>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> @Override
-<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong
class="jxr_keyword">public</strong> RenderingContext getRenderingContext() {
+<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong
class="jxr_keyword">public</strong> DocumentRenderingContext
getRenderingContext() {
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong
class="jxr_keyword">return</strong> docRenderingContext;
<a class="jxr_linenumber" name="L274" href="#L274">274</a> }
<a class="jxr_linenumber" name="L275" href="#L275">275</a>
Modified:
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/SiteMap.html
==============================================================================
---
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/SiteMap.html
(original)
+++
maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/SiteMap.html
Sat Apr 8 16:33:46 2023
@@ -33,152 +33,160 @@
<a class="jxr_linenumber" name="L25" href="#L25">25</a>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.module.xdoc.XdocSinkFactory;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.site.decoration.DecorationModel;
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.Menu;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.site.decoration.MenuItem;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N;
-<a class="jxr_linenumber" name="L32" href="#L32">32</a>
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em
class="jxr_javadoccomment"> * Generate a sitemap.</em>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em
class="jxr_javadoccomment"> * @author ltheussl</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment"> * @since 2.1</em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a name="SiteMap"
href="../../../../../../org/apache/maven/plugins/site/render/SiteMap.html#SiteMap">SiteMap</a>
{
-<a class="jxr_linenumber" name="L41" href="#L41">41</a>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">private</strong> String encoding;
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">private</strong> I18N i18n;
-<a class="jxr_linenumber" name="L44" href="#L44">44</a>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> * Constructor sets default values.</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em
class="jxr_javadoccomment"> * @param encoding the default encoding to use
when writing the output file.</em>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em
class="jxr_javadoccomment"> * @param i18n the default I18N for
translations.</em>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong
class="jxr_keyword">public</strong> <a name="SiteMap"
href="../../../../../../org/apache/maven/plugins/site/render/SiteMap.html#SiteMap">SiteMap</a>(String
encoding, I18N i18n) {
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong
class="jxr_keyword">this</strong>.encoding = encoding;
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong
class="jxr_keyword">this</strong>.i18n = i18n;
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
-<a class="jxr_linenumber" name="L55" href="#L55">55</a>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em
class="jxr_javadoccomment"> * Get the value of i18n.</em>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> * @return the value of i18n.</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong
class="jxr_keyword">public</strong> I18N getI18n() {
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong
class="jxr_keyword">return</strong> i18n;
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> }
-<a class="jxr_linenumber" name="L64" href="#L64">64</a>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment"> * Set the value of i18n.</em>
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em
class="jxr_javadoccomment"> * @param i18n new value of i18n.</em>
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setI18n(I18N i18n) {
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong
class="jxr_keyword">this</strong>.i18n = i18n;
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
-<a class="jxr_linenumber" name="L73" href="#L73">73</a>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em
class="jxr_javadoccomment"> * Get the encoding to use when writing the
output file.</em>
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em
class="jxr_javadoccomment"> * @return the value of encoding.</em>
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong
class="jxr_keyword">public</strong> String getEncoding() {
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong
class="jxr_keyword">return</strong> encoding;
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
-<a class="jxr_linenumber" name="L82" href="#L82">82</a>
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em
class="jxr_javadoccomment"> * Set the encoding to use when writing the
output file.</em>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em
class="jxr_javadoccomment"> * @param enc new value of encoding.</em>
-<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setEncoding(String enc) {
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong
class="jxr_keyword">this</strong>.encoding = enc;
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
-<a class="jxr_linenumber" name="L91" href="#L91">91</a>
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment"> * Generates a sitemap.xml in
targetDir/xdoc/.</em>
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em
class="jxr_javadoccomment"> * This is a valid xdoc document that can be
processed by a Doxia parser.</em>
-<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em
class="jxr_javadoccomment"> * The file lists all the menus and menu items
of the DecorationModel in expanded form.</em>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em
class="jxr_javadoccomment"> * @param model the DecorationModel to extract
the menus from.</em>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em
class="jxr_javadoccomment"> * @param targetDir the target output directory.
The file will be created in targetDir/xdoc/.</em>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em
class="jxr_javadoccomment"> * @param locale the Locale for the result.</em>
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em
class="jxr_javadoccomment"> * @throws IOException if the file cannot be
ceated.</em>
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
generate(DecorationModel model, File targetDir, Locale locale) <strong
class="jxr_keyword">throws</strong> IOException {
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> File
outputDir = <strong class="jxr_keyword">new</strong> File(targetDir, <span
class="jxr_string">"xdoc"</span>);
-<a class="jxr_linenumber" name="L105" href="#L105">105</a> Sink sink =
<strong class="jxr_keyword">new</strong>
XdocSinkFactory().createSink(outputDir, <span
class="jxr_string">"sitemap.xml"</span>, encoding);
-<a class="jxr_linenumber" name="L106" href="#L106">106</a>
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong
class="jxr_keyword">try</strong> {
-<a class="jxr_linenumber" name="L108" href="#L108">108</a>
extract(model, sink, locale);
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> } <strong
class="jxr_keyword">finally</strong> {
-<a class="jxr_linenumber" name="L110" href="#L110">110</a>
sink.close();
-<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
-<a class="jxr_linenumber" name="L113" href="#L113">113</a>
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong>
extract(DecorationModel decoration, Sink sink, Locale locale) {
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> sink.head();
-<a class="jxr_linenumber" name="L116" href="#L116">116</a>
sink.title();
-<a class="jxr_linenumber" name="L117" href="#L117">117</a>
sink.text(i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale,
<span class="jxr_string">"site.sitemap.title"</span>));
-<a class="jxr_linenumber" name="L118" href="#L118">118</a>
sink.title_();
-<a class="jxr_linenumber" name="L119" href="#L119">119</a>
sink.head_();
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> sink.body();
-<a class="jxr_linenumber" name="L121" href="#L121">121</a>
-<a class="jxr_linenumber" name="L122" href="#L122">122</a>
sink.section1();
-<a class="jxr_linenumber" name="L123" href="#L123">123</a>
sink.sectionTitle1();
-<a class="jxr_linenumber" name="L124" href="#L124">124</a>
sink.text(i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale,
<span class="jxr_string">"site.sitemap.section.title"</span>));
-<a class="jxr_linenumber" name="L125" href="#L125">125</a>
sink.sectionTitle1_();
-<a class="jxr_linenumber" name="L126" href="#L126">126</a>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a>
sink.paragraph();
-<a class="jxr_linenumber" name="L128" href="#L128">128</a>
sink.text(i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale,
<span class="jxr_string">"site.sitemap.description"</span>));
-<a class="jxr_linenumber" name="L129" href="#L129">129</a>
sink.paragraph_();
-<a class="jxr_linenumber" name="L130" href="#L130">130</a>
-<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong
class="jxr_keyword">for</strong> (Menu menu : decoration.getMenus()) {
-<a class="jxr_linenumber" name="L132" href="#L132">132</a>
sink.section3();
-<a class="jxr_linenumber" name="L133" href="#L133">133</a>
sink.sectionTitle3();
-<a class="jxr_linenumber" name="L134" href="#L134">134</a>
sink.text(menu.getName());
-<a class="jxr_linenumber" name="L135" href="#L135">135</a>
sink.sectionTitle3_();
-<a class="jxr_linenumber" name="L136" href="#L136">136</a>
sink.horizontalRule();
-<a class="jxr_linenumber" name="L137" href="#L137">137</a>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a>
extractItems(menu.getItems(), sink);
-<a class="jxr_linenumber" name="L139" href="#L139">139</a>
-<a class="jxr_linenumber" name="L140" href="#L140">140</a>
sink.section3_();
-<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
-<a class="jxr_linenumber" name="L142" href="#L142">142</a>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a>
sink.section1_();
-<a class="jxr_linenumber" name="L144" href="#L144">144</a>
sink.body_();
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
-<a class="jxr_linenumber" name="L146" href="#L146">146</a>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong>
extractItems(List<MenuItem> items, Sink sink) {
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong
class="jxr_keyword">if</strong> (items == <strong
class="jxr_keyword">null</strong> || items.isEmpty()) {
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong
class="jxr_keyword">return</strong>;
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> }
-<a class="jxr_linenumber" name="L151" href="#L151">151</a>
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> sink.list();
-<a class="jxr_linenumber" name="L153" href="#L153">153</a>
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong
class="jxr_keyword">for</strong> (MenuItem item : items) {
-<a class="jxr_linenumber" name="L155" href="#L155">155</a>
sink.listItem();
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong
class="jxr_keyword">if</strong> (item.getHref() != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L157" href="#L157">157</a>
sink.link(relativePath(item.getHref()));
-<a class="jxr_linenumber" name="L158" href="#L158">158</a>
sink.text(item.getName());
-<a class="jxr_linenumber" name="L159" href="#L159">159</a>
sink.link_();
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
-<a class="jxr_linenumber" name="L161" href="#L161">161</a>
-<a class="jxr_linenumber" name="L162" href="#L162">162</a>
extractItems(item.getItems(), sink);
-<a class="jxr_linenumber" name="L163" href="#L163">163</a>
sink.listItem_();
-<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
-<a class="jxr_linenumber" name="L165" href="#L165">165</a>
-<a class="jxr_linenumber" name="L166" href="#L166">166</a>
sink.list_();
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> }
-<a class="jxr_linenumber" name="L168" href="#L168">168</a>
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_comment">// sitemap.html gets generated into top-level so we only
have to check leading slashes</em>
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> String relativePath(String href) {
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong
class="jxr_keyword">return</strong> href.startsWith(<span
class="jxr_string">"/"</span>) ? <span class="jxr_string">"."</span> + href :
href;
-<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
-<a class="jxr_linenumber" name="L173" href="#L173">173</a> }
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.site.Menu;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.site.MenuItem;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.site.SiteModel;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em
class="jxr_javadoccomment"> * Generate a sitemap.</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em
class="jxr_javadoccomment"> * @author ltheussl</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment"> * @since 2.1</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a name="SiteMap"
href="../../../../../../org/apache/maven/plugins/site/render/SiteMap.html#SiteMap">SiteMap</a>
{
+<a class="jxr_linenumber" name="L42" href="#L42">42</a>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">private</strong> String encoding;
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">private</strong> I18N i18n;
+<a class="jxr_linenumber" name="L45" href="#L45">45</a>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> * Constructor sets default values.</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em
class="jxr_javadoccomment"> * @param encoding the default encoding to use
when writing the output file.</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em
class="jxr_javadoccomment"> * @param i18n the default I18N for
translations.</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong
class="jxr_keyword">public</strong> <a name="SiteMap"
href="../../../../../../org/apache/maven/plugins/site/render/SiteMap.html#SiteMap">SiteMap</a>(String
encoding, I18N i18n) {
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong
class="jxr_keyword">this</strong>.encoding = encoding;
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong
class="jxr_keyword">this</strong>.i18n = i18n;
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> }
+<a class="jxr_linenumber" name="L56" href="#L56">56</a>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_javadoccomment"> * Get the value of i18n.</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em
class="jxr_javadoccomment"> * @return the value of i18n.</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong
class="jxr_keyword">public</strong> I18N getI18n() {
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong
class="jxr_keyword">return</strong> i18n;
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> }
+<a class="jxr_linenumber" name="L65" href="#L65">65</a>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em
class="jxr_javadoccomment"> * Set the value of i18n.</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em
class="jxr_javadoccomment"> * @param i18n new value of i18n.</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setI18n(I18N i18n) {
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong
class="jxr_keyword">this</strong>.i18n = i18n;
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
+<a class="jxr_linenumber" name="L74" href="#L74">74</a>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em
class="jxr_javadoccomment"> * Get the encoding to use when writing the
output file.</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em
class="jxr_javadoccomment"> * @return the value of encoding.</em>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong
class="jxr_keyword">public</strong> String getEncoding() {
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong
class="jxr_keyword">return</strong> encoding;
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
+<a class="jxr_linenumber" name="L83" href="#L83">83</a>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em
class="jxr_javadoccomment"> * Set the encoding to use when writing the
output file.</em>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em
class="jxr_javadoccomment"> * @param enc new value of encoding.</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setEncoding(String enc) {
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong
class="jxr_keyword">this</strong>.encoding = enc;
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
+<a class="jxr_linenumber" name="L92" href="#L92">92</a>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em
class="jxr_javadoccomment"> * Generates a sitemap.xml in
targetDir/(locale/)?xdoc/.</em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em
class="jxr_javadoccomment"> * This is a valid xdoc document that can be
processed by a Doxia parser.</em>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em
class="jxr_javadoccomment"> * The file lists all the menus and menu items
of the SiteModel in expanded form.</em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em
class="jxr_javadoccomment"> * @param siteModel the SiteModel to extract the
menus from.</em>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em
class="jxr_javadoccomment"> * @param targetDir the target output directory.
The file will be created in targetDir/(locale/)?xdoc/.</em>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em
class="jxr_javadoccomment"> * @param locale the Locale for the result.</em>
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em
class="jxr_javadoccomment"> * @throws IOException if the file cannot be
ceated.</em>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
generate(SiteModel siteModel, File targetDir, Locale locale) <strong
class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> File
outputDir;
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong
class="jxr_keyword">if</strong> (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
+<a class="jxr_linenumber" name="L107" href="#L107">107</a>
outputDir = <strong class="jxr_keyword">new</strong> File(<strong
class="jxr_keyword">new</strong> File(targetDir, locale.toString()), <span
class="jxr_string">"xdoc"</span>);
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> } <strong
class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L109" href="#L109">109</a>
outputDir = <strong class="jxr_keyword">new</strong> File(targetDir, <span
class="jxr_string">"xdoc"</span>);
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> Sink sink =
<strong class="jxr_keyword">new</strong>
XdocSinkFactory().createSink(outputDir, <span
class="jxr_string">"sitemap.xml"</span>, encoding);
+<a class="jxr_linenumber" name="L112" href="#L112">112</a>
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong
class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L114" href="#L114">114</a>
extract(siteModel, sink, locale);
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> } <strong
class="jxr_keyword">finally</strong> {
+<a class="jxr_linenumber" name="L116" href="#L116">116</a>
sink.close();
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
+<a class="jxr_linenumber" name="L119" href="#L119">119</a>
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong>
extract(SiteModel siteModel, Sink sink, Locale locale) {
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> sink.head();
+<a class="jxr_linenumber" name="L122" href="#L122">122</a>
sink.title();
+<a class="jxr_linenumber" name="L123" href="#L123">123</a>
sink.text(i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale,
<span class="jxr_string">"site.sitemap.title"</span>));
+<a class="jxr_linenumber" name="L124" href="#L124">124</a>
sink.title_();
+<a class="jxr_linenumber" name="L125" href="#L125">125</a>
sink.head_();
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> sink.body();
+<a class="jxr_linenumber" name="L127" href="#L127">127</a>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a>
sink.section1();
+<a class="jxr_linenumber" name="L129" href="#L129">129</a>
sink.sectionTitle1();
+<a class="jxr_linenumber" name="L130" href="#L130">130</a>
sink.text(i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale,
<span class="jxr_string">"site.sitemap.section.title"</span>));
+<a class="jxr_linenumber" name="L131" href="#L131">131</a>
sink.sectionTitle1_();
+<a class="jxr_linenumber" name="L132" href="#L132">132</a>
+<a class="jxr_linenumber" name="L133" href="#L133">133</a>
sink.paragraph();
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>
sink.text(i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale,
<span class="jxr_string">"site.sitemap.description"</span>));
+<a class="jxr_linenumber" name="L135" href="#L135">135</a>
sink.paragraph_();
+<a class="jxr_linenumber" name="L136" href="#L136">136</a>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong
class="jxr_keyword">for</strong> (Menu menu : siteModel.getMenus()) {
+<a class="jxr_linenumber" name="L138" href="#L138">138</a>
sink.section2();
+<a class="jxr_linenumber" name="L139" href="#L139">139</a>
sink.sectionTitle2();
+<a class="jxr_linenumber" name="L140" href="#L140">140</a>
sink.text(menu.getName());
+<a class="jxr_linenumber" name="L141" href="#L141">141</a>
sink.sectionTitle2_();
+<a class="jxr_linenumber" name="L142" href="#L142">142</a>
sink.horizontalRule();
+<a class="jxr_linenumber" name="L143" href="#L143">143</a>
+<a class="jxr_linenumber" name="L144" href="#L144">144</a>
extractItems(menu.getItems(), sink);
+<a class="jxr_linenumber" name="L145" href="#L145">145</a>
+<a class="jxr_linenumber" name="L146" href="#L146">146</a>
sink.section2_();
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
+<a class="jxr_linenumber" name="L148" href="#L148">148</a>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a>
sink.section1_();
+<a class="jxr_linenumber" name="L150" href="#L150">150</a>
sink.body_();
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
+<a class="jxr_linenumber" name="L152" href="#L152">152</a>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong>
extractItems(List<MenuItem> items, Sink sink) {
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong
class="jxr_keyword">if</strong> (items == <strong
class="jxr_keyword">null</strong> || items.isEmpty()) {
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong
class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
+<a class="jxr_linenumber" name="L157" href="#L157">157</a>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> sink.list();
+<a class="jxr_linenumber" name="L159" href="#L159">159</a>
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong
class="jxr_keyword">for</strong> (MenuItem item : items) {
+<a class="jxr_linenumber" name="L161" href="#L161">161</a>
sink.listItem();
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong
class="jxr_keyword">if</strong> (item.getHref() != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L163" href="#L163">163</a>
sink.link(relativePath(item.getHref()));
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
+<a class="jxr_linenumber" name="L165" href="#L165">165</a>
sink.text(item.getName());
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong
class="jxr_keyword">if</strong> (item.getHref() != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L167" href="#L167">167</a>
sink.link_();
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
+<a class="jxr_linenumber" name="L169" href="#L169">169</a>
+<a class="jxr_linenumber" name="L170" href="#L170">170</a>
extractItems(item.getItems(), sink);
+<a class="jxr_linenumber" name="L171" href="#L171">171</a>
sink.listItem_();
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
+<a class="jxr_linenumber" name="L173" href="#L173">173</a>
+<a class="jxr_linenumber" name="L174" href="#L174">174</a>
sink.list_();
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> }
+<a class="jxr_linenumber" name="L176" href="#L176">176</a>
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em
class="jxr_comment">// sitemap.html gets generated into top-level so we only
have to check leading slashes</em>
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> String relativePath(String href) {
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong
class="jxr_keyword">return</strong> href.startsWith(<span
class="jxr_string">"/"</span>) ? <span class="jxr_string">"."</span> + href :
href;
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> }
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2002–2023 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
