Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/SiteJarMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/SiteJarMojo.html (original) +++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/SiteJarMojo.html Sat Feb 11 20:41:49 2023 @@ -6,74 +6,74 @@ </head> <body> <div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/plugins/site/render/SiteJarMojo.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> java.io.File; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.archiver.MavenArchiveConfiguration; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.archiver.MavenArchiver; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.DependencyResolutionRequiredException; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProjectHelper; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.Archiver; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.ArchiverException; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.jar.JarArchiver; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.jar.ManifestException; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Bundles the site output into a JAR so that it can be deployed to a repository.</em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Matthew Beermann</a></em> -<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"> * @since 2.0-beta-6</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_comment">// MSITE-665: requiresDependencyResolution workaround for MPLUGIN-253</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> @Mojo( name = <span class="jxr_string">"jar"</span>, defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.TEST, -<a class="jxr_linenumber" name="L50" href="#L50">50</a> requiresReports = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="SiteJarMojo" href="../../../../../../org/apache/maven/plugins/site/render/SiteJarMojo.html#SiteJarMojo">SiteJarMojo</a> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">extends</strong> <a name="SiteMojo" href="../../../../../../org/apache/maven/plugins/site/render/SiteMojo.html#SiteMojo">SiteMojo</a> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> { -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String[] DEFAULT_ARCHIVE_EXCLUDES = <strong class="jxr_keyword">new</strong> String[]{ }; +<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> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.archiver.MavenArchiveConfiguration; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.archiver.MavenArchiver; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.DependencyResolutionRequiredException; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProjectHelper; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.Archiver; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.ArchiverException; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.jar.JarArchiver; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.jar.ManifestException; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> +<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> <em class="jxr_javadoccomment"> * Bundles the site output into a JAR so that it can be deployed to a repository.</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> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Matthew Beermann</a></em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-6</em> +<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_comment">// MSITE-665: requiresDependencyResolution workaround for MPLUGIN-253</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> @Mojo( +<a class="jxr_linenumber" name="L49" href="#L49">49</a> name = <span class="jxr_string">"jar"</span>, +<a class="jxr_linenumber" name="L50" href="#L50">50</a> defaultPhase = LifecyclePhase.PACKAGE, +<a class="jxr_linenumber" name="L51" href="#L51">51</a> requiresDependencyResolution = ResolutionScope.TEST, +<a class="jxr_linenumber" name="L52" href="#L52">52</a> requiresReports = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="SiteJarMojo" href="../../../../../../org/apache/maven/plugins/site/render/SiteJarMojo.html#SiteJarMojo">SiteJarMojo</a> <strong class="jxr_keyword">extends</strong> <a name="SiteMojo" href="../../../../../../org/apache/maven/plugins/site/render/SiteMojo.html#SiteMojo">SiteMojo</a> { +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String[] DEFAULT_ARCHIVE_EXCLUDES = <strong class="jxr_keyword">new</strong> String[] {}; <a class="jxr_linenumber" name="L55" href="#L55">55</a> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String[] DEFAULT_ARCHIVE_INCLUDES = <strong class="jxr_keyword">new</strong> String[]{ <span class="jxr_string">"**/**"</span> }; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String[] DEFAULT_ARCHIVE_INCLUDES = <strong class="jxr_keyword">new</strong> String[] {<span class="jxr_string">"**/**"</span>}; <a class="jxr_linenumber" name="L57" href="#L57">57</a> <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"> * Specifies the directory where the generated jar file will be put.</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> @Parameter( property = <span class="jxr_string">"project.build.directory"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Parameter(property = <span class="jxr_string">"project.build.directory"</span>, required = <strong class="jxr_keyword">true</strong>) <a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> String jarOutputDirectory; <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"> * Specifies the filename that will be used for the generated jar file.</em> <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Please note that "-site" will be appended to the file name.</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> @Parameter( property = <span class="jxr_string">"project.build.finalName"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L68" href="#L68">68</a> @Parameter(property = <span class="jxr_string">"project.build.finalName"</span>, required = <strong class="jxr_keyword">true</strong>) <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">private</strong> String finalName; <a class="jxr_linenumber" name="L70" href="#L70">70</a> <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em> @@ -85,7 +85,7 @@ <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"> * Specifies whether to attach the generated artifact to the project.</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> @Parameter( property = <span class="jxr_string">"site.attach"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L80" href="#L80">80</a> @Parameter(property = <span class="jxr_string">"site.attach"</span>, defaultValue = <span class="jxr_string">"true"</span>) <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> attach; <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> @@ -93,7 +93,7 @@ <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"> * @since 3.1</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> @Component( role = Archiver.<strong class="jxr_keyword">class</strong>, hint = <span class="jxr_string">"jar"</span> ) +<a class="jxr_linenumber" name="L88" href="#L88">88</a> @Component(role = Archiver.<strong class="jxr_keyword">class</strong>, hint = <span class="jxr_string">"jar"</span>) <a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> JarArchiver jarArchiver; <a class="jxr_linenumber" name="L90" href="#L90">90</a> <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em> @@ -130,114 +130,95 @@ <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"> * @since 3.9.0</em> <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.outputTimestamp}"</span> ) +<a class="jxr_linenumber" name="L125" href="#L125">125</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.outputTimestamp}"</span>) <a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">private</strong> String outputTimestamp; <a class="jxr_linenumber" name="L127" href="#L127">127</a> <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em> <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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException -<a class="jxr_linenumber" name="L133" href="#L133">133</a> { -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">if</strong> ( skip ) -<a class="jxr_linenumber" name="L135" href="#L135">135</a> { -<a class="jxr_linenumber" name="L136" href="#L136">136</a> getLog().info( <span class="jxr_string">"maven.site.skip = true: Skipping jar generation"</span> ); -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L138" href="#L138">138</a> } -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">super</strong>.execute(); -<a class="jxr_linenumber" name="L141" href="#L141">141</a> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> { -<a class="jxr_linenumber" name="L144" href="#L144">144</a> File outputFile = createArchive( outputDirectory, -<a class="jxr_linenumber" name="L145" href="#L145">145</a> finalName + <span class="jxr_string">"-"</span> + getClassifier() + <span class="jxr_string">"."</span> + getArtifactType() ); -<a class="jxr_linenumber" name="L146" href="#L146">146</a> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">if</strong> ( attach ) -<a class="jxr_linenumber" name="L148" href="#L148">148</a> { -<a class="jxr_linenumber" name="L149" href="#L149">149</a> projectHelper.attachArtifact( project, getArtifactType(), getClassifier(), outputFile ); -<a class="jxr_linenumber" name="L150" href="#L150">150</a> } -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> { -<a class="jxr_linenumber" name="L153" href="#L153">153</a> getLog().info( <span class="jxr_string">"NOT adding site jar to the list of attached artifacts."</span> ); -<a class="jxr_linenumber" name="L154" href="#L154">154</a> } -<a class="jxr_linenumber" name="L155" href="#L155">155</a> } -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">catch</strong> ( ArchiverException | IOException | ManifestException | DependencyResolutionRequiredException e ) -<a class="jxr_linenumber" name="L157" href="#L157">157</a> { -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error while creating archive."</span>, e ); -<a class="jxr_linenumber" name="L159" href="#L159">159</a> } -<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> <strong class="jxr_keyword">protected</strong> String getArtifactType() -<a class="jxr_linenumber" name="L163" href="#L163">163</a> { -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"jar"</span>; -<a class="jxr_linenumber" name="L165" href="#L165">165</a> } -<a class="jxr_linenumber" name="L166" href="#L166">166</a> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">protected</strong> String getClassifier() -<a class="jxr_linenumber" name="L168" href="#L168">168</a> { -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"site"</span>; -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * Method that creates the jar file.</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"> * @param siteDirectory the directory where the site files are located</em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @param jarFilename the filename of the created jar file</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @return a File object that contains the created jar file</em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @throws ArchiverException</em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @throws IOException</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @throws ManifestException</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @throws DependencyResolutionRequiredException</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">private</strong> File createArchive( File siteDirectory, String jarFilename ) -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">throws</strong> ArchiverException, IOException, ManifestException, DependencyResolutionRequiredException -<a class="jxr_linenumber" name="L185" href="#L185">185</a> { -<a class="jxr_linenumber" name="L186" href="#L186">186</a> File siteJar = <strong class="jxr_keyword">new</strong> File( jarOutputDirectory, jarFilename ); -<a class="jxr_linenumber" name="L187" href="#L187">187</a> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> MavenArchiver archiver = <strong class="jxr_keyword">new</strong> MavenArchiver(); -<a class="jxr_linenumber" name="L189" href="#L189">189</a> archiver.setCreatedBy( <span class="jxr_string">"Maven Site Plugin"</span>, <span class="jxr_string">"org.apache.maven.plugins"</span>, <span class="jxr_string">"maven-site-plugin"</span> ); -<a class="jxr_linenumber" name="L190" href="#L190">190</a> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> archiver.setArchiver( <strong class="jxr_keyword">this</strong>.jarArchiver ); -<a class="jxr_linenumber" name="L192" href="#L192">192</a> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> archiver.setOutputFile( siteJar ); -<a class="jxr_linenumber" name="L194" href="#L194">194</a> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_comment">// configure for Reproducible Builds based on outputTimestamp value</em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> archiver.configureReproducible( outputTimestamp ); -<a class="jxr_linenumber" name="L197" href="#L197">197</a> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> ( !siteDirectory.isDirectory() ) -<a class="jxr_linenumber" name="L199" href="#L199">199</a> { -<a class="jxr_linenumber" name="L200" href="#L200">200</a> getLog().warn( <span class="jxr_string">"JAR will be empty - no content was marked for inclusion!"</span> ); -<a class="jxr_linenumber" name="L201" href="#L201">201</a> } -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> { -<a class="jxr_linenumber" name="L204" href="#L204">204</a> archiver.getArchiver().addDirectory( siteDirectory, getArchiveIncludes(), getArchiveExcludes() ); -<a class="jxr_linenumber" name="L205" href="#L205">205</a> } -<a class="jxr_linenumber" name="L206" href="#L206">206</a> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> archiver.createArchive( getSession(), getProject(), archive ); -<a class="jxr_linenumber" name="L208" href="#L208">208</a> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">return</strong> siteJar; +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">if</strong> (skip) { +<a class="jxr_linenumber" name="L133" href="#L133">133</a> getLog().info(<span class="jxr_string">"maven.site.skip = true: Skipping jar generation"</span>); +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> } +<a class="jxr_linenumber" name="L136" href="#L136">136</a> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">super</strong>.execute(); +<a class="jxr_linenumber" name="L138" href="#L138">138</a> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> File outputFile = +<a class="jxr_linenumber" name="L141" href="#L141">141</a> createArchive(outputDirectory, finalName + <span class="jxr_string">"-"</span> + getClassifier() + <span class="jxr_string">"."</span> + getArtifactType()); +<a class="jxr_linenumber" name="L142" href="#L142">142</a> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (attach) { +<a class="jxr_linenumber" name="L144" href="#L144">144</a> projectHelper.attachArtifact(project, getArtifactType(), getClassifier(), outputFile); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L146" href="#L146">146</a> getLog().info(<span class="jxr_string">"NOT adding site jar to the list of attached artifacts."</span>); +<a class="jxr_linenumber" name="L147" href="#L147">147</a> } +<a class="jxr_linenumber" name="L148" href="#L148">148</a> } <strong class="jxr_keyword">catch</strong> (ArchiverException | IOException | ManifestException | DependencyResolutionRequiredException e) { +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Error while creating archive."</span>, e); +<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> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">protected</strong> String getArtifactType() { +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"jar"</span>; +<a class="jxr_linenumber" name="L155" href="#L155">155</a> } +<a class="jxr_linenumber" name="L156" href="#L156">156</a> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">protected</strong> String getClassifier() { +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"site"</span>; +<a class="jxr_linenumber" name="L159" href="#L159">159</a> } +<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"> * Method that creates the jar file.</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"> * @param siteDirectory the directory where the site files are located</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @param jarFilename the filename of the created jar file</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @return a File object that contains the created jar file</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @throws ArchiverException</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @throws IOException</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @throws ManifestException</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @throws DependencyResolutionRequiredException</em> +<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> <strong class="jxr_keyword">private</strong> File createArchive(File siteDirectory, String jarFilename) +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">throws</strong> ArchiverException, IOException, ManifestException, DependencyResolutionRequiredException { +<a class="jxr_linenumber" name="L174" href="#L174">174</a> File siteJar = <strong class="jxr_keyword">new</strong> File(jarOutputDirectory, jarFilename); +<a class="jxr_linenumber" name="L175" href="#L175">175</a> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> MavenArchiver archiver = <strong class="jxr_keyword">new</strong> MavenArchiver(); +<a class="jxr_linenumber" name="L177" href="#L177">177</a> archiver.setCreatedBy(<span class="jxr_string">"Maven Site Plugin"</span>, <span class="jxr_string">"org.apache.maven.plugins"</span>, <span class="jxr_string">"maven-site-plugin"</span>); +<a class="jxr_linenumber" name="L178" href="#L178">178</a> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> archiver.setArchiver(<strong class="jxr_keyword">this</strong>.jarArchiver); +<a class="jxr_linenumber" name="L180" href="#L180">180</a> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> archiver.setOutputFile(siteJar); +<a class="jxr_linenumber" name="L182" href="#L182">182</a> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_comment">// configure for Reproducible Builds based on outputTimestamp value</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> archiver.configureReproducibleBuild(outputTimestamp); +<a class="jxr_linenumber" name="L185" href="#L185">185</a> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">if</strong> (!siteDirectory.isDirectory()) { +<a class="jxr_linenumber" name="L187" href="#L187">187</a> getLog().warn(<span class="jxr_string">"JAR will be empty - no content was marked for inclusion!"</span>); +<a class="jxr_linenumber" name="L188" href="#L188">188</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L189" href="#L189">189</a> archiver.getArchiver().addDirectory(siteDirectory, getArchiveIncludes(), getArchiveExcludes()); +<a class="jxr_linenumber" name="L190" href="#L190">190</a> } +<a class="jxr_linenumber" name="L191" href="#L191">191</a> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> archiver.createArchive(getSession(), getProject(), archive); +<a class="jxr_linenumber" name="L193" href="#L193">193</a> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">return</strong> siteJar; +<a class="jxr_linenumber" name="L195" href="#L195">195</a> } +<a class="jxr_linenumber" name="L196" href="#L196">196</a> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">private</strong> String[] getArchiveIncludes() { +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.archiveIncludes != <strong class="jxr_keyword">null</strong> && <strong class="jxr_keyword">this</strong>.archiveIncludes.length > 0) { +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.archiveIncludes; +<a class="jxr_linenumber" name="L200" href="#L200">200</a> } +<a class="jxr_linenumber" name="L201" href="#L201">201</a> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">return</strong> DEFAULT_ARCHIVE_INCLUDES; +<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> <strong class="jxr_keyword">private</strong> String[] getArchiveExcludes() { +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.archiveExcludes != <strong class="jxr_keyword">null</strong> && <strong class="jxr_keyword">this</strong>.archiveExcludes.length > 0) { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.archiveExcludes; +<a class="jxr_linenumber" name="L208" href="#L208">208</a> } +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">return</strong> DEFAULT_ARCHIVE_EXCLUDES; <a class="jxr_linenumber" name="L210" href="#L210">210</a> } -<a class="jxr_linenumber" name="L211" href="#L211">211</a> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">private</strong> String[] getArchiveIncludes() -<a class="jxr_linenumber" name="L213" href="#L213">213</a> { -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">this</strong>.archiveIncludes != <strong class="jxr_keyword">null</strong> && <strong class="jxr_keyword">this</strong>.archiveIncludes.length > 0 ) -<a class="jxr_linenumber" name="L215" href="#L215">215</a> { -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.archiveIncludes; -<a class="jxr_linenumber" name="L217" href="#L217">217</a> } -<a class="jxr_linenumber" name="L218" href="#L218">218</a> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">return</strong> DEFAULT_ARCHIVE_INCLUDES; -<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">private</strong> String[] getArchiveExcludes() -<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> ( <strong class="jxr_keyword">this</strong>.archiveExcludes != <strong class="jxr_keyword">null</strong> && <strong class="jxr_keyword">this</strong>.archiveExcludes.length > 0 ) -<a class="jxr_linenumber" name="L225" href="#L225">225</a> { -<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.archiveExcludes; -<a class="jxr_linenumber" name="L227" href="#L227">227</a> } -<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">return</strong> DEFAULT_ARCHIVE_EXCLUDES; -<a class="jxr_linenumber" name="L229" href="#L229">229</a> } -<a class="jxr_linenumber" name="L230" href="#L230">230</a> } +<a class="jxr_linenumber" name="L211" href="#L211">211</a> } </pre> <hr/> -<div id="footer">Copyright © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> </body> </html> \ No newline at end of file
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 Feb 11 20:41:49 2023 @@ -6,202 +6,181 @@ </head> <body> <div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/plugins/site/render/SiteMap.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> java.io.File; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Locale; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.module.xdoc.XdocSinkFactory; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.Menu; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.MenuItem; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> -<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"> * Generate a sitemap.</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"> * @author ltheussl</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> <em class="jxr_javadoccomment"> * @since 2.1</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="SiteMap" href="../../../../../../org/apache/maven/plugins/site/render/SiteMap.html#SiteMap">SiteMap</a> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> { -<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 encoding; -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> I18N i18n; -<a class="jxr_linenumber" name="L48" href="#L48">48</a> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Constructor sets default values.</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> <em class="jxr_javadoccomment"> * @param encoding the default encoding to use when writing the output file.</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @param i18n the default I18N for translations.</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</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="L56" href="#L56">56</a> { -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">this</strong>.encoding = encoding; -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">this</strong>.i18n = i18n; -<a class="jxr_linenumber" name="L59" href="#L59">59</a> } -<a class="jxr_linenumber" name="L60" href="#L60">60</a> -<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> <em class="jxr_javadoccomment"> * Get the value of i18n.</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * @return the value of i18n.</em> -<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> <strong class="jxr_keyword">public</strong> I18N getI18n() -<a class="jxr_linenumber" name="L67" href="#L67">67</a> { -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">return</strong> i18n; -<a class="jxr_linenumber" name="L69" href="#L69">69</a> } -<a class="jxr_linenumber" name="L70" href="#L70">70</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"> * Set the value of i18n.</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @param i18n new value of i18n.</em> -<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setI18n( I18N i18n ) -<a class="jxr_linenumber" name="L77" href="#L77">77</a> { -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">this</strong>.i18n = i18n; -<a class="jxr_linenumber" name="L79" href="#L79">79</a> } -<a class="jxr_linenumber" name="L80" href="#L80">80</a> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * Get the encoding to use when writing the output file.</em> -<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"> * @return the value of encoding.</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> <strong class="jxr_keyword">public</strong> String getEncoding() -<a class="jxr_linenumber" name="L87" href="#L87">87</a> { -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">return</strong> encoding; -<a class="jxr_linenumber" name="L89" href="#L89">89</a> } -<a class="jxr_linenumber" name="L90" href="#L90">90</a> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Set the encoding to use when writing the output file.</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> <em class="jxr_javadoccomment"> * @param enc new value of encoding.</em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEncoding( String enc ) -<a class="jxr_linenumber" name="L97" href="#L97">97</a> { -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">this</strong>.encoding = enc; -<a class="jxr_linenumber" name="L99" href="#L99">99</a> } -<a class="jxr_linenumber" name="L100" href="#L100">100</a> -<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"> * Generates a sitemap.xml in targetDir/xdoc/.</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</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="L104" href="#L104">104</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="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @param model the DecorationModel to extract the menus from.</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</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="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param locale the Locale for the result.</em> -<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"> * @throws IOException if the file cannot be ceated.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( DecorationModel model, File targetDir, Locale locale ) -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">throws</strong> IOException -<a class="jxr_linenumber" name="L114" href="#L114">114</a> { -<a class="jxr_linenumber" name="L115" href="#L115">115</a> File outputDir = <strong class="jxr_keyword">new</strong> File( targetDir, <span class="jxr_string">"xdoc"</span> ); -<a class="jxr_linenumber" name="L116" href="#L116">116</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="L117" href="#L117">117</a> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> { -<a class="jxr_linenumber" name="L120" href="#L120">120</a> extract( model, sink, locale ); -<a class="jxr_linenumber" name="L121" href="#L121">121</a> } -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> { -<a class="jxr_linenumber" name="L124" href="#L124">124</a> sink.close(); -<a class="jxr_linenumber" name="L125" href="#L125">125</a> } -<a class="jxr_linenumber" name="L126" href="#L126">126</a> } -<a class="jxr_linenumber" name="L127" href="#L127">127</a> -<a class="jxr_linenumber" name="L128" href="#L128">128</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="L129" href="#L129">129</a> { -<a class="jxr_linenumber" name="L130" href="#L130">130</a> sink.head(); -<a class="jxr_linenumber" name="L131" href="#L131">131</a> sink.title(); -<a class="jxr_linenumber" name="L132" href="#L132">132</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="L133" href="#L133">133</a> sink.title_(); -<a class="jxr_linenumber" name="L134" href="#L134">134</a> sink.head_(); -<a class="jxr_linenumber" name="L135" href="#L135">135</a> sink.body(); -<a class="jxr_linenumber" name="L136" href="#L136">136</a> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> sink.section1(); -<a class="jxr_linenumber" name="L138" href="#L138">138</a> sink.sectionTitle1(); -<a class="jxr_linenumber" name="L139" href="#L139">139</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="L140" href="#L140">140</a> sink.sectionTitle1_(); -<a class="jxr_linenumber" name="L141" href="#L141">141</a> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> sink.paragraph(); -<a class="jxr_linenumber" name="L143" href="#L143">143</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="L144" href="#L144">144</a> sink.paragraph_(); -<a class="jxr_linenumber" name="L145" href="#L145">145</a> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">for</strong> ( Menu menu : decoration.getMenus() ) -<a class="jxr_linenumber" name="L147" href="#L147">147</a> { -<a class="jxr_linenumber" name="L148" href="#L148">148</a> sink.section3(); -<a class="jxr_linenumber" name="L149" href="#L149">149</a> sink.sectionTitle3(); -<a class="jxr_linenumber" name="L150" href="#L150">150</a> sink.text( menu.getName() ); -<a class="jxr_linenumber" name="L151" href="#L151">151</a> sink.sectionTitle3_(); -<a class="jxr_linenumber" name="L152" href="#L152">152</a> sink.horizontalRule(); +<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.List; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<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> extractItems( menu.getItems(), sink ); -<a class="jxr_linenumber" name="L155" href="#L155">155</a> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> sink.section3_(); -<a class="jxr_linenumber" name="L157" href="#L157">157</a> } -<a class="jxr_linenumber" name="L158" href="#L158">158</a> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> sink.section1_(); -<a class="jxr_linenumber" name="L160" href="#L160">160</a> sink.body_(); -<a class="jxr_linenumber" name="L161" href="#L161">161</a> } -<a class="jxr_linenumber" name="L162" href="#L162">162</a> -<a class="jxr_linenumber" name="L163" href="#L163">163</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="L164" href="#L164">164</a> { -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> ( items == <strong class="jxr_keyword">null</strong> || items.isEmpty() ) -<a class="jxr_linenumber" name="L166" href="#L166">166</a> { -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong>; -<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> sink.list(); -<a class="jxr_linenumber" name="L171" href="#L171">171</a> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">for</strong> ( MenuItem item : items ) -<a class="jxr_linenumber" name="L173" href="#L173">173</a> { -<a class="jxr_linenumber" name="L174" href="#L174">174</a> sink.listItem(); -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">if</strong> ( item.getHref() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L176" href="#L176">176</a> { -<a class="jxr_linenumber" name="L177" href="#L177">177</a> sink.link( relativePath( item.getHref() ) ); -<a class="jxr_linenumber" name="L178" href="#L178">178</a> sink.text( item.getName() ); -<a class="jxr_linenumber" name="L179" href="#L179">179</a> sink.link_(); -<a class="jxr_linenumber" name="L180" href="#L180">180</a> } -<a class="jxr_linenumber" name="L181" href="#L181">181</a> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> extractItems( item.getItems(), sink ); -<a class="jxr_linenumber" name="L183" href="#L183">183</a> sink.listItem_(); -<a class="jxr_linenumber" name="L184" href="#L184">184</a> } -<a class="jxr_linenumber" name="L185" href="#L185">185</a> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> sink.list_(); -<a class="jxr_linenumber" name="L187" href="#L187">187</a> } -<a class="jxr_linenumber" name="L188" href="#L188">188</a> -<a class="jxr_linenumber" name="L189" href="#L189">189</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="L190" href="#L190">190</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String relativePath( String href ) -<a class="jxr_linenumber" name="L191" href="#L191">191</a> { -<a class="jxr_linenumber" name="L192" href="#L192">192</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="L193" href="#L193">193</a> } -<a class="jxr_linenumber" name="L194" href="#L194">194</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> } </pre> <hr/> -<div id="footer">Copyright © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> </body> </html> \ No newline at end of file
