Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html (original) +++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html Sat Feb 11 20:41:49 2023 @@ -6,184 +6,184 @@ </head> <body> <div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html">View Javadoc</a></div><pre> -<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.site.render; -<a class="jxr_linenumber" name="L2" href="#L2">2</a> -<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em> -<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="L21" href="#L21">21</a> -<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.Menu; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.MenuItem; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.DocumentRenderer; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RendererException; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RenderingContext; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.SiteRenderingContext; -<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.apache.maven.doxia.tools.SiteToolException; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Reporting; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.PluginDescriptor; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo; -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport; -<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.apache.maven.reporting.exec.MavenReportExecutor; -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.exec.MavenReportExecutorRequest; -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a class="jxr_linenumber" name="L48" href="#L48">48</a> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> java.io.File; -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> java.util.Collection; -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashMap; -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> java.util.Locale; -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> java.util.Map; -<a class="jxr_linenumber" name="L59" href="#L59">59</a> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.maven.shared.utils.logging.MessageUtils.buffer; +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.site.render; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Date; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashMap; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.archiver.MavenArchiver; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.Menu; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.MenuItem; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.DocumentRenderer; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RendererException; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RenderingContext; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.SiteRenderingContext; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteToolException; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Reporting; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.PluginDescriptor; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.exec.MavenReportExecution; +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.exec.MavenReportExecutor; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.exec.MavenReportExecutorRequest; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; <a class="jxr_linenumber" name="L61" href="#L61">61</a> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Base class for site rendering mojos.</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</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="L62" href="#L62">62</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.maven.shared.utils.logging.MessageUtils.buffer; +<a class="jxr_linenumber" name="L63" href="#L63">63</a> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Base class for site rendering mojos.</em> <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"> */</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractSiteRenderingMojo" href="../../../../../../org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#AbstractSiteRenderingMojo">AbstractSiteRenderingMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractSiteDescriptorMojo" href="../../../../../../org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html#AbstractSiteDescriptorMojo">AbstractSiteDescriptorMojo</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> { -<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> <em class="jxr_javadoccomment"> * Module type exclusion mappings</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * ex: <code>fml -> **&#47;*-m1.fml</code> (excludes fml files ending in '-m1.fml' recursively)</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * The configuration looks like this:</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * &lt;moduleExcludes&gt;</em> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * &lt;moduleType&gt;filename1.ext,**&#47;*sample.ext&lt;/moduleType&gt;</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * &lt;!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. --&gt;</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * &lt;!-- The value is a comma separated list of --&gt;</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * &lt;!-- filenames or fileset patterns. --&gt;</em> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * &lt;!-- Here's an example: --&gt;</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * &lt;xdoc&gt;changes.xml,navigation.xml&lt;/xdoc&gt;</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * &lt;/moduleExcludes&gt;</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * </pre></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> @Parameter -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">private</strong> Map<String, String> moduleExcludes; -<a class="jxr_linenumber" name="L88" href="#L88">88</a> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Additional template properties for rendering the site. See</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * <a href="/doxia/doxia-sitetools/doxia-site-renderer/">Doxia Site Renderer</a>.</em> -<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> @Parameter -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">private</strong> Map<String, Object> attributes; -<a class="jxr_linenumber" name="L95" href="#L95">95</a> -<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"> * Site renderer.</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> @Component -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">protected</strong> Renderer siteRenderer; -<a class="jxr_linenumber" name="L101" href="#L101">101</a> -<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> <em class="jxr_javadoccomment"> * Reports (Maven 2).</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> @Parameter( defaultValue = <span class="jxr_string">"${reports}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">protected</strong> List<MavenReport> reports; -<a class="jxr_linenumber" name="L107" href="#L107">107</a> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * Alternative directory for xdoc source, useful for m1 to m2 migration</em> -<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"> * @deprecated use the standard m2 directory layout</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> @Parameter( defaultValue = <span class="jxr_string">"${basedir}/xdocs"</span> ) -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">private</strong> File xdocDirectory; -<a class="jxr_linenumber" name="L115" href="#L115">115</a> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Directory containing generated documentation in source format (Doxia supported markup).</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * This is used to pick up other source docs that might have been generated at build time (by reports or any other</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * build time mean).</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * This directory is expected to have the same structure as <code>siteDirectory</code></em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * (ie. one directory per Doxia-source-supported markup types).</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * intermediate step?</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> @Parameter( alias = <span class="jxr_string">"workingDirectory"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/generated-site"</span> ) -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">protected</strong> File generatedSiteDirectory; -<a class="jxr_linenumber" name="L128" href="#L128">128</a> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * The current Maven session.</em> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> @Parameter( defaultValue = <span class="jxr_string">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">protected</strong> MavenSession mavenSession; -<a class="jxr_linenumber" name="L134" href="#L134">134</a> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * replaces previous reportPlugins parameter, that was injected by Maven core from</em> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * reporting section: but this new configuration format has been abandoned.</em> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @since 3.7.1</em> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> @Parameter( defaultValue = <span class="jxr_string">"${project.reporting}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">private</strong> Reporting reporting; -<a class="jxr_linenumber" name="L143" href="#L143">143</a> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * Whether to generate the summary page for project reports: project-info.html.</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @since 2.3</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> @Parameter( property = <span class="jxr_string">"generateProjectInfo"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> generateProjectInfo; -<a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @since 2.3</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">private</strong> String inputEncoding; -<a class="jxr_linenumber" name="L159" href="#L159">159</a> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @since 2.3</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> @Parameter( property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span> ) -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">private</strong> String outputEncoding; -<a class="jxr_linenumber" name="L167" href="#L167">167</a> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> @Component -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">protected</strong> MavenReportExecutor mavenReportExecutor; -<a class="jxr_linenumber" name="L170" href="#L170">170</a> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * Gets the input files encoding.</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @return The input files encoding, never <code>null</code>.</em> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">protected</strong> String getInputEncoding() -<a class="jxr_linenumber" name="L177" href="#L177">177</a> { -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">return</strong> ( StringUtils.isEmpty( inputEncoding ) ) ? ReaderFactory.FILE_ENCODING : inputEncoding; +<a class="jxr_linenumber" name="L67" href="#L67">67</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="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> *</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">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractSiteRenderingMojo" href="../../../../../../org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#AbstractSiteRenderingMojo">AbstractSiteRenderingMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractSiteDescriptorMojo" href="../../../../../../org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html#AbstractSiteDescriptorMojo">AbstractSiteDescriptorMojo</a> { +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * Module type exclusion mappings</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * ex: <code>fml -> **&#47;*-m1.fml</code> (excludes fml files ending in '-m1.fml' recursively)</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * The configuration looks like this:</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * &lt;moduleExcludes&gt;</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * &lt;moduleType&gt;filename1.ext,**&#47;*sample.ext&lt;/moduleType&gt;</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * &lt;!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. --&gt;</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * &lt;!-- The value is a comma separated list of --&gt;</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * &lt;!-- filenames or fileset patterns. --&gt;</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * &lt;!-- Here's an example: --&gt;</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * &lt;xdoc&gt;changes.xml,navigation.xml&lt;/xdoc&gt;</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * &lt;/moduleExcludes&gt;</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * </pre></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> @Parameter +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> Map<String, String> moduleExcludes; +<a class="jxr_linenumber" name="L89" href="#L89">89</a> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Additional template properties for rendering the site. See</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * <a href="/doxia/doxia-sitetools/doxia-site-renderer/">Doxia Site Renderer</a>.</em> +<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> @Parameter +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">private</strong> Map<String, Object> attributes; +<a class="jxr_linenumber" name="L96" href="#L96">96</a> +<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"> * Site renderer.</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> @Component +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">protected</strong> Renderer siteRenderer; +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<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> <em class="jxr_javadoccomment"> * Reports (Maven 2).</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> @Parameter(defaultValue = <span class="jxr_string">"${reports}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">protected</strong> List<MavenReport> reports; +<a class="jxr_linenumber" name="L108" href="#L108">108</a> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * Alternative directory for xdoc source, useful for m1 to m2 migration</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @deprecated use the standard m2 directory layout</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}/xdocs"</span>) +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">private</strong> File xdocDirectory; +<a class="jxr_linenumber" name="L116" href="#L116">116</a> +<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> <em class="jxr_javadoccomment"> * Directory containing generated documentation in source format (Doxia supported markup).</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * This is used to pick up other source docs that might have been generated at build time (by reports or any other</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * build time mean).</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * This directory is expected to have the same structure as <code>siteDirectory</code></em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * (ie. one directory per Doxia-source-supported markup types).</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * intermediate step?</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> @Parameter(alias = <span class="jxr_string">"workingDirectory"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/generated-site"</span>) +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">protected</strong> File generatedSiteDirectory; +<a class="jxr_linenumber" name="L129" href="#L129">129</a> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * The current Maven session.</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> @Parameter(defaultValue = <span class="jxr_string">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">protected</strong> MavenSession mavenSession; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * replaces previous reportPlugins parameter, that was injected by Maven core from</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * reporting section: but this new configuration format has been abandoned.</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @since 3.7.1</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> @Parameter(defaultValue = <span class="jxr_string">"${project.reporting}"</span>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">private</strong> Reporting reporting; +<a class="jxr_linenumber" name="L144" href="#L144">144</a> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * Whether to generate the summary page for project reports: project-info.html.</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @since 2.3</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Parameter(property = <span class="jxr_string">"generateProjectInfo"</span>, defaultValue = <span class="jxr_string">"true"</span>) +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> generateProjectInfo; +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @since 2.3</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> @Parameter(property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span>) +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">private</strong> String inputEncoding; +<a class="jxr_linenumber" name="L160" href="#L160">160</a> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @since 2.3</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> @Parameter(property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span>) +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">private</strong> String outputEncoding; +<a class="jxr_linenumber" name="L168" href="#L168">168</a> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Component +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">protected</strong> MavenReportExecutor mavenReportExecutor; +<a class="jxr_linenumber" name="L171" href="#L171">171</a> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * Gets the input files encoding.</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @return The input files encoding, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">protected</strong> String getInputEncoding() { +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">return</strong> (StringUtils.isEmpty(inputEncoding)) ? ReaderFactory.FILE_ENCODING : inputEncoding; <a class="jxr_linenumber" name="L179" href="#L179">179</a> } <a class="jxr_linenumber" name="L180" href="#L180">180</a> <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment">/**</em> @@ -191,364 +191,324 @@ <a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> *</em> <a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em> <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding() -<a class="jxr_linenumber" name="L187" href="#L187">187</a> { -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">return</strong> ( outputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.UTF_8 : outputEncoding; -<a class="jxr_linenumber" name="L189" href="#L189">189</a> } -<a class="jxr_linenumber" name="L190" href="#L190">190</a> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * Whether to save Velocity processed Doxia content (<code>*.&lt;ext&gt;.vm</code>)</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * to <code>${generatedSiteDirectory}/processed</code>.</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * @since 3.5</em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> @Parameter -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> saveProcessedContent; -<a class="jxr_linenumber" name="L199" href="#L199">199</a> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkInputEncoding() -<a class="jxr_linenumber" name="L201" href="#L201">201</a> { -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( inputEncoding ) ) -<a class="jxr_linenumber" name="L203" href="#L203">203</a> { -<a class="jxr_linenumber" name="L204" href="#L204">204</a> getLog().warn( <span class="jxr_string">"Input file encoding has not been set, using platform encoding "</span> -<a class="jxr_linenumber" name="L205" href="#L205">205</a> + ReaderFactory.FILE_ENCODING + <span class="jxr_string">", i.e. build is platform dependent!"</span> ); -<a class="jxr_linenumber" name="L206" href="#L206">206</a> } -<a class="jxr_linenumber" name="L207" href="#L207">207</a> } -<a class="jxr_linenumber" name="L208" href="#L208">208</a> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">protected</strong> List<MavenReportExecution> getReports() -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException -<a class="jxr_linenumber" name="L211" href="#L211">211</a> { -<a class="jxr_linenumber" name="L212" href="#L212">212</a> MavenReportExecutorRequest mavenReportExecutorRequest = <strong class="jxr_keyword">new</strong> MavenReportExecutorRequest(); -<a class="jxr_linenumber" name="L213" href="#L213">213</a> mavenReportExecutorRequest.setLocalRepository( localRepository ); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> mavenReportExecutorRequest.setMavenSession( mavenSession ); -<a class="jxr_linenumber" name="L215" href="#L215">215</a> mavenReportExecutorRequest.setProject( project ); -<a class="jxr_linenumber" name="L216" href="#L216">216</a> mavenReportExecutorRequest.setReportPlugins( getReportingPlugins() ); -<a class="jxr_linenumber" name="L217" href="#L217">217</a> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> List<MavenReportExecution> allReports = mavenReportExecutor.buildMavenReports( mavenReportExecutorRequest ); -<a class="jxr_linenumber" name="L219" href="#L219">219</a> -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_comment">// filter out reports that can't be generated</em> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> List<MavenReportExecution> reportExecutions = <strong class="jxr_keyword">new</strong> ArrayList<>( allReports.size() ); -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">for</strong> ( MavenReportExecution exec : allReports ) -<a class="jxr_linenumber" name="L223" href="#L223">223</a> { -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">if</strong> ( exec.canGenerateReport() ) -<a class="jxr_linenumber" name="L225" href="#L225">225</a> { -<a class="jxr_linenumber" name="L226" href="#L226">226</a> reportExecutions.add( exec ); -<a class="jxr_linenumber" name="L227" href="#L227">227</a> } -<a class="jxr_linenumber" name="L228" href="#L228">228</a> } -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">return</strong> reportExecutions; -<a class="jxr_linenumber" name="L230" href="#L230">230</a> } -<a class="jxr_linenumber" name="L231" href="#L231">231</a> -<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * Get the report plugins from reporting section, adding if necessary (i.e. not excluded)</em> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * default reports (i.e. maven-project-info-reports)</em> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * @return the effective list of reports</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @since 3.7.1</em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">private</strong> ReportPlugin[] getReportingPlugins() -<a class="jxr_linenumber" name="L240" href="#L240">240</a> { -<a class="jxr_linenumber" name="L241" href="#L241">241</a> List<ReportPlugin> reportingPlugins = reporting.getPlugins(); -<a class="jxr_linenumber" name="L242" href="#L242">242</a> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_comment">// MSITE-806: add default report plugin like done in maven-model-builder DefaultReportingConverter</em> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">boolean</strong> hasMavenProjectInfoReportsPlugin = false; -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">for</strong> ( ReportPlugin plugin : reportingPlugins ) -<a class="jxr_linenumber" name="L246" href="#L246">246</a> { -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"org.apache.maven.plugins"</span>.equals( plugin.getGroupId() ) -<a class="jxr_linenumber" name="L248" href="#L248">248</a> && <span class="jxr_string">"maven-project-info-reports-plugin"</span>.equals( plugin.getArtifactId() ) ) -<a class="jxr_linenumber" name="L249" href="#L249">249</a> { -<a class="jxr_linenumber" name="L250" href="#L250">250</a> hasMavenProjectInfoReportsPlugin = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L252" href="#L252">252</a> } -<a class="jxr_linenumber" name="L253" href="#L253">253</a> } -<a class="jxr_linenumber" name="L254" href="#L254">254</a> -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> ( !reporting.isExcludeDefaults() && !hasMavenProjectInfoReportsPlugin ) -<a class="jxr_linenumber" name="L256" href="#L256">256</a> { -<a class="jxr_linenumber" name="L257" href="#L257">257</a> ReportPlugin mpir = <strong class="jxr_keyword">new</strong> ReportPlugin(); -<a class="jxr_linenumber" name="L258" href="#L258">258</a> mpir.setArtifactId( <span class="jxr_string">"maven-project-info-reports-plugin"</span> ); -<a class="jxr_linenumber" name="L259" href="#L259">259</a> reportingPlugins.add( mpir ); -<a class="jxr_linenumber" name="L260" href="#L260">260</a> } -<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">return</strong> reportingPlugins.toArray( <strong class="jxr_keyword">new</strong> ReportPlugin[reportingPlugins.size()] ); -<a class="jxr_linenumber" name="L262" href="#L262">262</a> } +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding() { +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">return</strong> (outputEncoding == <strong class="jxr_keyword">null</strong>) ? ReaderFactory.UTF_8 : outputEncoding; +<a class="jxr_linenumber" name="L188" href="#L188">188</a> } +<a class="jxr_linenumber" name="L189" href="#L189">189</a> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * Whether to save Velocity processed Doxia content (<code>*.&lt;ext&gt;.vm</code>)</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * to <code>${generatedSiteDirectory}/processed</code>.</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * @since 3.5</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> @Parameter +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> saveProcessedContent; +<a class="jxr_linenumber" name="L198" href="#L198">198</a> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkInputEncoding() { +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(inputEncoding)) { +<a class="jxr_linenumber" name="L201" href="#L201">201</a> getLog().warn(<span class="jxr_string">"Input file encoding has not been set, using platform encoding "</span> + ReaderFactory.FILE_ENCODING +<a class="jxr_linenumber" name="L202" href="#L202">202</a> + <span class="jxr_string">", i.e. build is platform dependent!"</span>); +<a class="jxr_linenumber" name="L203" href="#L203">203</a> } +<a class="jxr_linenumber" name="L204" href="#L204">204</a> } +<a class="jxr_linenumber" name="L205" href="#L205">205</a> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">protected</strong> List<MavenReportExecution> getReports() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> MavenReportExecutorRequest mavenReportExecutorRequest = <strong class="jxr_keyword">new</strong> MavenReportExecutorRequest(); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> mavenReportExecutorRequest.setLocalRepository(localRepository); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> mavenReportExecutorRequest.setMavenSession(mavenSession); +<a class="jxr_linenumber" name="L210" href="#L210">210</a> mavenReportExecutorRequest.setProject(project); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> mavenReportExecutorRequest.setReportPlugins(getReportingPlugins()); +<a class="jxr_linenumber" name="L212" href="#L212">212</a> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> List<MavenReportExecution> allReports = mavenReportExecutor.buildMavenReports(mavenReportExecutorRequest); +<a class="jxr_linenumber" name="L214" href="#L214">214</a> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_comment">// filter out reports that can't be generated</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> List<MavenReportExecution> reportExecutions = <strong class="jxr_keyword">new</strong> ArrayList<>(allReports.size()); +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">for</strong> (MavenReportExecution exec : allReports) { +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (exec.canGenerateReport()) { +<a class="jxr_linenumber" name="L219" href="#L219">219</a> reportExecutions.add(exec); +<a class="jxr_linenumber" name="L220" href="#L220">220</a> } +<a class="jxr_linenumber" name="L221" href="#L221">221</a> } +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">return</strong> reportExecutions; +<a class="jxr_linenumber" name="L223" href="#L223">223</a> } +<a class="jxr_linenumber" name="L224" href="#L224">224</a> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * Get the report plugins from reporting section, adding if necessary (i.e. not excluded)</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * default reports (i.e. maven-project-info-reports)</em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * @return the effective list of reports</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * @since 3.7.1</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">private</strong> ReportPlugin[] getReportingPlugins() { +<a class="jxr_linenumber" name="L233" href="#L233">233</a> List<ReportPlugin> reportingPlugins = reporting.getPlugins(); +<a class="jxr_linenumber" name="L234" href="#L234">234</a> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_comment">// MSITE-806: add default report plugin like done in maven-model-builder DefaultReportingConverter</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">boolean</strong> hasMavenProjectInfoReportsPlugin = false; +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">for</strong> (ReportPlugin plugin : reportingPlugins) { +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"org.apache.maven.plugins"</span>.equals(plugin.getGroupId()) +<a class="jxr_linenumber" name="L239" href="#L239">239</a> && <span class="jxr_string">"maven-project-info-reports-plugin"</span>.equals(plugin.getArtifactId())) { +<a class="jxr_linenumber" name="L240" href="#L240">240</a> hasMavenProjectInfoReportsPlugin = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L242" href="#L242">242</a> } +<a class="jxr_linenumber" name="L243" href="#L243">243</a> } +<a class="jxr_linenumber" name="L244" href="#L244">244</a> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">if</strong> (!reporting.isExcludeDefaults() && !hasMavenProjectInfoReportsPlugin) { +<a class="jxr_linenumber" name="L246" href="#L246">246</a> ReportPlugin mpir = <strong class="jxr_keyword">new</strong> ReportPlugin(); +<a class="jxr_linenumber" name="L247" href="#L247">247</a> mpir.setArtifactId(<span class="jxr_string">"maven-project-info-reports-plugin"</span>); +<a class="jxr_linenumber" name="L248" href="#L248">248</a> reportingPlugins.add(mpir); +<a class="jxr_linenumber" name="L249" href="#L249">249</a> } +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">return</strong> reportingPlugins.toArray(<strong class="jxr_keyword">new</strong> ReportPlugin[reportingPlugins.size()]); +<a class="jxr_linenumber" name="L251" href="#L251">251</a> } +<a class="jxr_linenumber" name="L252" href="#L252">252</a> +<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">protected</strong> SiteRenderingContext createSiteRenderingContext(Locale locale) +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, IOException, MojoFailureException { +<a class="jxr_linenumber" name="L255" href="#L255">255</a> DecorationModel decorationModel = prepareDecorationModel(locale); +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">if</strong> (attributes == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L257" href="#L257">257</a> attributes = <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L258" href="#L258">258</a> } +<a class="jxr_linenumber" name="L259" href="#L259">259</a> +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"project"</span>) == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L261" href="#L261">261</a> attributes.put(<span class="jxr_string">"project"</span>, project); +<a class="jxr_linenumber" name="L262" href="#L262">262</a> } <a class="jxr_linenumber" name="L263" href="#L263">263</a> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">protected</strong> SiteRenderingContext createSiteRenderingContext( Locale locale ) -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, IOException, MojoFailureException -<a class="jxr_linenumber" name="L266" href="#L266">266</a> { -<a class="jxr_linenumber" name="L267" href="#L267">267</a> DecorationModel decorationModel = prepareDecorationModel( locale ); -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">if</strong> ( attributes == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L269" href="#L269">269</a> { -<a class="jxr_linenumber" name="L270" href="#L270">270</a> attributes = <strong class="jxr_keyword">new</strong> HashMap<>(); -<a class="jxr_linenumber" name="L271" href="#L271">271</a> } -<a class="jxr_linenumber" name="L272" href="#L272">272</a> -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">if</strong> ( attributes.get( <span class="jxr_string">"project"</span> ) == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L274" href="#L274">274</a> { -<a class="jxr_linenumber" name="L275" href="#L275">275</a> attributes.put( <span class="jxr_string">"project"</span>, project ); -<a class="jxr_linenumber" name="L276" href="#L276">276</a> } -<a class="jxr_linenumber" name="L277" href="#L277">277</a> -<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">if</strong> ( attributes.get( <span class="jxr_string">"inputEncoding"</span> ) == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L279" href="#L279">279</a> { -<a class="jxr_linenumber" name="L280" href="#L280">280</a> attributes.put( <span class="jxr_string">"inputEncoding"</span>, getInputEncoding() ); -<a class="jxr_linenumber" name="L281" href="#L281">281</a> } -<a class="jxr_linenumber" name="L282" href="#L282">282</a> -<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">if</strong> ( attributes.get( <span class="jxr_string">"outputEncoding"</span> ) == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L284" href="#L284">284</a> { -<a class="jxr_linenumber" name="L285" href="#L285">285</a> attributes.put( <span class="jxr_string">"outputEncoding"</span>, getOutputEncoding() ); -<a class="jxr_linenumber" name="L286" href="#L286">286</a> } -<a class="jxr_linenumber" name="L287" href="#L287">287</a> -<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_comment">// Put any of the properties in directly into the Velocity context</em> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">for</strong> ( Map.Entry<Object, Object> entry : project.getProperties().entrySet() ) -<a class="jxr_linenumber" name="L290" href="#L290">290</a> { -<a class="jxr_linenumber" name="L291" href="#L291">291</a> attributes.put( (String) entry.getKey(), entry.getValue() ); -<a class="jxr_linenumber" name="L292" href="#L292">292</a> } -<a class="jxr_linenumber" name="L293" href="#L293">293</a> -<a class="jxr_linenumber" name="L294" href="#L294">294</a> SiteRenderingContext context; -<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> { -<a class="jxr_linenumber" name="L297" href="#L297">297</a> Artifact skinArtifact = -<a class="jxr_linenumber" name="L298" href="#L298">298</a> siteTool.getSkinArtifactFromRepository( localRepository, repositories, decorationModel ); -<a class="jxr_linenumber" name="L299" href="#L299">299</a> -<a class="jxr_linenumber" name="L300" href="#L300">300</a> getLog().info( buffer().a( <span class="jxr_string">"Rendering content with "</span> ).strong( skinArtifact.getId() -<a class="jxr_linenumber" name="L301" href="#L301">301</a> + <span class="jxr_string">" skin"</span> ).a( '.' ).toString() ); +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"inputEncoding"</span>) == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L265" href="#L265">265</a> attributes.put(<span class="jxr_string">"inputEncoding"</span>, getInputEncoding()); +<a class="jxr_linenumber" name="L266" href="#L266">266</a> } +<a class="jxr_linenumber" name="L267" href="#L267">267</a> +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"outputEncoding"</span>) == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L269" href="#L269">269</a> attributes.put(<span class="jxr_string">"outputEncoding"</span>, getOutputEncoding()); +<a class="jxr_linenumber" name="L270" href="#L270">270</a> } +<a class="jxr_linenumber" name="L271" href="#L271">271</a> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_comment">// Put any of the properties in directly into the Velocity context</em> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">for</strong> (Map.Entry<Object, Object> entry : project.getProperties().entrySet()) { +<a class="jxr_linenumber" name="L274" href="#L274">274</a> attributes.put((String) entry.getKey(), entry.getValue()); +<a class="jxr_linenumber" name="L275" href="#L275">275</a> } +<a class="jxr_linenumber" name="L276" href="#L276">276</a> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> SiteRenderingContext context; +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L279" href="#L279">279</a> Artifact skinArtifact = +<a class="jxr_linenumber" name="L280" href="#L280">280</a> siteTool.getSkinArtifactFromRepository(localRepository, repositories, decorationModel); +<a class="jxr_linenumber" name="L281" href="#L281">281</a> +<a class="jxr_linenumber" name="L282" href="#L282">282</a> getLog().info(buffer().a(<span class="jxr_string">"Rendering content with "</span>) +<a class="jxr_linenumber" name="L283" href="#L283">283</a> .strong(skinArtifact.getId() + <span class="jxr_string">" skin"</span>) +<a class="jxr_linenumber" name="L284" href="#L284">284</a> .a('.') +<a class="jxr_linenumber" name="L285" href="#L285">285</a> .toString()); +<a class="jxr_linenumber" name="L286" href="#L286">286</a> +<a class="jxr_linenumber" name="L287" href="#L287">287</a> context = siteRenderer.createContextForSkin( +<a class="jxr_linenumber" name="L288" href="#L288">288</a> skinArtifact, attributes, decorationModel, project.getName(), locale); +<a class="jxr_linenumber" name="L289" href="#L289">289</a> } <strong class="jxr_keyword">catch</strong> (SiteToolException e) { +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"SiteToolException while preparing skin: "</span> + e.getMessage(), e); +<a class="jxr_linenumber" name="L291" href="#L291">291</a> } <strong class="jxr_keyword">catch</strong> (RendererException e) { +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <span class="jxr_string">"RendererException while preparing context for skin: "</span> + e.getMessage(), e); +<a class="jxr_linenumber" name="L294" href="#L294">294</a> } +<a class="jxr_linenumber" name="L295" href="#L295">295</a> +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_comment">// Add publish date</em> +<a class="jxr_linenumber" name="L297" href="#L297">297</a> MavenProject p = attributes.get(<span class="jxr_string">"project"</span>) != <strong class="jxr_keyword">null</strong> ? (MavenProject) attributes.get(<span class="jxr_string">"project"</span>) : project; +<a class="jxr_linenumber" name="L298" href="#L298">298</a> String outputTimestamp = p.getProperties().getProperty(<span class="jxr_string">"project.build.outputTimestamp"</span>); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> MavenArchiver.parseBuildOutputTimestamp(outputTimestamp).ifPresent(v -> { +<a class="jxr_linenumber" name="L300" href="#L300">300</a> context.setPublishDate(Date.from(v)); +<a class="jxr_linenumber" name="L301" href="#L301">301</a> }); <a class="jxr_linenumber" name="L302" href="#L302">302</a> -<a class="jxr_linenumber" name="L303" href="#L303">303</a> context = siteRenderer.createContextForSkin( skinArtifact, attributes, decorationModel, -<a class="jxr_linenumber" name="L304" href="#L304">304</a> project.getName(), locale ); -<a class="jxr_linenumber" name="L305" href="#L305">305</a> } -<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">catch</strong> ( SiteToolException e ) -<a class="jxr_linenumber" name="L307" href="#L307">307</a> { -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"SiteToolException while preparing skin: "</span> + e.getMessage(), e ); -<a class="jxr_linenumber" name="L309" href="#L309">309</a> } -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">catch</strong> ( RendererException e ) -<a class="jxr_linenumber" name="L311" href="#L311">311</a> { -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"RendererException while preparing context for skin: "</span> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> + e.getMessage(), e ); -<a class="jxr_linenumber" name="L314" href="#L314">314</a> } -<a class="jxr_linenumber" name="L315" href="#L315">315</a> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_comment">// Generate static site</em> -<a class="jxr_linenumber" name="L317" href="#L317">317</a> context.setRootDirectory( project.getBasedir() ); -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">if</strong> ( !locale.equals( SiteTool.DEFAULT_LOCALE ) ) -<a class="jxr_linenumber" name="L319" href="#L319">319</a> { -<a class="jxr_linenumber" name="L320" href="#L320">320</a> context.addSiteDirectory( <strong class="jxr_keyword">new</strong> File( siteDirectory, locale.toString() ) ); -<a class="jxr_linenumber" name="L321" href="#L321">321</a> context.addModuleDirectory( <strong class="jxr_keyword">new</strong> File( xdocDirectory, locale.toString() ), <span class="jxr_string">"xdoc"</span> ); -<a class="jxr_linenumber" name="L322" href="#L322">322</a> context.addModuleDirectory( <strong class="jxr_keyword">new</strong> File( xdocDirectory, locale.toString() ), <span class="jxr_string">"fml"</span> ); -<a class="jxr_linenumber" name="L323" href="#L323">323</a> } -<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L325" href="#L325">325</a> { -<a class="jxr_linenumber" name="L326" href="#L326">326</a> context.addSiteDirectory( siteDirectory ); -<a class="jxr_linenumber" name="L327" href="#L327">327</a> context.addModuleDirectory( xdocDirectory, <span class="jxr_string">"xdoc"</span> ); -<a class="jxr_linenumber" name="L328" href="#L328">328</a> context.addModuleDirectory( xdocDirectory, <span class="jxr_string">"fml"</span> ); -<a class="jxr_linenumber" name="L329" href="#L329">329</a> } -<a class="jxr_linenumber" name="L330" href="#L330">330</a> -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">if</strong> ( moduleExcludes != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L332" href="#L332">332</a> { -<a class="jxr_linenumber" name="L333" href="#L333">333</a> context.setModuleExcludes( moduleExcludes ); -<a class="jxr_linenumber" name="L334" href="#L334">334</a> } -<a class="jxr_linenumber" name="L335" href="#L335">335</a> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">if</strong> ( saveProcessedContent ) -<a class="jxr_linenumber" name="L337" href="#L337">337</a> { -<a class="jxr_linenumber" name="L338" href="#L338">338</a> context.setProcessedContentOutput( <strong class="jxr_keyword">new</strong> File( generatedSiteDirectory, <span class="jxr_string">"processed"</span> ) ); -<a class="jxr_linenumber" name="L339" href="#L339">339</a> } -<a class="jxr_linenumber" name="L340" href="#L340">340</a> -<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">return</strong> context; -<a class="jxr_linenumber" name="L342" href="#L342">342</a> } -<a class="jxr_linenumber" name="L343" href="#L343">343</a> -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * Go through the list of reports and process each one like this:</em> -<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * <li>Add the report to a map of reports keyed by filename having the report itself as value</em> -<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * <li>If the report is not yet in the map of documents, add it together with a suitable renderer</em> -<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * @param reports A List of MavenReports</em> -<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * @param documents A Map of documents, keyed by filename</em> -<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * @param locale the Locale the reports are processed for.</em> -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> * @return A map with all reports keyed by filename having the report itself as value.</em> -<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * The map will be used to populate a menu.</em> -<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">protected</strong> Map<String, MavenReport> locateReports( List<MavenReportExecution> reports, -<a class="jxr_linenumber" name="L358" href="#L358">358</a> Map<String, DocumentRenderer> documents, Locale locale ) -<a class="jxr_linenumber" name="L359" href="#L359">359</a> { -<a class="jxr_linenumber" name="L360" href="#L360">360</a> Map<String, MavenReport> reportsByOutputName = <strong class="jxr_keyword">new</strong> LinkedHashMap<>(); -<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">for</strong> ( MavenReportExecution mavenReportExecution : reports ) -<a class="jxr_linenumber" name="L362" href="#L362">362</a> { -<a class="jxr_linenumber" name="L363" href="#L363">363</a> MavenReport report = mavenReportExecution.getMavenReport(); -<a class="jxr_linenumber" name="L364" href="#L364">364</a> -<a class="jxr_linenumber" name="L365" href="#L365">365</a> String outputName = report.getOutputName() + <span class="jxr_string">".html"</span>; -<a class="jxr_linenumber" name="L366" href="#L366">366</a> -<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_comment">// Always add the report to the menu, see MSITE-150</em> -<a class="jxr_linenumber" name="L368" href="#L368">368</a> reportsByOutputName.put( report.getOutputName(), report ); -<a class="jxr_linenumber" name="L369" href="#L369">369</a> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">if</strong> ( documents.containsKey( outputName ) ) -<a class="jxr_linenumber" name="L371" href="#L371">371</a> { -<a class="jxr_linenumber" name="L372" href="#L372">372</a> String reportMojoInfo = -<a class="jxr_linenumber" name="L373" href="#L373">373</a> ( mavenReportExecution.getGoal() == <strong class="jxr_keyword">null</strong> ) ? <span class="jxr_string">""</span> : ( <span class="jxr_string">" ("</span> -<a class="jxr_linenumber" name="L374" href="#L374">374</a> + mavenReportExecution.getPlugin().getArtifactId() + ':' -<a class="jxr_linenumber" name="L375" href="#L375">375</a> + mavenReportExecution.getPlugin().getVersion() + ':' + mavenReportExecution.getGoal() + ')' ); +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_comment">// Generate static site</em> +<a class="jxr_linenumber" name="L304" href="#L304">304</a> context.setRootDirectory(project.getBasedir()); +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">if</strong> (!locale.equals(SiteTool.DEFAULT_LOCALE)) { +<a class="jxr_linenumber" name="L306" href="#L306">306</a> context.addSiteDirectory(<strong class="jxr_keyword">new</strong> File(siteDirectory, locale.toString())); +<a class="jxr_linenumber" name="L307" href="#L307">307</a> context.addModuleDirectory(<strong class="jxr_keyword">new</strong> File(xdocDirectory, locale.toString()), <span class="jxr_string">"xdoc"</span>); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> context.addModuleDirectory(<strong class="jxr_keyword">new</strong> File(xdocDirectory, locale.toString()), <span class="jxr_string">"fml"</span>); +<a class="jxr_linenumber" name="L309" href="#L309">309</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L310" href="#L310">310</a> context.addSiteDirectory(siteDirectory); +<a class="jxr_linenumber" name="L311" href="#L311">311</a> context.addModuleDirectory(xdocDirectory, <span class="jxr_string">"xdoc"</span>); +<a class="jxr_linenumber" name="L312" href="#L312">312</a> context.addModuleDirectory(xdocDirectory, <span class="jxr_string">"fml"</span>); +<a class="jxr_linenumber" name="L313" href="#L313">313</a> } +<a class="jxr_linenumber" name="L314" href="#L314">314</a> +<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">if</strong> (moduleExcludes != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L316" href="#L316">316</a> context.setModuleExcludes(moduleExcludes); +<a class="jxr_linenumber" name="L317" href="#L317">317</a> } +<a class="jxr_linenumber" name="L318" href="#L318">318</a> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">if</strong> (saveProcessedContent) { +<a class="jxr_linenumber" name="L320" href="#L320">320</a> context.setProcessedContentOutput(<strong class="jxr_keyword">new</strong> File(generatedSiteDirectory, <span class="jxr_string">"processed"</span>)); +<a class="jxr_linenumber" name="L321" href="#L321">321</a> } +<a class="jxr_linenumber" name="L322" href="#L322">322</a> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">return</strong> context; +<a class="jxr_linenumber" name="L324" href="#L324">324</a> } +<a class="jxr_linenumber" name="L325" href="#L325">325</a>
[... 347 lines stripped ...]
