Added: maven/website/components/plugins-archives/maven-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/IncrementalBuildHelper.html ============================================================================== --- maven/website/components/plugins-archives/maven-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/IncrementalBuildHelper.html (added) +++ maven/website/components/plugins-archives/maven-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/IncrementalBuildHelper.html Wed Jun 26 08:48:37 2024 @@ -0,0 +1,217 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>IncrementalBuildHelper xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/compiler/IncrementalBuildHelper.html">View Javadoc</a></div><pre> +<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"> * 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.plugin.compiler; +<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.IOException; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.nio.file.Path; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collections; +<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.Set; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.stream.Collectors; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.stream.Stream; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.api.plugin.MojoException; +<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"> * Various helper methods to support incremental builds</em> +<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="IncrementalBuildHelper" href="../../../../../org/apache/maven/plugin/compiler/IncrementalBuildHelper.html#IncrementalBuildHelper">IncrementalBuildHelper</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"> * the root directory to store status information about Maven executions in.</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">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String MAVEN_STATUS_ROOT = <span class="jxr_string">"maven-status"</span>; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CREATED_FILES_LST_FILENAME = <span class="jxr_string">"createdFiles.lst"</span>; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INPUT_FILES_LST_FILENAME = <span class="jxr_string">"inputFiles.lst"</span>; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> +<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"> * Needed for storing the status for the incremental build support.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String mojoStatusPath; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Set<Path> sources; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Path directory; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Path outputDirectory; +<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"> * Once the {@link #beforeRebuildExecution()} got</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * called, this will contain the list of files in the build directory.</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> <strong class="jxr_keyword">private</strong> List<Path> filesBeforeAction = Collections.emptyList(); +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">public</strong> <a name="IncrementalBuildHelper" href="../../../../../org/apache/maven/plugin/compiler/IncrementalBuildHelper.html#IncrementalBuildHelper">IncrementalBuildHelper</a>(String mojoStatusPath, Set<Path> sources, Path directory, Path outputDirectory) { +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">if</strong> (mojoStatusPath == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"MojoExecution must not be null!"</span>); +<a class="jxr_linenumber" name="L64" href="#L64">64</a> } +<a class="jxr_linenumber" name="L65" href="#L65">65</a> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">this</strong>.mojoStatusPath = mojoStatusPath; +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">this</strong>.sources = sources; +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">this</strong>.directory = directory; +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">this</strong>.outputDirectory = outputDirectory; +<a class="jxr_linenumber" name="L70" href="#L70">70</a> } +<a class="jxr_linenumber" name="L71" href="#L71">71</a> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * We use a specific status directory for each Mojo execution to store state</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * which is needed during the next build invocation run.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @return the directory for storing status information of the current Mojo execution.</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> <strong class="jxr_keyword">public</strong> Path getMojoStatusDirectory() <strong class="jxr_keyword">throws</strong> MojoException { +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_comment">// X TODO the executionId contains -cli and -mojoname</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_comment">// X we should remove those postfixes as it should not make</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_comment">// X any difference whether being run on the cli or via build</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> Path mojoStatusDir = directory.resolve(mojoStatusPath); +<a class="jxr_linenumber" name="L82" href="#L82">82</a> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L84" href="#L84">84</a> Files.createDirectories(mojoStatusDir); +<a class="jxr_linenumber" name="L85" href="#L85">85</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoException(<span class="jxr_string">"Unable to create directory: "</span> + mojoStatusDir, e); +<a class="jxr_linenumber" name="L87" href="#L87">87</a> } +<a class="jxr_linenumber" name="L88" href="#L88">88</a> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">return</strong> mojoStatusDir; +<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"> * Detect whether the list of detected files has changed since the last build.</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * We simply load the list of files for the previous build from a status file</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * and compare it with the new list. Afterwards we store the new list in the status file.</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"> * @return <code>true</code> if the set of inputFiles got changed since the last build.</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> inputFileTreeChanged(List<String> added, List<String> removed) { +<a class="jxr_linenumber" name="L100" href="#L100">100</a> Path mojoConfigBase = getMojoStatusDirectory(); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> Path mojoConfigFile = mojoConfigBase.resolve(INPUT_FILES_LST_FILENAME); +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> List<String> oldInputFiles = Collections.emptyList(); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">if</strong> (Files.exists(mojoConfigFile)) { +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L107" href="#L107">107</a> oldInputFiles = Files.readAllLines(mojoConfigFile); +<a class="jxr_linenumber" name="L108" href="#L108">108</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoException(<span class="jxr_string">"Error reading old mojo status "</span> + mojoConfigFile, e); +<a class="jxr_linenumber" name="L110" href="#L110">110</a> } +<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> List<String> newFiles = +<a class="jxr_linenumber" name="L114" href="#L114">114</a> sources.stream().map(Path::toAbsolutePath).map(Path::toString).collect(Collectors.toList()); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> List<String> previousFiles = oldInputFiles; +<a class="jxr_linenumber" name="L117" href="#L117">117</a> newFiles.stream().filter(s -> !previousFiles.contains(s)).forEach(added::add); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> previousFiles.stream().filter(s -> !newFiles.contains(s)).forEach(removed::add); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L120" href="#L120">120</a> Files.write(mojoConfigFile, added); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoException(<span class="jxr_string">"Error while storing the mojo status"</span>, e); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> } +<a class="jxr_linenumber" name="L124" href="#L124">124</a> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">return</strong> added.size() + removed.size() > 0; +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * This method shall get invoked before the actual Mojo task gets triggered, e.g. the actual compile in</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * maven-compiler-plugin.</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * <b>Attention:</b> This method shall only get invoked if the plugin re-creates <b>all</b> the output.</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * It first picks up the list of files created in the previous build and delete them. This step is necessary to</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * prevent left-overs. After that we take a 'directory snapshot' (list of all files which exist in the</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * outputDirectory after the clean).</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * After the actual Mojo task got executed you should invoke the method</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * {@link #afterRebuildExecution()} to collect the</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * list of files which got changed by this task.</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> beforeRebuildExecution() { +<a class="jxr_linenumber" name="L148" href="#L148">148</a> Path mojoConfigBase = getMojoStatusDirectory(); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> Path mojoConfigFile = mojoConfigBase.resolve(CREATED_FILES_LST_FILENAME); +<a class="jxr_linenumber" name="L150" href="#L150">150</a> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (Files.exists(mojoConfigFile)) { +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">for</strong> (String oldFileName : Files.readAllLines(mojoConfigFile)) { +<a class="jxr_linenumber" name="L154" href="#L154">154</a> Path oldFile = outputDirectory.resolve(oldFileName); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> Files.deleteIfExists(oldFile); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> } +<a class="jxr_linenumber" name="L157" href="#L157">157</a> } +<a class="jxr_linenumber" name="L158" href="#L158">158</a> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_comment">// we remember all files which currently exist in the output directory</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">if</strong> (Files.exists(outputDirectory)) { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">try</strong> (Stream<Path> walk = Files.walk(outputDirectory)) { +<a class="jxr_linenumber" name="L162" href="#L162">162</a> filesBeforeAction = walk.filter(Files::isRegularFile).collect(Collectors.toList()); +<a class="jxr_linenumber" name="L163" href="#L163">163</a> } +<a class="jxr_linenumber" name="L164" href="#L164">164</a> } +<a class="jxr_linenumber" name="L165" href="#L165">165</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoException(<span class="jxr_string">"Error reading old mojo status"</span>, e); +<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> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * <p>This method collects and stores all information about files changed since the</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * call to {@link #beforeRebuildExecution()}.</p></em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * <p><b>Attention:</b> This method shall only get invoked if the plugin re-creates <b>all</b> the output.</p></em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> afterRebuildExecution() { +<a class="jxr_linenumber" name="L177" href="#L177">177</a> Path mojoConfigBase = getMojoStatusDirectory(); +<a class="jxr_linenumber" name="L178" href="#L178">178</a> Path mojoConfigFile = mojoConfigBase.resolve(CREATED_FILES_LST_FILENAME); +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">try</strong> (Stream<Path> walk = Files.walk(outputDirectory)) { +<a class="jxr_linenumber" name="L182" href="#L182">182</a> List<String> added = walk.filter(Files::isRegularFile) +<a class="jxr_linenumber" name="L183" href="#L183">183</a> .filter(p -> !filesBeforeAction.contains(p)) +<a class="jxr_linenumber" name="L184" href="#L184">184</a> .map(Path::toString) +<a class="jxr_linenumber" name="L185" href="#L185">185</a> .collect(Collectors.toList()); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> Files.write(mojoConfigFile, added); +<a class="jxr_linenumber" name="L188" href="#L188">188</a> } +<a class="jxr_linenumber" name="L189" href="#L189">189</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoException(<span class="jxr_string">"Error while storing the mojo status"</span>, e); +<a class="jxr_linenumber" name="L191" href="#L191">191</a> } +<a class="jxr_linenumber" name="L192" href="#L192">192</a> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_comment">// in case of clean compile the file is not created so next compile won't see it</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_comment">// we mus create it here</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> mojoConfigFile = mojoConfigBase.resolve(INPUT_FILES_LST_FILENAME); +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">if</strong> (!Files.exists(mojoConfigFile)) { +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L198" href="#L198">198</a> Files.write(mojoConfigFile, sources.stream().map(Path::toString).collect(Collectors.toList())); +<a class="jxr_linenumber" name="L199" href="#L199">199</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoException(<span class="jxr_string">"Error while storing the mojo status"</span>, e); +<a class="jxr_linenumber" name="L201" href="#L201">201</a> } +<a class="jxr_linenumber" name="L202" href="#L202">202</a> } +<a class="jxr_linenumber" name="L203" href="#L203">203</a> } +<a class="jxr_linenumber" name="L204" href="#L204">204</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2001–2024 <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-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/ModuleInfoTransformer.html ============================================================================== --- maven/website/components/plugins-archives/maven-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/ModuleInfoTransformer.html (original) +++ maven/website/components/plugins-archives/maven-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/ModuleInfoTransformer.html Wed Jun 26 08:48:37 2024 @@ -31,7 +31,7 @@ <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.Set; <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.plugin.logging.Log; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.api.plugin.Log; <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.objectweb.asm.ClassReader; <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.objectweb.asm.ClassVisitor; <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.objectweb.asm.ClassWriter; Added: maven/website/components/plugins-archives/maven-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/Providers.html ============================================================================== --- maven/website/components/plugins-archives/maven-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/Providers.html (added) +++ maven/website/components/plugins-archives/maven-compiler-plugin-LATEST/xref/org/apache/maven/plugin/compiler/Providers.html Wed Jun 26 08:48:37 2024 @@ -0,0 +1,91 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>Providers xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/compiler/Providers.html">View Javadoc</a></div><pre> +<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"> * 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.plugin.compiler; +<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.lang.reflect.Field; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<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.api.Session; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.api.di.Named; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.api.di.Provides; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.api.services.*; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.compiler.Compiler; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.compiler.javac.JavacCompiler; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.compiler.javac.JavaxToolsCompiler; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.compiler.manager.CompilerManager; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.compiler.manager.NoSuchCompilerException; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> @Named +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">class</strong> <a name="Providers" href="../../../../../org/apache/maven/plugin/compiler/Providers.html#Providers">Providers</a> { +<a class="jxr_linenumber" name="L36" href="#L36">36</a> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> @Provides +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">static</strong> ToolchainManager toolchainManager(Session session) { +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">return</strong> session.getService(ToolchainManager.<strong class="jxr_keyword">class</strong>); +<a class="jxr_linenumber" name="L40" href="#L40">40</a> } +<a class="jxr_linenumber" name="L41" href="#L41">41</a> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> @Provides +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">static</strong> ArtifactManager artifactManager(Session session) { +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">return</strong> session.getService(ArtifactManager.<strong class="jxr_keyword">class</strong>); +<a class="jxr_linenumber" name="L45" href="#L45">45</a> } +<a class="jxr_linenumber" name="L46" href="#L46">46</a> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> @Provides +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">static</strong> ProjectManager projectManager(Session session) { +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">return</strong> session.getService(ProjectManager.<strong class="jxr_keyword">class</strong>); +<a class="jxr_linenumber" name="L50" href="#L50">50</a> } +<a class="jxr_linenumber" name="L51" href="#L51">51</a> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> @Provides +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">static</strong> MessageBuilderFactory messageBuilderFactory(Session session) { +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">return</strong> session.getService(MessageBuilderFactory.<strong class="jxr_keyword">class</strong>); +<a class="jxr_linenumber" name="L55" href="#L55">55</a> } +<a class="jxr_linenumber" name="L56" href="#L56">56</a> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> @Provides +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">static</strong> CompilerManager compilerManager(Map<String, Compiler> compilers) { +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">return</strong> compilerId -> { +<a class="jxr_linenumber" name="L60" href="#L60">60</a> Compiler compiler = compilers.get(compilerId); +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (compiler == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NoSuchCompilerException(compilerId); +<a class="jxr_linenumber" name="L63" href="#L63">63</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">return</strong> compiler; +<a class="jxr_linenumber" name="L65" href="#L65">65</a> } +<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> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> @Provides +<a class="jxr_linenumber" name="L70" href="#L70">70</a> @Named(<span class="jxr_string">"javac"</span>) +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">static</strong> Compiler javacCompiler() <strong class="jxr_keyword">throws</strong> Exception { +<a class="jxr_linenumber" name="L72" href="#L72">72</a> JavacCompiler compiler = <strong class="jxr_keyword">new</strong> JavacCompiler(); +<a class="jxr_linenumber" name="L73" href="#L73">73</a> Field ipc = JavacCompiler.<strong class="jxr_keyword">class</strong>.getDeclaredField(<span class="jxr_string">"inProcessCompiler"</span>); +<a class="jxr_linenumber" name="L74" href="#L74">74</a> ipc.setAccessible(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L75" href="#L75">75</a> ipc.set(compiler, <strong class="jxr_keyword">new</strong> JavaxToolsCompiler()); +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">return</strong> compiler; +<a class="jxr_linenumber" name="L77" href="#L77">77</a> } +<a class="jxr_linenumber" name="L78" href="#L78">78</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2001–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
