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 sj...@apache.org on 2025/02/17 20:56:20 UTC

svn commit: r1923885 [32/37] - in /maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x: ./ apidocs/ apidocs/legal/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/ apidocs/org/apache/maven/plugin/ apidocs/org/apache/mav...

Propchange: maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/IncrementalBuild.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.html
==============================================================================
--- maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.html (added)
+++ maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.html Mon Feb 17 20:56:18 2025
@@ -0,0 +1,164 @@
+<!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>ModuleInfoOverwrite xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.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>  
+<a class="jxr_linenumber" name="L25" href="#L25">25</a>  <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.maven.plugin.compiler.SourceDirectory.CLASS_FILE_SUFFIX;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a>  <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.maven.plugin.compiler.SourceDirectory.JAVA_FILE_SUFFIX;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a>  <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.maven.plugin.compiler.SourceDirectory.MODULE_INFO;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a>  
+<a class="jxr_linenumber" name="L29" href="#L29">29</a>  <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L30" href="#L30">30</a>  <em class="jxr_javadoccomment"> * Helper class for the case where a {@code module-info.java} file defined in the tests</em>
+<a class="jxr_linenumber" name="L31" href="#L31">31</a>  <em class="jxr_javadoccomment"> * overwrites the file defined in the main classes. It should be a last-resort practice only,</em>
+<a class="jxr_linenumber" name="L32" href="#L32">32</a>  <em class="jxr_javadoccomment"> * when options such as {@code --add-reads} or {@code --add-exports} are not sufficient.</em>
+<a class="jxr_linenumber" name="L33" href="#L33">33</a>  <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;The code in this class is useful only when {@link AbstractCompilerMojo#SUPPORT_LEGACY} is true.</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a>  <em class="jxr_javadoccomment"> * This class can be fully deleted if a future version permanently set above-cited flag to false.&lt;/p&gt;</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>  <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="ModuleInfoOverwrite" href="../../../../../org/apache/maven/plugin/compiler/ModuleInfoOverwrite.html#ModuleInfoOverwrite">ModuleInfoOverwrite</a> <strong class="jxr_keyword">implements</strong> Runnable {
+<a class="jxr_linenumber" name="L38" href="#L38">38</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a>  <em class="jxr_javadoccomment">     * Path to the original {@code module-info.java} file. It will need to be temporarily renamed</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a>  <em class="jxr_javadoccomment">     * because otherwise the Java compiler seems to unconditionally compiles it, even if we do not</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a>  <em class="jxr_javadoccomment">     * specify this file in the list of sources to compile.</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Path testSourceFile;
+<a class="jxr_linenumber" name="L44" href="#L44">44</a>  
+<a class="jxr_linenumber" name="L45" href="#L45">45</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a>  <em class="jxr_javadoccomment">     * Path to the {@code module-info.java.bak} file.</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Path savedSourceFile;
+<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">     * Path to the main {@code module-info.class} file to temporarily hide.</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a>  <em class="jxr_javadoccomment">     * This file will be temporarily renamed to {@link #moduleInfoBackup}</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a>  <em class="jxr_javadoccomment">     * before to compile the tests.</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Path moduleInfoToHide;
+<a class="jxr_linenumber" name="L56" href="#L56">56</a>  
+<a class="jxr_linenumber" name="L57" href="#L57">57</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a>  <em class="jxr_javadoccomment">     * Path to the renamed main {@code module-info.class} file. This file</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a>  <em class="jxr_javadoccomment">     * needs to be renamed as {@link #moduleInfoToHide} after compilation.</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Path moduleInfoBackup;
+<a class="jxr_linenumber" name="L62" href="#L62">62</a>  
+<a class="jxr_linenumber" name="L63" href="#L63">63</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a>  <em class="jxr_javadoccomment">     * The {@code module-info.class} to use as a replacement for the one which has been renamed.</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Path moduleInfoReplacement;
+<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">     * The shutdown hook invoked if the user interrupts the compilation, for example with [Control-C].</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a>      <strong class="jxr_keyword">private</strong> Thread shutdownHook;
+<a class="jxr_linenumber" name="L72" href="#L72">72</a>  
+<a class="jxr_linenumber" name="L73" href="#L73">73</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L74" href="#L74">74</a>  <em class="jxr_javadoccomment">     * Creates a new instance.</em>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L76" href="#L76">76</a>      <strong class="jxr_keyword">private</strong> <a name="ModuleInfoOverwrite" href="../../../../../org/apache/maven/plugin/compiler/ModuleInfoOverwrite.html#ModuleInfoOverwrite">ModuleInfoOverwrite</a>(Path source, Path main, Path test) {
+<a class="jxr_linenumber" name="L77" href="#L77">77</a>          testSourceFile = source;
+<a class="jxr_linenumber" name="L78" href="#L78">78</a>          savedSourceFile = source.resolveSibling(MODULE_INFO + JAVA_FILE_SUFFIX + <span class="jxr_string">".bak"</span>);
+<a class="jxr_linenumber" name="L79" href="#L79">79</a>          moduleInfoToHide = main;
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>          moduleInfoBackup = main.resolveSibling(MODULE_INFO + CLASS_FILE_SUFFIX + <span class="jxr_string">".bak"</span>);
+<a class="jxr_linenumber" name="L81" href="#L81">81</a>          moduleInfoReplacement = test;
+<a class="jxr_linenumber" name="L82" href="#L82">82</a>      }
+<a class="jxr_linenumber" name="L83" href="#L83">83</a>  
+<a class="jxr_linenumber" name="L84" href="#L84">84</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>  <em class="jxr_javadoccomment">     * Returns an instance for the given main output directory, or {@code null} if not needed.</em>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>  <em class="jxr_javadoccomment">     * This method should be invoked only if a {@code module-info.java} file exists and may</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a>  <em class="jxr_javadoccomment">     * overwrite a file defined in the main classes.</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a>      <strong class="jxr_keyword">static</strong> <a name="ModuleInfoOverwrite" href="../../../../../org/apache/maven/plugin/compiler/ModuleInfoOverwrite.html#ModuleInfoOverwrite">ModuleInfoOverwrite</a> create(Path source, Path mainOutputDirectory, Path testOutputDirectory)
+<a class="jxr_linenumber" name="L90" href="#L90">90</a>              <strong class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="L91" href="#L91">91</a>          Path main = mainOutputDirectory.resolve(MODULE_INFO + CLASS_FILE_SUFFIX);
+<a class="jxr_linenumber" name="L92" href="#L92">92</a>          <strong class="jxr_keyword">if</strong> (Files.isRegularFile(main)) {
+<a class="jxr_linenumber" name="L93" href="#L93">93</a>              Path test = testOutputDirectory.resolve(MODULE_INFO + CLASS_FILE_SUFFIX);
+<a class="jxr_linenumber" name="L94" href="#L94">94</a>              <strong class="jxr_keyword">if</strong> (Files.isRegularFile(test)) {
+<a class="jxr_linenumber" name="L95" href="#L95">95</a>                  <strong class="jxr_keyword">var</strong> mo = <strong class="jxr_keyword">new</strong> <a name="ModuleInfoOverwrite" href="../../../../../org/apache/maven/plugin/compiler/ModuleInfoOverwrite.html#ModuleInfoOverwrite">ModuleInfoOverwrite</a>(source, main, test);
+<a class="jxr_linenumber" name="L96" href="#L96">96</a>                  mo.substitute();
+<a class="jxr_linenumber" name="L97" href="#L97">97</a>                  <strong class="jxr_keyword">return</strong> mo;
+<a class="jxr_linenumber" name="L98" href="#L98">98</a>              }
+<a class="jxr_linenumber" name="L99" href="#L99">99</a>          }
+<a class="jxr_linenumber" name="L100" href="#L100">100</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<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_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">     * Replaces the main {@code module-info.class} file by the test one.</em>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">     * The original file is saved in the {@code module-info.class.bak} file.</em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">     * Then the test {@code module-info.class} is moved to the main directory.</em>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">     * Note that it needs to be moved, not copied or linked, because we need</em>
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">     * to temporarily remove {@code module-info.class} from the test directory</em>
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment">     * (otherwise {@code javac} does not seem to consider that we are patching a module).</em>
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">     * @throws IOException if an error occurred while renaming the file.</em>
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L113" href="#L113">113</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> substitute() <strong class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="L114" href="#L114">114</a>         Files.move(testSourceFile, savedSourceFile);
+<a class="jxr_linenumber" name="L115" href="#L115">115</a>         Files.move(moduleInfoToHide, moduleInfoBackup);
+<a class="jxr_linenumber" name="L116" href="#L116">116</a>         Files.move(moduleInfoReplacement, moduleInfoToHide);
+<a class="jxr_linenumber" name="L117" href="#L117">117</a>         <strong class="jxr_keyword">if</strong> (shutdownHook == <strong class="jxr_keyword">null</strong>) { <em class="jxr_comment">// Paranoiac check in case this method is invoked twice (should not happen).</em>
+<a class="jxr_linenumber" name="L118" href="#L118">118</a>             shutdownHook = <strong class="jxr_keyword">new</strong> Thread(<strong class="jxr_keyword">this</strong>);
+<a class="jxr_linenumber" name="L119" href="#L119">119</a>             Runtime.getRuntime().addShutdownHook(shutdownHook);
+<a class="jxr_linenumber" name="L120" href="#L120">120</a>         }
+<a class="jxr_linenumber" name="L121" href="#L121">121</a>     }
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> 
+<a class="jxr_linenumber" name="L123" href="#L123">123</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment">     * Restores the {@code module-info} file.</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">     * @throws IOException if an error occurred while renaming the file.</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">void</strong> restore() <strong class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="L129" href="#L129">129</a>         <strong class="jxr_keyword">if</strong> (shutdownHook != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L130" href="#L130">130</a>             Runtime.getRuntime().removeShutdownHook(shutdownHook);
+<a class="jxr_linenumber" name="L131" href="#L131">131</a>         }
+<a class="jxr_linenumber" name="L132" href="#L132">132</a>         Files.move(savedSourceFile, testSourceFile); <em class="jxr_comment">// File to restore in priority.</em>
+<a class="jxr_linenumber" name="L133" href="#L133">133</a>         Files.move(moduleInfoToHide, moduleInfoReplacement);
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>         Files.move(moduleInfoBackup, moduleInfoToHide);
+<a class="jxr_linenumber" name="L135" href="#L135">135</a>     }
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> 
+<a class="jxr_linenumber" name="L137" href="#L137">137</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment">     * Invoked during JVM shutdown if user interrupted the compilation, for example with [Control-C].</em>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a>     @Override
+<a class="jxr_linenumber" name="L141" href="#L141">141</a>     @SuppressWarnings(<span class="jxr_string">"CallToPrintStackTrace"</span>)
+<a class="jxr_linenumber" name="L142" href="#L142">142</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run() {
+<a class="jxr_linenumber" name="L143" href="#L143">143</a>         shutdownHook = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L144" href="#L144">144</a>         <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L145" href="#L145">145</a>             restore();
+<a class="jxr_linenumber" name="L146" href="#L146">146</a>         } <strong class="jxr_keyword">catch</strong> (IOException e) {
+<a class="jxr_linenumber" name="L147" href="#L147">147</a>             <em class="jxr_comment">// We cannot do much better because the loggers are shutting down.</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a>             e.printStackTrace();
+<a class="jxr_linenumber" name="L149" href="#L149">149</a>         }
+<a class="jxr_linenumber" name="L150" href="#L150">150</a>     }
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
+</pre>
+<hr/>
+<div id="footer">Copyright &#169; 2001&#x2013;2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
+</body>
+</html>
\ No newline at end of file

