You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by mi...@apache.org on 2023/02/11 20:41:51 UTC
svn commit: r1907586 [25/34] - in /maven/website/components/plugins-archives/maven-site-plugin-LATEST: ./ apidocs/ apidocs/org/apache/maven/plugins/maven_site_plugin/ apidocs/org/apache/maven/plugins/maven_site_plugin/class-use/ apidocs/org/apache/mave...
Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/deploy/SiteStageMojo.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/deploy/SiteStageMojo.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/deploy/SiteStageMojo.html Sat Feb 11 20:41:49 2023
@@ -6,185 +6,164 @@
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/plugins/site/deploy/SiteStageMojo.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.deploy;
-<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.util.List;
-<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.model.Site;
-<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
-<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a>
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Deploys the generated site to a local staging or mock directory based on the site URL</em>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * specified in the <code>&lt;distributionManagement&gt;</code> section of the</em>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * POM.</em>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <p>It can be used to test that links between module sites in a multi-module</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * build work.</em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * </p></em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * <p>This goal requires the site to already have been generated using the site goal,</em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * such as by calling <code>mvn site</code>.</p></em>
-<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"> * @author <a href="<a href="mailto:vincent.siveton@gmail.com" target="alexandria_uri">mailto:vincent.siveton@gmail.com</a>">Vincent Siveton</a></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"> * @since 2.0</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> @Mojo( name = <span class="jxr_string">"stage"</span>, requiresDependencyResolution = ResolutionScope.TEST )
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="SiteStageMojo" href="../../../../../../org/apache/maven/plugins/site/deploy/SiteStageMojo.html#SiteStageMojo">SiteStageMojo</a>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractStagingMojo" href="../../../../../../org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html#AbstractStagingMojo">AbstractStagingMojo</a>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> {
-<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> <em class="jxr_javadoccomment"> * Staging directory location. This needs to be an absolute path, like</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * <code>C:\stagingArea\myProject\</code> on Windows or</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <code>/stagingArea/myProject/</code> on Unix.</em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * If this is not specified, the site will be staged in ${project.build.directory}/staging.</em>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> @Parameter( property = <span class="jxr_string">"stagingDirectory"</span> )
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> File stagingDirectory;
-<a class="jxr_linenumber" name="L60" href="#L60">60</a>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Override
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> {
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">if</strong> ( skip )
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> {
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> getLog().info( <span class="jxr_string">"maven.site.skip = true: Skipping site staging"</span> );
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">return</strong>;
-<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> <strong class="jxr_keyword">super</strong>.execute();
-<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> @Override
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isDeploy()
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> {
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> false;
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
-<a class="jxr_linenumber" name="L79" href="#L79">79</a>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> @Override
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">protected</strong> Site determineDeploySite()
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> {
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> Site staging = <strong class="jxr_keyword">new</strong> Site();
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> staging.setId( <span class="jxr_string">"stagingLocal"</span> );
-<a class="jxr_linenumber" name="L86" href="#L86">86</a>
-<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">final</strong> File outputDirectory = determineStagingDirectory();
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> getLog().info( <span class="jxr_string">"Using this base directory for staging: "</span> + outputDirectory );
-<a class="jxr_linenumber" name="L89" href="#L89">89</a>
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_comment">// Safety</em>
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">if</strong> ( !outputDirectory.exists() )
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> {
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> outputDirectory.mkdirs();
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
-<a class="jxr_linenumber" name="L95" href="#L95">95</a>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> staging.setUrl( <span class="jxr_string">"file://"</span> + outputDirectory.getAbsolutePath() );
-<a class="jxr_linenumber" name="L97" href="#L97">97</a>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">return</strong> staging;
-<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"> * Find the directory where staging will take place.</em>
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @return the directory for staging</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> <strong class="jxr_keyword">private</strong> File determineStagingDirectory()
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> {
-<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> ( stagingDirectory != <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> {
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_comment">// the user has specified a stagingDirectory - use it</em>
-<a class="jxr_linenumber" name="L111" href="#L111">111</a> getLog().debug( <span class="jxr_string">"stagingDirectory specified by the user: "</span> + stagingDirectory );
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> stagingDirectory;
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
-<a class="jxr_linenumber" name="L114" href="#L114">114</a>
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_comment">// The user didn't specify a URL: calculate default in the execution root target dir</em>
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> File defaultStagingDirectory = <strong class="jxr_keyword">new</strong> File( getExecutionRootBuildDirectory(), DEFAULT_STAGING_DIRECTORY );
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> getLog().debug( <span class="jxr_string">"stagingDirectory NOT specified, using the execution root project: "</span>
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> + defaultStagingDirectory );
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">return</strong> defaultStagingDirectory;
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
+<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.deploy;
+<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.util.List;
+<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.model.Site;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a>
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * Deploys the generated site to a local staging or mock directory based on the site URL</em>
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * specified in the <code>&lt;distributionManagement&gt;</code> section of the</em>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * POM.</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <p>It can be used to test that links between module sites in a multi-module</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * build work.</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <p>This goal requires the site to already have been generated using the site goal,</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * such as by calling <code>mvn site</code>.</p></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"> * @author <a href="<a href="mailto:vincent.siveton@gmail.com" target="alexandria_uri">mailto:vincent.siveton@gmail.com</a>">Vincent Siveton</a></em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @since 2.0</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> @Mojo(name = <span class="jxr_string">"stage"</span>, requiresDependencyResolution = ResolutionScope.TEST)
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="SiteStageMojo" href="../../../../../../org/apache/maven/plugins/site/deploy/SiteStageMojo.html#SiteStageMojo">SiteStageMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractStagingMojo" href="../../../../../../org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html#AbstractStagingMojo">AbstractStagingMojo</a> {
+<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"> * Staging directory location. This needs to be an absolute path, like</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <code>C:\stagingArea\myProject\</code> on Windows or</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <code>/stagingArea/myProject/</code> on Unix.</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * If this is not specified, the site will be staged in ${project.build.directory}/staging.</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @since 2.3</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> @Parameter(property = <span class="jxr_string">"stagingDirectory"</span>)
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> File stagingDirectory;
+<a class="jxr_linenumber" name="L57" href="#L57">57</a>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> @Override
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException {
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">if</strong> (skip) {
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> getLog().info(<span class="jxr_string">"maven.site.skip = true: Skipping site staging"</span>);
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">return</strong>;
+<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> <strong class="jxr_keyword">super</strong>.execute();
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> }
+<a class="jxr_linenumber" name="L67" href="#L67">67</a>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> @Override
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isDeploy() {
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> }
+<a class="jxr_linenumber" name="L72" href="#L72">72</a>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> @Override
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">protected</strong> Site determineDeploySite() <strong class="jxr_keyword">throws</strong> MojoExecutionException {
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> Site staging = <strong class="jxr_keyword">new</strong> Site();
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> staging.setId(<span class="jxr_string">"stagingLocal"</span>);
+<a class="jxr_linenumber" name="L77" href="#L77">77</a>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">final</strong> File outputDirectory = determineStagingDirectory();
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> getLog().info(<span class="jxr_string">"Using this base directory for staging: "</span> + outputDirectory);
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">// Safety</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">if</strong> (!outputDirectory.exists()) {
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> outputDirectory.mkdirs();
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> staging.setUrl(<span class="jxr_string">"file://"</span> + outputDirectory.getAbsolutePath());
+<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> staging;
+<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"> * Find the directory where staging will take place.</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"> * @return the directory for staging</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">private</strong> File determineStagingDirectory() {
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">if</strong> (stagingDirectory != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_comment">// the user has specified a stagingDirectory - use it</em>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> getLog().debug(<span class="jxr_string">"stagingDirectory specified by the user: "</span> + stagingDirectory);
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> stagingDirectory;
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
+<a class="jxr_linenumber" name="L102" href="#L102">102</a>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_comment">// The user didn't specify a URL: calculate default in the execution root target dir</em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> File defaultStagingDirectory = <strong class="jxr_keyword">new</strong> File(getExecutionRootBuildDirectory(), DEFAULT_STAGING_DIRECTORY);
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> getLog().debug(<span class="jxr_string">"stagingDirectory NOT specified, using the execution root project: "</span> + defaultStagingDirectory);
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">return</strong> defaultStagingDirectory;
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
+<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"> * Find the build directory of the execution root project in the reactor.</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * If no execution root project is found, the build directory of the current project is returned.</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> <em class="jxr_javadoccomment"> * @return the build directory of the execution root project.</em>
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">protected</strong> File getExecutionRootBuildDirectory() {
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_comment">// Find the top level project in the reactor</em>
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">final</strong> MavenProject executionRootProject = getExecutionRootProject(reactorProjects);
+<a class="jxr_linenumber" name="L118" href="#L118">118</a>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment">// Use the top level project's build directory if there is one, otherwise use this project's build directory</em>
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">final</strong> File buildDirectory;
<a class="jxr_linenumber" name="L121" href="#L121">121</a>
-<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"> * Find the build directory of the execution root project in the reactor.</em>
-<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * If no execution root project is found, the build directory of the current project is returned.</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> <em class="jxr_javadoccomment"> * @return the build directory of the execution root project.</em>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">protected</strong> File getExecutionRootBuildDirectory()
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> {
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_comment">// Find the top level project in the reactor</em>
-<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">final</strong> MavenProject executionRootProject = getExecutionRootProject( reactorProjects );
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">if</strong> (executionRootProject == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> getLog().debug(<span class="jxr_string">"No execution root project found in the reactor, using the current project."</span>);
+<a class="jxr_linenumber" name="L124" href="#L124">124</a>
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> buildDirectory = <strong class="jxr_keyword">new</strong> File(project.getBuild().getDirectory());
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> } <strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> getLog().debug(<span class="jxr_string">"Using the execution root project found in the reactor: "</span>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> + executionRootProject.getArtifactId());
+<a class="jxr_linenumber" name="L129" href="#L129">129</a>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> buildDirectory = <strong class="jxr_keyword">new</strong> File(executionRootProject.getBuild().getDirectory());
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> }
<a class="jxr_linenumber" name="L132" href="#L132">132</a>
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_comment">// Use the top level project's build directory if there is one, otherwise use this project's build directory</em>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">final</strong> File buildDirectory;
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">return</strong> buildDirectory;
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> }
<a class="jxr_linenumber" name="L135" href="#L135">135</a>
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">if</strong> ( executionRootProject == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> {
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> getLog().debug( <span class="jxr_string">"No execution root project found in the reactor, using the current project."</span> );
-<a class="jxr_linenumber" name="L139" href="#L139">139</a>
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> buildDirectory = <strong class="jxr_keyword">new</strong> File( project.getBuild().getDirectory() );
-<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">else</strong>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> {
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> getLog().debug( <span class="jxr_string">"Using the execution root project found in the reactor: "</span>
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> + executionRootProject.getArtifactId() );
-<a class="jxr_linenumber" name="L146" href="#L146">146</a>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> buildDirectory = <strong class="jxr_keyword">new</strong> File( executionRootProject.getBuild().getDirectory() );
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> }
-<a class="jxr_linenumber" name="L149" href="#L149">149</a>
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">return</strong> buildDirectory;
-<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> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Find the execution root in the reactor.</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"> * @param reactorProjects The projects in the reactor. May be <code>null</code> in which case <code>null</code> is</em>
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * returned.</em>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @return The execution root project in the reactor, or <code>null</code> if none can be found</em>
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> MavenProject getExecutionRootProject( List<MavenProject> reactorProjects )
-<a class="jxr_linenumber" name="L161" href="#L161">161</a> {
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">if</strong> ( reactorProjects == <strong class="jxr_keyword">null</strong> )
-<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> <strong class="jxr_keyword">null</strong>;
-<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> <em class="jxr_comment">// todo Lambda Java 1.8</em>
-<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">for</strong> ( MavenProject reactorProject : reactorProjects )
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> {
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">if</strong> ( reactorProject.isExecutionRoot() )
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> {
-<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">return</strong> reactorProject;
-<a class="jxr_linenumber" name="L173" href="#L173">173</a> }
-<a class="jxr_linenumber" name="L174" href="#L174">174</a> }
-<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">return</strong> <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> }
+<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"> * Find the execution root in the reactor.</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"> * @param reactorProjects The projects in the reactor. May be <code>null</code> in which case <code>null</code> is</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * returned.</em>
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @return The execution root project in the reactor, or <code>null</code> if none can be found</em>
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> MavenProject getExecutionRootProject(List<MavenProject> reactorProjects) {
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">if</strong> (reactorProjects == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> }
+<a class="jxr_linenumber" name="L147" href="#L147">147</a>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_comment">// todo Lambda Java 1.8</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">for</strong> (MavenProject reactorProject : reactorProjects) {
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">if</strong> (reactorProject.isExecutionRoot()) {
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">return</strong> reactorProject;
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> }
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
+<a class="jxr_linenumber" name="L156" href="#L156">156</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/deploy/package-frame.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/deploy/package-frame.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/deploy/package-frame.html Sat Feb 11 20:41:49 2023
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven Site Plugin 4.0.0-M4 Reference Package org.apache.maven.plugins.site.deploy</title>
+ <title>Apache Maven Site Plugin 4.0.0-M5 Reference Package org.apache.maven.plugins.site.deploy</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
@@ -12,28 +12,25 @@
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
- <li>
+ <li>
<a href="AbstractDeployMojo.html#AbstractDeployMojo" target="classFrame">AbstractDeployMojo</a>
</li>
- <li>
+ <li>
<a href="AbstractDeployMojo.html#AbstractDeployMojo.URIEncoder" target="classFrame">AbstractDeployMojo.URIEncoder</a>
</li>
- <li>
+ <li>
<a href="AbstractStagingMojo.html#AbstractStagingMojo" target="classFrame">AbstractStagingMojo</a>
</li>
- <li>
- <a href="HelpMojo.html#HelpMojo" target="classFrame">HelpMojo</a>
- </li>
- <li>
+ <li>
<a href="SiteDeployMojo.html#SiteDeployMojo" target="classFrame">SiteDeployMojo</a>
</li>
- <li>
+ <li>
<a href="SiteStageDeployMojo.html#SiteStageDeployMojo" target="classFrame">SiteStageDeployMojo</a>
</li>
- <li>
+ <li>
<a href="SiteStageMojo.html#SiteStageMojo" target="classFrame">SiteStageMojo</a>
</li>
- </ul>
+ </ul>
</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/deploy/package-summary.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/deploy/package-summary.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/deploy/package-summary.html Sat Feb 11 20:41:49 2023
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven Site Plugin 4.0.0-M4 Reference Package org.apache.maven.plugins.site.deploy</title>
+ <title>Apache Maven Site Plugin 4.0.0-M5 Reference Package org.apache.maven.plugins.site.deploy</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
@@ -23,7 +23,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven Site Plugin 4.0.0-M4 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven Site Plugin 4.0.0-M5 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -56,42 +56,37 @@
</tr>
</thead>
<tbody>
- <tr class="altColor">
+ <tr class="altColor">
<td class="colFirst colLast">
<a href="AbstractDeployMojo.html#AbstractDeployMojo" target="classFrame" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a>
</td>
</tr>
- <tr class="rowColor">
+ <tr class="rowColor">
<td class="colFirst colLast">
<a href="AbstractDeployMojo.html#AbstractDeployMojo.URIEncoder" target="classFrame" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo.URIEncoder</a>
</td>
</tr>
- <tr class="altColor">
+ <tr class="altColor">
<td class="colFirst colLast">
<a href="AbstractStagingMojo.html#AbstractStagingMojo" target="classFrame" title="class in org.apache.maven.plugins.site.deploy">AbstractStagingMojo</a>
</td>
</tr>
- <tr class="rowColor">
- <td class="colFirst colLast">
- <a href="HelpMojo.html#HelpMojo" target="classFrame" title="class in org.apache.maven.plugins.site.deploy">HelpMojo</a>
- </td>
- </tr>
- <tr class="altColor">
+ <tr class="rowColor">
<td class="colFirst colLast">
<a href="SiteDeployMojo.html#SiteDeployMojo" target="classFrame" title="class in org.apache.maven.plugins.site.deploy">SiteDeployMojo</a>
</td>
</tr>
- <tr class="rowColor">
+ <tr class="altColor">
<td class="colFirst colLast">
<a href="SiteStageDeployMojo.html#SiteStageDeployMojo" target="classFrame" title="class in org.apache.maven.plugins.site.deploy">SiteStageDeployMojo</a>
</td>
</tr>
- <tr class="altColor">
+ <tr class="rowColor">
<td class="colFirst colLast">
<a href="SiteStageMojo.html#SiteStageMojo" target="classFrame" title="class in org.apache.maven.plugins.site.deploy">SiteStageMojo</a>
</td>
</tr>
- </tbody>
+ </tbody>
</table>
</li>
</ul>
@@ -111,7 +106,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven Site Plugin 4.0.0-M4 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven Site Plugin 4.0.0-M5 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -131,7 +126,7 @@
</div>
<div id="footer">
- Copyright © 2002–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.
+ 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/descriptor/AbstractSiteDescriptorMojo.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html Sat Feb 11 20:41:49 2023
@@ -6,131 +6,118 @@
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.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.descriptor;
-<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.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.artifact.repository.ArtifactRepository;
-<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler;
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteToolException;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
-<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.site.AbstractSiteMojo;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a>
-<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"> * Abstract class to compute effective site decoration model for site descriptors.</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 3.5</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">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractSiteDescriptorMojo" href="../../../../../../org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html#AbstractSiteDescriptorMojo">AbstractSiteDescriptorMojo</a>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractSiteMojo" href="../../../../../../org/apache/maven/plugins/site/AbstractSiteMojo.html#AbstractSiteMojo">AbstractSiteMojo</a>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> {
-<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"> * The component for assembling site decoration model inheritance.</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> @Component
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> DecorationModelInheritanceAssembler assembler;
-<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"> * Remote repositories used for the project.</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"> * todo this is used for site descriptor resolution - it should relate to the actual project but for some reason</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * they are not always filled in</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> @Parameter( defaultValue = <span class="jxr_string">"${project.remoteArtifactRepositories}"</span>, readonly = <strong class="jxr_keyword">true</strong> )
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">protected</strong> List<ArtifactRepository> repositories;
-<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"> * Directory containing the <code>site.xml</code> file and the source for hand written docs (one directory</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * per Doxia-source-supported markup types):</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * see <a href="/doxia/references/index.html">Doxia Markup Languages References</a>).</em>
-<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"> * @since 2.3</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> @Parameter( defaultValue = <span class="jxr_string">"${basedir}/src/site"</span> )
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">protected</strong> File siteDirectory;
-<a class="jxr_linenumber" name="L67" href="#L67">67</a>
-<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"> * Make links in the site descriptor relative to the project URL.</em>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * By default, any absolute links that appear in the site descriptor,</em>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url.</em>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <p/></em>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Links will not be changed if this is set to false, or if the project has no URL defined.</em>
-<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"> * @since 2.3</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> @Parameter( property = <span class="jxr_string">"relativizeDecorationLinks"</span>, defaultValue = <span class="jxr_string">"true"</span> )
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> relativizeDecorationLinks;
-<a class="jxr_linenumber" name="L79" href="#L79">79</a>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">protected</strong> DecorationModel prepareDecorationModel( Locale locale )
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> {
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> DecorationModel decorationModel;
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">try</strong>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> {
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> decorationModel = siteTool.getDecorationModel( siteDirectory, locale, project, reactorProjects,
-<a class="jxr_linenumber" name="L87" href="#L87">87</a> localRepository, repositories );
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">catch</strong> ( SiteToolException e )
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> {
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"SiteToolException: "</span> + e.getMessage(), e );
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
+<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.descriptor;
+<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.util.List;
+<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
+<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.artifact.repository.ArtifactRepository;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteToolException;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<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.Parameter;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.site.AbstractSiteMojo;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Abstract class to compute effective site decoration model for site descriptors.</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @since 3.5</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractSiteDescriptorMojo" href="../../../../../../org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html#AbstractSiteDescriptorMojo">AbstractSiteDescriptorMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractSiteMojo" href="../../../../../../org/apache/maven/plugins/site/AbstractSiteMojo.html#AbstractSiteMojo">AbstractSiteMojo</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"> * The component for assembling site decoration model inheritance.</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> @Component
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> DecorationModelInheritanceAssembler assembler;
+<a class="jxr_linenumber" name="L45" href="#L45">45</a>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Remote repositories used for the project.</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * todo this is used for site descriptor resolution - it should relate to the actual project but for some reason</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * they are not always filled in</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> @Parameter(defaultValue = <span class="jxr_string">"${project.remoteArtifactRepositories}"</span>, readonly = <strong class="jxr_keyword">true</strong>)
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">protected</strong> List<ArtifactRepository> repositories;
+<a class="jxr_linenumber" name="L54" href="#L54">54</a>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Directory containing the <code>site.xml</code> file and the source for hand written docs (one directory</em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * per Doxia-source-supported markup types):</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * see <a href="/doxia/references/index.html">Doxia Markup Languages References</a>).</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}/src/site"</span>)
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">protected</strong> File siteDirectory;
+<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"> * Make links in the site descriptor relative to the project URL.</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * By default, any absolute links that appear in the site descriptor,</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url.</em>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Links will not be changed if this is set to false, or if the project has no URL defined.</em>
+<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"> * @since 2.3</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> @Parameter(property = <span class="jxr_string">"relativizeDecorationLinks"</span>, defaultValue = <span class="jxr_string">"true"</span>)
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> relativizeDecorationLinks;
+<a class="jxr_linenumber" name="L76" href="#L76">76</a>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">protected</strong> DecorationModel prepareDecorationModel(Locale locale) <strong class="jxr_keyword">throws</strong> MojoExecutionException {
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> DecorationModel decorationModel;
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> decorationModel = siteTool.getDecorationModel(
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> siteDirectory, locale, project, reactorProjects, localRepository, repositories);
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> } <strong class="jxr_keyword">catch</strong> (SiteToolException e) {
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"SiteToolException: "</span> + e.getMessage(), e);
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (relativizeDecorationLinks) {
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">final</strong> String url = project.getUrl();
+<a class="jxr_linenumber" name="L88" href="#L88">88</a>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">if</strong> (url == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> getLog().warn(<span class="jxr_string">"No project URL defined - decoration links will not be relativized!"</span>);
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> } <strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> List<Locale> localesList = getLocales();
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">if</strong> ( relativizeDecorationLinks )
-<a class="jxr_linenumber" name="L95" href="#L95">95</a> {
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">final</strong> String url = project.getUrl();
-<a class="jxr_linenumber" name="L97" href="#L97">97</a>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">if</strong> ( url == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> {
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> getLog().warn( <span class="jxr_string">"No project URL defined - decoration links will not be relativized!"</span> );
-<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">else</strong>
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> {
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> List<Locale> localesList = getLocales();
-<a class="jxr_linenumber" name="L105" href="#L105">105</a>
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_comment">// Default is first in the list</em>
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> Locale defaultLocale = localesList.get( 0 );
-<a class="jxr_linenumber" name="L108" href="#L108">108</a>
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_comment">// MSITE-658</em>
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">final</strong> String localeUrl = locale.equals( defaultLocale ) ? url : append( url, locale.toString() );
-<a class="jxr_linenumber" name="L111" href="#L111">111</a>
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> getLog().info( <span class="jxr_string">"Relativizing decoration links with respect to localized project URL: "</span> + localeUrl );
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> assembler.resolvePaths( decorationModel, localeUrl );
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">return</strong> decorationModel;
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
-<a class="jxr_linenumber" name="L118" href="#L118">118</a>
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">private</strong> String append( String url, String path )
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> {
-<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">return</strong> url.endsWith( <span class="jxr_string">"/"</span> ) ? ( url + path ) : ( url + '/' + path );
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_comment">// Default is first in the list</em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> Locale defaultLocale = localesList.get(0);
+<a class="jxr_linenumber" name="L96" href="#L96">96</a>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_comment">// MSITE-658</em>
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">final</strong> String localeUrl = locale.equals(defaultLocale) ? url : append(url, locale.toString());
+<a class="jxr_linenumber" name="L99" href="#L99">99</a>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> getLog().info(<span class="jxr_string">"Relativizing decoration links with respect to localized project URL: "</span> + localeUrl);
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> assembler.resolvePaths(decorationModel, localeUrl);
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">return</strong> decorationModel;
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
+<a class="jxr_linenumber" name="L106" href="#L106">106</a>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">private</strong> String append(String url, String path) {
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">return</strong> url.endsWith(<span class="jxr_string">"/"</span>) ? (url + path) : (url + '/' + path);
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
+<a class="jxr_linenumber" name="L110" href="#L110">110</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