Propchange: maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/Options.html
==============================================================================
--- maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/Options.html (added)
+++ maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/Options.html Mon Feb 17 20:56:18 2025
@@ -0,0 +1,353 @@
+<!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>Options xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/compiler/Options.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> javax.tools.OptionChecker;
+<a class="jxr_linenumber" name="L22" href="#L22">22</a>  
+<a class="jxr_linenumber" name="L23" href="#L23">23</a>  <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a class="jxr_linenumber" name="L24" href="#L24">24</a>  <strong class="jxr_keyword">import</strong> java.util.Arrays;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a>  <strong class="jxr_keyword">import</strong> java.util.Collection;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a>  <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a>  <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a>  <strong class="jxr_keyword">import</strong> java.util.function.UnaryOperator;
+<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.Log;
+<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"> * An helper class for preparing the options to pass to the tool (compiler or document generator).</em>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a>  <em class="jxr_javadoccomment"> * It does &lt;em&gt;not&lt;/em&gt; include the options related to paths (class-path, destination directory, &lt;i&gt;etc.&lt;/i&gt;).</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a>  <em class="jxr_javadoccomment"> * If an option is unsupported by the tool, a message is logged at the warning level.</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a>  <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a>  <em class="jxr_javadoccomment"> * @author Martin Desruisseaux</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">final</strong> <strong class="jxr_keyword">class</strong> <a name="Options" href="../../../../../org/apache/maven/plugin/compiler/Options.html#Options">Options</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 list of options with their values. For example, in order to compile for Java 17,</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a>  <em class="jxr_javadoccomment">     * {@code --release} and {@code 17} shall be two consecutive elements in this list.</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>      <strong class="jxr_keyword">final</strong> List&lt;String&gt; options;
+<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">     * The tools to use for checking whether an option is supported.</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a>  <em class="jxr_javadoccomment">     * It can be the Java compiler or the Javadoc generator.</em>
+<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>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> OptionChecker checker;
+<a class="jxr_linenumber" name="L51" href="#L51">51</a>  
+<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">     * Where to report warnings about unsupported options.</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Log logger;
+<a class="jxr_linenumber" name="L56" href="#L56">56</a>  
+<a class="jxr_linenumber" name="L57" href="#L57">57</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a>  <em class="jxr_javadoccomment">     * The warning message to log. This is used when a warning is not logged immediately,</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a>  <em class="jxr_javadoccomment">     * but deferred for allowing the caller to complete the message before to log.</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a>      <strong class="jxr_keyword">private</strong> String warning;
+<a class="jxr_linenumber" name="L62" href="#L62">62</a>  
+<a class="jxr_linenumber" name="L63" href="#L63">63</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a>  <em class="jxr_javadoccomment">     * Creates an initially empty list of options.</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a>  <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a>  <em class="jxr_javadoccomment">     * @param checker the tools to use for checking whether an option is supported</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a>  <em class="jxr_javadoccomment">     * @param logger where to report warnings about unsupported options</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a>      <a name="Options" href="../../../../../org/apache/maven/plugin/compiler/Options.html#Options">Options</a>(OptionChecker checker, Log logger) {
+<a class="jxr_linenumber" name="L70" href="#L70">70</a>          options = <strong class="jxr_keyword">new</strong> ArrayList&lt;&gt;();
+<a class="jxr_linenumber" name="L71" href="#L71">71</a>          <strong class="jxr_keyword">this</strong>.checker = checker;
+<a class="jxr_linenumber" name="L72" href="#L72">72</a>          <strong class="jxr_keyword">this</strong>.logger = logger;
+<a class="jxr_linenumber" name="L73" href="#L73">73</a>      }
+<a class="jxr_linenumber" name="L74" href="#L74">74</a>  
+<a class="jxr_linenumber" name="L75" href="#L75">75</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L76" href="#L76">76</a>  <em class="jxr_javadoccomment">     * Strips white spaces and returns the result if non-empty, or {@code null} otherwise.</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a>  <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a>  <em class="jxr_javadoccomment">     * @param value  the value from which to strip white spaces, or {@code null}</em>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a>  <em class="jxr_javadoccomment">     * @return the stripped value, or {@code null} if the value was null or blank</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String strip(String value) {
+<a class="jxr_linenumber" name="L82" href="#L82">82</a>          <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L83" href="#L83">83</a>              value = value.strip();
+<a class="jxr_linenumber" name="L84" href="#L84">84</a>              <strong class="jxr_keyword">if</strong> (value.isEmpty()) {
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>                  <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>              }
+<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> value;
+<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">     * Adds the given option if the given value is true and the option is supported.</em>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a>  <em class="jxr_javadoccomment">     * If the option is unsupported, then a warning is logged and the option is not added.</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a>  <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a>  <em class="jxr_javadoccomment">     * @param option the option (e.g. {@code --enable-preview})</em>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a>  <em class="jxr_javadoccomment">     * @param value value of the option</em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a>  <em class="jxr_javadoccomment">     * @return whether the option has been added</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> addIfTrue(String option, <strong class="jxr_keyword">boolean</strong> value) {
+<a class="jxr_linenumber" name="L100" href="#L100">100</a>         <strong class="jxr_keyword">if</strong> (value &amp;&amp; checkNumberOfArguments(option, 0, <strong class="jxr_keyword">true</strong>)) {
+<a class="jxr_linenumber" name="L101" href="#L101">101</a>             options.add(option);
+<a class="jxr_linenumber" name="L102" href="#L102">102</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<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> false;
+<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>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">     * Adds the given option if a non-null and non-blank value is provided and if the option is supported.</em>
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment">     * If the option is unsupported by the tool, then a warning is logged and the option is not added.</em>
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">     * @param option the option (e.g., {@code --release})</em>
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">     * @param value value of the option, or {@code null} or blank if none</em>
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment">     * @return whether the option has been added</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">public</strong> <strong class="jxr_keyword">boolean</strong> addIfNonBlank(String option, String value) {
+<a class="jxr_linenumber" name="L116" href="#L116">116</a>         value = strip(value);
+<a class="jxr_linenumber" name="L117" href="#L117">117</a>         <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L118" href="#L118">118</a>             <strong class="jxr_keyword">if</strong> (checkNumberOfArguments(option, 1, <strong class="jxr_keyword">true</strong>)) {
+<a class="jxr_linenumber" name="L119" href="#L119">119</a>                 options.add(option);
+<a class="jxr_linenumber" name="L120" href="#L120">120</a>                 options.add(value);
+<a class="jxr_linenumber" name="L121" href="#L121">121</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<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="L124" href="#L124">124</a>         <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L125" href="#L125">125</a>     }
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> 
+<a class="jxr_linenumber" name="L127" href="#L127">127</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">     * Adds the given option using the {@code option:values} syntax where {@code values} is a coma-separated list.</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">     * The option is added only if at least one non-blank value is provided. Values are converted to lower cases.</em>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">     * Leading and trailing spaces are removed. If a filter is specified, then that filter will receive the values</em>
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">     * specified by the users and shall return the values to append, or {@code null} for not appending the option.</em>
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">     * @param option the option (e.g. {@code -g})</em>
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment">     * @param values coma-separated values of the option, or {@code null} if none</em>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">     * @param valids valid values for better error message when needed, or {@code null} if unspecified</em>
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">     * @param filter filter to apply on the values before to add them, or {@code null} if none</em>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment">     * @return whether the option has been added</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>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addComaSeparated(
+<a class="jxr_linenumber" name="L140" href="#L140">140</a>             <strong class="jxr_keyword">final</strong> String option, String values, Collection&lt;String&gt; valids, UnaryOperator&lt;String[]&gt; filter) {
+<a class="jxr_linenumber" name="L141" href="#L141">141</a>         <strong class="jxr_keyword">if</strong> (values == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L142" href="#L142">142</a>             <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L143" href="#L143">143</a>         }
+<a class="jxr_linenumber" name="L144" href="#L144">144</a>         <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_comment">         * Rebuild the comma-separated list of options with spaces removed, empty values omitted and case</em>
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_comment">         * changed to lower-case. The split list will be reused for diagnostic if the option is not accepted.</em>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_comment">         */</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a>         String[] split = values.split(<span class="jxr_string">","</span>);
+<a class="jxr_linenumber" name="L149" href="#L149">149</a>         <strong class="jxr_keyword">int</strong> count = 0;
+<a class="jxr_linenumber" name="L150" href="#L150">150</a>         <strong class="jxr_keyword">for</strong> (String value : split) {
+<a class="jxr_linenumber" name="L151" href="#L151">151</a>             value = value.strip();
+<a class="jxr_linenumber" name="L152" href="#L152">152</a>             <strong class="jxr_keyword">if</strong> (!value.isEmpty()) {
+<a class="jxr_linenumber" name="L153" href="#L153">153</a>                 split[count++] = value.toLowerCase(Locale.US);
+<a class="jxr_linenumber" name="L154" href="#L154">154</a>             }
+<a class="jxr_linenumber" name="L155" href="#L155">155</a>         }
+<a class="jxr_linenumber" name="L156" href="#L156">156</a>         <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_comment">         * If a filter is specified, replace the user-specified list by the filtered one.</em>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_comment">         * The filtering may result in an empty list, which is interpreted as an option without value.</em>
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_comment">         * This is different than an absence of user-supplied values, which is interpreted as no option.</em>
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_comment">         * This subtle difference explains why the check for absence of values is done before filtering,</em>
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_comment">         * and is needed for making possible to replace "-g:all" by "-g" (because the "all" value is a</em>
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_comment">         * Maven addition).</em>
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_comment">         */</em>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a>         <strong class="jxr_keyword">if</strong> (count == 0) {
+<a class="jxr_linenumber" name="L165" href="#L165">165</a>             <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L166" href="#L166">166</a>         }
+<a class="jxr_linenumber" name="L167" href="#L167">167</a>         <strong class="jxr_keyword">if</strong> (filter != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L168" href="#L168">168</a>             <strong class="jxr_keyword">if</strong> (count != split.length) {
+<a class="jxr_linenumber" name="L169" href="#L169">169</a>                 split = Arrays.copyOfRange(split, 0, count);
+<a class="jxr_linenumber" name="L170" href="#L170">170</a>             }
+<a class="jxr_linenumber" name="L171" href="#L171">171</a>             split = filter.apply(split);
+<a class="jxr_linenumber" name="L172" href="#L172">172</a>             <strong class="jxr_keyword">if</strong> (split == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L173" href="#L173">173</a>                 <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L174" href="#L174">174</a>             }
+<a class="jxr_linenumber" name="L175" href="#L175">175</a>             count = split.length;
+<a class="jxr_linenumber" name="L176" href="#L176">176</a>         }
+<a class="jxr_linenumber" name="L177" href="#L177">177</a>         <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_comment">         * Format the option (possibly with no values), then validate.</em>
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_comment">         */</em>
+<a class="jxr_linenumber" name="L180" href="#L180">180</a>         <strong class="jxr_keyword">var</strong> sb = <strong class="jxr_keyword">new</strong> StringBuilder(option);
+<a class="jxr_linenumber" name="L181" href="#L181">181</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; count; i++) {
+<a class="jxr_linenumber" name="L182" href="#L182">182</a>             sb.append(i == 0 ? ':' : ',').append(split[i]);
+<a class="jxr_linenumber" name="L183" href="#L183">183</a>         }
+<a class="jxr_linenumber" name="L184" href="#L184">184</a>         String s = sb.toString();
+<a class="jxr_linenumber" name="L185" href="#L185">185</a>         <strong class="jxr_keyword">if</strong> (checkNumberOfArguments(s, 0, false)) {
+<a class="jxr_linenumber" name="L186" href="#L186">186</a>             options.add(s);
+<a class="jxr_linenumber" name="L187" href="#L187">187</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L188" href="#L188">188</a>         }
+<a class="jxr_linenumber" name="L189" href="#L189">189</a>         <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_comment">         * A log message has been prepared in the `warning` field for saying that the option is not supported.</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_comment">         * If a collection of valid options was provided, use it for identifying which option was invalid.</em>
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_comment">         */</em>
+<a class="jxr_linenumber" name="L193" href="#L193">193</a>         <strong class="jxr_keyword">if</strong> (valids != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L194" href="#L194">194</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; count; i++) {
+<a class="jxr_linenumber" name="L195" href="#L195">195</a>                 String value = split[i];
+<a class="jxr_linenumber" name="L196" href="#L196">196</a>                 <strong class="jxr_keyword">if</strong> (!valids.contains(value)) {
+<a class="jxr_linenumber" name="L197" href="#L197">197</a>                     sb.setLength(0);
+<a class="jxr_linenumber" name="L198" href="#L198">198</a>                     sb.append(warning);
+<a class="jxr_linenumber" name="L199" href="#L199">199</a>                     sb.setLength(sb.length() - 1); <em class="jxr_comment">// Remove the trailing dot.</em>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a>                     sb.append(<span class="jxr_string">", because the specified "</span>)
+<a class="jxr_linenumber" name="L201" href="#L201">201</a>                             .append(option)
+<a class="jxr_linenumber" name="L202" href="#L202">202</a>                             .append(<span class="jxr_string">" value '"</span>)
+<a class="jxr_linenumber" name="L203" href="#L203">203</a>                             .append(value)
+<a class="jxr_linenumber" name="L204" href="#L204">204</a>                             .append(<span class="jxr_string">"' is unexpected. Legal values are: "</span>);
+<a class="jxr_linenumber" name="L205" href="#L205">205</a>                     <strong class="jxr_keyword">int</strong> j = 0;
+<a class="jxr_linenumber" name="L206" href="#L206">206</a>                     <strong class="jxr_keyword">for</strong> (String valid : valids) {
+<a class="jxr_linenumber" name="L207" href="#L207">207</a>                         <strong class="jxr_keyword">if</strong> (j++ != 0) {
+<a class="jxr_linenumber" name="L208" href="#L208">208</a>                             sb.append(<span class="jxr_string">", "</span>);
+<a class="jxr_linenumber" name="L209" href="#L209">209</a>                             <strong class="jxr_keyword">if</strong> (j == valids.size()) {
+<a class="jxr_linenumber" name="L210" href="#L210">210</a>                                 sb.append(<span class="jxr_string">"and "</span>);
+<a class="jxr_linenumber" name="L211" href="#L211">211</a>                             }
+<a class="jxr_linenumber" name="L212" href="#L212">212</a>                         }
+<a class="jxr_linenumber" name="L213" href="#L213">213</a>                         sb.append('\'').append(valid).append('\'');
+<a class="jxr_linenumber" name="L214" href="#L214">214</a>                     }
+<a class="jxr_linenumber" name="L215" href="#L215">215</a>                     warning = sb.append('.').toString();
+<a class="jxr_linenumber" name="L216" href="#L216">216</a>                     <strong class="jxr_keyword">break</strong>;
+<a class="jxr_linenumber" name="L217" href="#L217">217</a>                 }
+<a class="jxr_linenumber" name="L218" href="#L218">218</a>             }
+<a class="jxr_linenumber" name="L219" href="#L219">219</a>         }
+<a class="jxr_linenumber" name="L220" href="#L220">220</a>         logger.warn(warning);
+<a class="jxr_linenumber" name="L221" href="#L221">221</a>         warning = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L222" href="#L222">222</a>         <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L223" href="#L223">223</a>     }
+<a class="jxr_linenumber" name="L224" href="#L224">224</a> 
+<a class="jxr_linenumber" name="L225" href="#L225">225</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment">     * Verifies the validity of the given memory setting and adds it as an option.</em>
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment">     * If the value has no units and Maven defaults are enabled, appends "M" as the default units of measurement.</em>
+<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment">     * Note: in the International System of Units, the symbol shall be upper-case "M". The lower-case "m" symbol</em>
+<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment">     * is not correct as it stands for "milli".</em>
+<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment">     * @param option the option (e.g. {@code -J-Xms})</em>
+<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment">     * @param label name of the XML element or attribute, used only if a warning message needs to be produced</em>
+<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment">     * @param value the memory setting, or {@code null} if none</em>
+<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment">     * @param addDefaultUnit whether to add a default unit (currently 'M') if none is provided</em>
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment">     * @return whether the option has been added</em>
+<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L237" href="#L237">237</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addMemoryValue(String option, String label, String value, <strong class="jxr_keyword">boolean</strong> addDefaultUnit) {
+<a class="jxr_linenumber" name="L238" href="#L238">238</a>         value = strip(value);
+<a class="jxr_linenumber" name="L239" href="#L239">239</a>         <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L240" href="#L240">240</a>             <strong class="jxr_keyword">int</strong> length = value.length();
+<a class="jxr_linenumber" name="L241" href="#L241">241</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; length; i++) {
+<a class="jxr_linenumber" name="L242" href="#L242">242</a>                 <strong class="jxr_keyword">char</strong> c = value.charAt(i);
+<a class="jxr_linenumber" name="L243" href="#L243">243</a>                 <strong class="jxr_keyword">if</strong> (c &lt; '0' || c &gt; '9') { <em class="jxr_comment">// Do no use `isDigit(…)` because we do not accept other languages.</em>
+<a class="jxr_linenumber" name="L244" href="#L244">244</a>                     <strong class="jxr_keyword">if</strong> (i == length - 1) {
+<a class="jxr_linenumber" name="L245" href="#L245">245</a>                         c = Character.toUpperCase(c);
+<a class="jxr_linenumber" name="L246" href="#L246">246</a>                         <strong class="jxr_keyword">if</strong> (c == 'K' || c == 'M' || c == 'G') {
+<a class="jxr_linenumber" name="L247" href="#L247">247</a>                             addDefaultUnit = false;
+<a class="jxr_linenumber" name="L248" href="#L248">248</a>                             <strong class="jxr_keyword">break</strong>;
+<a class="jxr_linenumber" name="L249" href="#L249">249</a>                         }
+<a class="jxr_linenumber" name="L250" href="#L250">250</a>                     }
+<a class="jxr_linenumber" name="L251" href="#L251">251</a>                     logger.warn(<span class="jxr_string">"Invalid value for "</span> + label + <span class="jxr_string">"=\&quot;"</span> + value + <span class="jxr_string">"\&quot;. Ignoring this option."</span>);
+<a class="jxr_linenumber" name="L252" href="#L252">252</a>                     <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L253" href="#L253">253</a>                 }
+<a class="jxr_linenumber" name="L254" href="#L254">254</a>             }
+<a class="jxr_linenumber" name="L255" href="#L255">255</a>             <strong class="jxr_keyword">if</strong> (addDefaultUnit) {
+<a class="jxr_linenumber" name="L256" href="#L256">256</a>                 value += 'M'; <em class="jxr_comment">// Upper case because this is the correct case in International System of Units.</em>
+<a class="jxr_linenumber" name="L257" href="#L257">257</a>                 logger.warn(<span class="jxr_string">"Value "</span> + label + <span class="jxr_string">"=\&quot;"</span> + value + <span class="jxr_string">"\&quot; has been specified without unit. "</span>
+<a class="jxr_linenumber" name="L258" href="#L258">258</a>                         + <span class="jxr_string">"An explicit \&quot;M\&quot; unit symbol should be appended for avoiding ambiguity."</span>);
+<a class="jxr_linenumber" name="L259" href="#L259">259</a>             }
+<a class="jxr_linenumber" name="L260" href="#L260">260</a>             option += value;
+<a class="jxr_linenumber" name="L261" href="#L261">261</a>             <strong class="jxr_keyword">if</strong> (checkNumberOfArguments(option, 0, <strong class="jxr_keyword">true</strong>)) {
+<a class="jxr_linenumber" name="L262" href="#L262">262</a>                 options.add(option);
+<a class="jxr_linenumber" name="L263" href="#L263">263</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L264" href="#L264">264</a>             }
+<a class="jxr_linenumber" name="L265" href="#L265">265</a>         }
+<a class="jxr_linenumber" name="L266" href="#L266">266</a>         <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L267" href="#L267">267</a>     }
+<a class="jxr_linenumber" name="L268" href="#L268">268</a> 
+<a class="jxr_linenumber" name="L269" href="#L269">269</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment">     * Verifies if the given option is supported and accepts the given number of arguments.</em>
+<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment">     * If not, a warning is logged if {@code immediate} is {@code true}, or stored in the</em>
+<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment">     * {@link #warning} field if {@code immediate} is {@code false}.</em>
+<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment">     * &lt;p&gt;If a message is stored in {@link #warning}, then it will always end with a dot.</em>
+<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment">     * This guarantee allows callers to delete the last character and replace it by a coma</em>
+<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment">     * for continuing the sentence.&lt;/p&gt;</em>
+<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment">     * @param option the option to validate</em>
+<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment">     * @param count the number of arguments that the caller wants to provide</em>
+<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment">     * @param immediate whether to log immediately or to store the message in {@link #warning}</em>
+<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment">     * @return whether the given option is supported and accepts the specified number of arguments</em>
+<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L283" href="#L283">283</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> checkNumberOfArguments(String option, <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">boolean</strong> immediate) {
+<a class="jxr_linenumber" name="L284" href="#L284">284</a>         <strong class="jxr_keyword">int</strong> expected = checker.isSupportedOption(option);
+<a class="jxr_linenumber" name="L285" href="#L285">285</a>         <strong class="jxr_keyword">if</strong> (expected == count) {
+<a class="jxr_linenumber" name="L286" href="#L286">286</a>             warning = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L287" href="#L287">287</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L288" href="#L288">288</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (expected &lt; 1) {
+<a class="jxr_linenumber" name="L289" href="#L289">289</a>             <strong class="jxr_keyword">if</strong> (checker instanceof <a name="ForkedCompiler" href="../../../../../org/apache/maven/plugin/compiler/ForkedCompiler.html#ForkedCompiler">ForkedCompiler</a>) {
+<a class="jxr_linenumber" name="L290" href="#L290">290</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">// That implementation actually knows nothing about which options are supported.</em>
+<a class="jxr_linenumber" name="L291" href="#L291">291</a>             }
+<a class="jxr_linenumber" name="L292" href="#L292">292</a>             warning = <span class="jxr_string">"The '"</span> + option + <span class="jxr_string">"' option is not supported."</span>;
+<a class="jxr_linenumber" name="L293" href="#L293">293</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (expected == 0) {
+<a class="jxr_linenumber" name="L294" href="#L294">294</a>             warning = <span class="jxr_string">"The '"</span> + option + <span class="jxr_string">"' option does not expect any argument."</span>;
+<a class="jxr_linenumber" name="L295" href="#L295">295</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (expected == 1) {
+<a class="jxr_linenumber" name="L296" href="#L296">296</a>             warning = <span class="jxr_string">"The '"</span> + option + <span class="jxr_string">"' option expects a single argument."</span>;
+<a class="jxr_linenumber" name="L297" href="#L297">297</a>         } <strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L298" href="#L298">298</a>             warning = <span class="jxr_string">"The '"</span> + option + <span class="jxr_string">"' option expects "</span> + expected + <span class="jxr_string">" arguments."</span>;
+<a class="jxr_linenumber" name="L299" href="#L299">299</a>         }
+<a class="jxr_linenumber" name="L300" href="#L300">300</a>         <strong class="jxr_keyword">if</strong> (immediate) {
+<a class="jxr_linenumber" name="L301" href="#L301">301</a>             logger.warn(warning);
+<a class="jxr_linenumber" name="L302" href="#L302">302</a>             warning = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L303" href="#L303">303</a>         }
+<a class="jxr_linenumber" name="L304" href="#L304">304</a>         <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L305" href="#L305">305</a>     }
+<a class="jxr_linenumber" name="L306" href="#L306">306</a> 
+<a class="jxr_linenumber" name="L307" href="#L307">307</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment">     * Adds the non-null and non-empty elements without verifying their validity.</em>
+<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment">     * This method is used for user-specified compiler arguments.</em>
+<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment">     * @param arguments the arguments to add, or {@code null} or empty if none</em>
+<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L313" href="#L313">313</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addUnchecked(Iterable&lt;String&gt; arguments) {
+<a class="jxr_linenumber" name="L314" href="#L314">314</a>         <strong class="jxr_keyword">if</strong> (arguments != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L315" href="#L315">315</a>             <strong class="jxr_keyword">for</strong> (String arg : arguments) {
+<a class="jxr_linenumber" name="L316" href="#L316">316</a>                 <strong class="jxr_keyword">if</strong> (arg != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L317" href="#L317">317</a>                     arg = arg.strip();
+<a class="jxr_linenumber" name="L318" href="#L318">318</a>                     <strong class="jxr_keyword">if</strong> (!arg.isEmpty()) {
+<a class="jxr_linenumber" name="L319" href="#L319">319</a>                         options.add(arg);
+<a class="jxr_linenumber" name="L320" href="#L320">320</a>                     }
+<a class="jxr_linenumber" name="L321" href="#L321">321</a>                 }
+<a class="jxr_linenumber" name="L322" href="#L322">322</a>             }
+<a class="jxr_linenumber" name="L323" href="#L323">323</a>         }
+<a class="jxr_linenumber" name="L324" href="#L324">324</a>     }
+<a class="jxr_linenumber" name="L325" href="#L325">325</a> 
+<a class="jxr_linenumber" name="L326" href="#L326">326</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment">     * Splits the given arguments around spaces, then adds them without verifying their validity.</em>
+<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment">     * This is used for user-specified arguments.</em>
+<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment">     * @param arguments the arguments to add, or {@code null} if none</em>
+<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment">     * @deprecated Use {@link #addUnchecked(List)} instead. This method does not check for quoted strings.</em>
+<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L334" href="#L334">334</a>     @Deprecated(since = <span class="jxr_string">"4.0.0"</span>)
+<a class="jxr_linenumber" name="L335" href="#L335">335</a>     <strong class="jxr_keyword">void</strong> addUnchecked(String arguments) {
+<a class="jxr_linenumber" name="L336" href="#L336">336</a>         <strong class="jxr_keyword">if</strong> (arguments != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L337" href="#L337">337</a>             addUnchecked(Arrays.asList(arguments.split(<span class="jxr_string">" "</span>)));
+<a class="jxr_linenumber" name="L338" href="#L338">338</a>         }
+<a class="jxr_linenumber" name="L339" href="#L339">339</a>     }
+<a class="jxr_linenumber" name="L340" href="#L340">340</a> }
+</pre>
+<hr/>
+<div id="footer">Copyright &#169; 2001&#x2013;2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
+</body>
+</html>
\ No newline at end of file

Propchange: maven/website/components/plugins-archives/maven-compiler-plugin-LATEST-4.x/xref/org/apache/maven/plugin/compiler/Options.html
------------------------------------------------------------------------------
    svn:eol-style = native