Modified: maven/website/components/plugins-archives/maven-jar-plugin-LATEST/xref/org/apache/maven/plugins/jar/AbstractJarMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-jar-plugin-LATEST/xref/org/apache/maven/plugins/jar/AbstractJarMojo.html (original) +++ maven/website/components/plugins-archives/maven-jar-plugin-LATEST/xref/org/apache/maven/plugins/jar/AbstractJarMojo.html Tue Apr 9 21:19:38 2024 @@ -46,322 +46,365 @@ <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.toolchain.ToolchainManager; <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.Archiver; <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.jar.JarArchiver; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * Base class for creating a jar from project classes.</em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @author <a href="[email protected]">Emmanuel Venisse</a></em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @version $Id$</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">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractJarMojo" href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#AbstractJarMojo">AbstractJarMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { -<a class="jxr_linenumber" name="L49" href="#L49">49</a> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String[] DEFAULT_EXCLUDES = <strong class="jxr_keyword">new</strong> String[] {<span class="jxr_string">"**/package.html"</span>}; -<a class="jxr_linenumber" name="L51" href="#L51">51</a> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String[] DEFAULT_INCLUDES = <strong class="jxr_keyword">new</strong> String[] {<span class="jxr_string">"**/**"</span>}; -<a class="jxr_linenumber" name="L53" href="#L53">53</a> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String MODULE_DESCRIPTOR_FILE_NAME = <span class="jxr_string">"module-info.class"</span>; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SEPARATOR = FileSystems.getDefault().getSeparator(); -<a class="jxr_linenumber" name="L57" href="#L57">57</a> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> @Component -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> <a name="ToolchainsJdkSpecification" href="../../../../../org/apache/maven/plugins/jar/ToolchainsJdkSpecification.html#ToolchainsJdkSpecification">ToolchainsJdkSpecification</a> toolchainsJdkSpecification; -<a class="jxr_linenumber" name="L60" href="#L60">60</a> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Component -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> ToolchainManager toolchainManager; -<a class="jxr_linenumber" name="L63" href="#L63">63</a> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * List of files to include. Specified as fileset patterns which are relative to the input directory whose contents</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * is being packaged into the JAR.</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> @Parameter -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">private</strong> String[] includes; -<a class="jxr_linenumber" name="L70" href="#L70">70</a> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * is being packaged into the JAR.</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> @Parameter -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> String[] excludes; -<a class="jxr_linenumber" name="L77" href="#L77">77</a> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * Directory containing the generated JAR.</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> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}"</span>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">private</strong> File outputDirectory; -<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"> * Name of the generated JAR.</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.finalName}"</span>, readonly = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> String finalName; -<a class="jxr_linenumber" name="L89" href="#L89">89</a> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * The Jar archiver.</em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> @Component -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">private</strong> Map<String, Archiver> archivers; -<a class="jxr_linenumber" name="L95" href="#L95">95</a> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * The {@link MavenProject}.</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> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">private</strong> MavenProject project; -<a class="jxr_linenumber" name="L101" href="#L101">101</a> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * The {@link MavenSession}.</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> @Parameter(defaultValue = <span class="jxr_string">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">private</strong> MavenSession session; -<a class="jxr_linenumber" name="L107" href="#L107">107</a> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * The archive configuration to use. See <a href="<a href="http://maven.apache.org/shared/maven-archiver/index.html"; target="alexandria_uri">http://maven.apache.org/shared/maven-archiver/index.html</a>">Maven</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * Archiver Reference</a>.</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Parameter -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">private</strong> MavenArchiveConfiguration archive = <strong class="jxr_keyword">new</strong> MavenArchiveConfiguration(); -<a class="jxr_linenumber" name="L114" href="#L114">114</a> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * Using this property will fail your build cause it has been removed from the plugin configuration. See the</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * <a href="<a href="https://maven.apache.org/plugins/maven-jar-plugin/"; target="alexandria_uri">https://maven.apache.org/plugins/maven-jar-plugin/</a>">Major Version Upgrade to version 3.0.0</a> for the</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * plugin.</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @deprecated For version 3.0.0 this parameter is only defined here to break the build if you use it!</em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> @Parameter(property = <span class="jxr_string">"jar.useDefaultManifestFile"</span>, defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L123" href="#L123">123</a> @Deprecated -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> useDefaultManifestFile; -<a class="jxr_linenumber" name="L125" href="#L125">125</a> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em> -<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> @Component -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">private</strong> MavenProjectHelper projectHelper; -<a class="jxr_linenumber" name="L131" href="#L131">131</a> -<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"> * Require the jar plugin to build a new JAR even if none of the contents appear to have changed. By default, this</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * plugin looks to see if the output jar exists and inputs have not changed. If these conditions are true, the</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * plugin skips creation of the jar. This does not work when other plugins, like the maven-shade-plugin, are</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * configured to post-process the jar. This plugin can not detect the post-processing, and so leaves the</em> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * post-processed jar in place. This can lead to failures when those plugins do not expect to find their own output</em> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * as an input. Set this parameter to <tt>true</tt> to avoid these problems by forcing this plugin to recreate the</em> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * jar every time.<br/></em> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * Starting with <b>3.0.0</b> the property has been renamed from <code>jar.forceCreation</code> to</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * <code>maven.jar.forceCreation</code>.</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> @Parameter(property = <span class="jxr_string">"maven.jar.forceCreation"</span>, defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> forceCreation; -<a class="jxr_linenumber" name="L145" href="#L145">145</a> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Skip creating empty archives.</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipIfEmpty; -<a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Timestamp for reproducible output archive entries, either formatted as ISO 8601 extended offset date-time</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * (e.g. in UTC such as '2011-12-03T10:15:30Z' or with an offset '2019-10-05T20:37:42+06:00'),</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * or as an int representing seconds since the epoch</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * (like <a href="<a href="https://reproducible-builds.org/docs/source-date-epoch/"; target="alexandria_uri">https://reproducible-builds.org/docs/source-date-epoch/</a>">SOURCE_DATE_EPOCH</a>).</em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @since 3.2.0</em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.outputTimestamp}"</span>) -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">private</strong> String outputTimestamp; -<a class="jxr_linenumber" name="L162" href="#L162">162</a> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * If the JAR contains the {@code META-INF/versions} directory it will be detected as a multi-release JAR file</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * ("MRJAR"), adding the {@code Multi-Release: true} attribute to the main section of the JAR MANIFEST.MF.</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @since 3.4.0</em> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Parameter(property = <span class="jxr_string">"maven.jar.detectMultiReleaseJar"</span>, defaultValue = <span class="jxr_string">"true"</span>) -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> detectMultiReleaseJar; -<a class="jxr_linenumber" name="L171" href="#L171">171</a> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * Return the specific output directory to serve as the root for the archive.</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @return get classes directory.</em> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> File getClassesDirectory(); -<a class="jxr_linenumber" name="L177" href="#L177">177</a> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * Return the {@link #project MavenProject}</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @return the MavenProject.</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> MavenProject getProject() { -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">return</strong> project; -<a class="jxr_linenumber" name="L185" href="#L185">185</a> } -<a class="jxr_linenumber" name="L186" href="#L186">186</a> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * Overload this to produce a jar with another classifier, for example a test-jar.</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @return get the classifier.</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getClassifier(); -<a class="jxr_linenumber" name="L192" href="#L192">192</a> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * Overload this to produce a test-jar, for example.</em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * @return return the type.</em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getType(); -<a class="jxr_linenumber" name="L198" href="#L198">198</a> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * Returns the Jar file to generate, based on an optional classifier.</em> -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @param basedir the output directory</em> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @param resultFinalName the name of the ear file</em> -<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * @param classifier an optional classifier</em> -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @return the file to generate</em> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">protected</strong> File getJarFile(File basedir, String resultFinalName, String classifier) { -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">if</strong> (basedir == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"basedir is not allowed to be null"</span>); -<a class="jxr_linenumber" name="L210" href="#L210">210</a> } -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">if</strong> (resultFinalName == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"finalName is not allowed to be null"</span>); -<a class="jxr_linenumber" name="L213" href="#L213">213</a> } -<a class="jxr_linenumber" name="L214" href="#L214">214</a> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> String fileName = resultFinalName + (hasClassifier() ? <span class="jxr_string">"-"</span> + classifier : <span class="jxr_string">""</span>) + <span class="jxr_string">".jar"</span>; -<a class="jxr_linenumber" name="L216" href="#L216">216</a> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File(basedir, fileName); +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.util.DefaultFileSet; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Base class for creating a jar from project classes.</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @author <a href="[email protected]">Emmanuel Venisse</a></em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @version $Id$</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractJarMojo" href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#AbstractJarMojo">AbstractJarMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<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">static</strong> <strong class="jxr_keyword">final</strong> String[] DEFAULT_EXCLUDES = <strong class="jxr_keyword">new</strong> String[] {<span class="jxr_string">"**/package.html"</span>}; +<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">static</strong> <strong class="jxr_keyword">final</strong> String[] DEFAULT_INCLUDES = <strong class="jxr_keyword">new</strong> String[] {<span class="jxr_string">"**/**"</span>}; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String MODULE_DESCRIPTOR_FILE_NAME = <span class="jxr_string">"module-info.class"</span>; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SEPARATOR = FileSystems.getDefault().getSeparator(); +<a class="jxr_linenumber" name="L58" href="#L58">58</a> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> @Component +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> <a name="ToolchainsJdkSpecification" href="../../../../../org/apache/maven/plugins/jar/ToolchainsJdkSpecification.html#ToolchainsJdkSpecification">ToolchainsJdkSpecification</a> toolchainsJdkSpecification; +<a class="jxr_linenumber" name="L61" href="#L61">61</a> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> @Component +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> ToolchainManager toolchainManager; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * List of files to include. Specified as fileset patterns which are relative to the input directory whose contents</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * is being packaged into the JAR.</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> @Parameter +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">private</strong> String[] includes; +<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"> * List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * is being packaged into the JAR.</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> @Parameter +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> String[] excludes; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Directory containing the generated JAR.</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> File outputDirectory; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * Name of the generated JAR.</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.finalName}"</span>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> String finalName; +<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"> * The Jar archiver.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> @Component +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">private</strong> Map<String, Archiver> archivers; +<a class="jxr_linenumber" name="L96" href="#L96">96</a> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * The {@link MavenProject}.</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">private</strong> MavenProject project; +<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"> * The {@link MavenSession}.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> @Parameter(defaultValue = <span class="jxr_string">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">private</strong> MavenSession session; +<a class="jxr_linenumber" name="L108" href="#L108">108</a> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * The archive configuration to use. See <a href="<a href="http://maven.apache.org/shared/maven-archiver/index.html"; target="alexandria_uri">http://maven.apache.org/shared/maven-archiver/index.html</a>">Maven</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * Archiver Reference</a>.</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> @Parameter +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">private</strong> MavenArchiveConfiguration archive = <strong class="jxr_keyword">new</strong> MavenArchiveConfiguration(); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Using this property will fail your build cause it has been removed from the plugin configuration. See the</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * <a href="<a href="https://maven.apache.org/plugins/maven-jar-plugin/"; target="alexandria_uri">https://maven.apache.org/plugins/maven-jar-plugin/</a>">Major Version Upgrade to version 3.0.0</a> for the</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * plugin.</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @deprecated For version 3.0.0 this parameter is only defined here to break the build if you use it!</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> @Parameter(property = <span class="jxr_string">"jar.useDefaultManifestFile"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L124" href="#L124">124</a> @Deprecated +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> useDefaultManifestFile; +<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"> *</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> @Component +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">private</strong> MavenProjectHelper projectHelper; +<a class="jxr_linenumber" name="L132" href="#L132">132</a> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Require the jar plugin to build a new JAR even if none of the contents appear to have changed. By default, this</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * plugin looks to see if the output jar exists and inputs have not changed. If these conditions are true, the</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * plugin skips creation of the jar. This does not work when other plugins, like the maven-shade-plugin, are</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * configured to post-process the jar. This plugin can not detect the post-processing, and so leaves the</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * post-processed jar in place. This can lead to failures when those plugins do not expect to find their own output</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * as an input. Set this parameter to <tt>true</tt> to avoid these problems by forcing this plugin to recreate the</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * jar every time.<br/></em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * Starting with <b>3.0.0</b> the property has been renamed from <code>jar.forceCreation</code> to</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * <code>maven.jar.forceCreation</code>.</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Parameter(property = <span class="jxr_string">"maven.jar.forceCreation"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> forceCreation; +<a class="jxr_linenumber" name="L146" href="#L146">146</a> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * Skip creating empty archives.</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipIfEmpty; +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Timestamp for reproducible output archive entries, either formatted as ISO 8601 extended offset date-time</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * (e.g. in UTC such as '2011-12-03T10:15:30Z' or with an offset '2019-10-05T20:37:42+06:00'),</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * or as an int representing seconds since the epoch</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * (like <a href="<a href="https://reproducible-builds.org/docs/source-date-epoch/"; target="alexandria_uri">https://reproducible-builds.org/docs/source-date-epoch/</a>">SOURCE_DATE_EPOCH</a>).</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @since 3.2.0</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.outputTimestamp}"</span>) +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">private</strong> String outputTimestamp; +<a class="jxr_linenumber" name="L163" href="#L163">163</a> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * If the JAR contains the {@code META-INF/versions} directory it will be detected as a multi-release JAR file</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * ("MRJAR"), adding the {@code Multi-Release: true} attribute to the main section of the JAR MANIFEST.MF.</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @since 3.4.0</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> @Parameter(property = <span class="jxr_string">"maven.jar.detectMultiReleaseJar"</span>, defaultValue = <span class="jxr_string">"true"</span>) +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> detectMultiReleaseJar; +<a class="jxr_linenumber" name="L172" href="#L172">172</a> +<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"> * If set to {@code false}, the files and directories that by default are excluded from the resulting archive,</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * like {@code .gitignore}, {@code .cvsignore} etc. will be included.</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * This means all files like the following will be included.</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * <li>Misc: &#42;&#42;/&#42;~, &#42;&#42;/#&#42;#, &#42;&#42;/.#&#42;, &#42;&#42;/%&#42;%, &#42;&#42;/._&#42;</li></em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * <li>CVS: &#42;&#42;/CVS, &#42;&#42;/CVS/&#42;&#42;, &#42;&#42;/.cvsignore</li></em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * <li>RCS: &#42;&#42;/RCS, &#42;&#42;/RCS/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * <li>SCCS: &#42;&#42;/SCCS, &#42;&#42;/SCCS/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * <li>VSSercer: &#42;&#42;/vssver.scc</li></em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * <li>MKS: &#42;&#42;/project.pj</li></em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * <li>SVN: &#42;&#42;/.svn, &#42;&#42;/.svn/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * <li>GNU: &#42;&#42;/.arch-ids, &#42;&#42;/.arch-ids/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * <li>Bazaar: &#42;&#42;/.bzr, &#42;&#42;/.bzr/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * <li>SurroundSCM: &#42;&#42;/.MySCMServerInfo</li></em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * <li>Mac: &#42;&#42;/.DS_Store</li></em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * <li>Serena Dimension: &#42;&#42;/.metadata, &#42;&#42;/.metadata/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * <li>Mercurial: &#42;&#42;/.hg, &#42;&#42;/.hg/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * <li>Git: &#42;&#42;/.git, &#42;&#42;/.git/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * <li>Bitkeeper: &#42;&#42;/BitKeeper, &#42;&#42;/BitKeeper/&#42;&#42;, &#42;&#42;/ChangeSet,</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * &#42;&#42;/ChangeSet/&#42;&#42;</li></em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * <li>Darcs: &#42;&#42;/_darcs, &#42;&#42;/_darcs/&#42;&#42;, &#42;&#42;/.darcsrepo,</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * &#42;&#42;/.darcsrepo/&#42;&#42;&#42;&#42;/-darcs-backup&#42;, &#42;&#42;/.darcs-temp-mail</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="https://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util/AbstractScanner.html"; target="alexandria_uri">https://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util/AbstractScanner.html</a>#DEFAULTEXCLUDES">DEFAULTEXCLUDES</a></em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * @since 3.4.0</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> @Parameter(defaultValue = <span class="jxr_string">"true"</span>) +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> addDefaultExcludes; +<a class="jxr_linenumber" name="L204" href="#L204">204</a> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * Return the specific output directory to serve as the root for the archive.</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @return get classes directory.</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> File getClassesDirectory(); +<a class="jxr_linenumber" name="L210" href="#L210">210</a> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * Return the {@link #project MavenProject}</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * @return the MavenProject.</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> MavenProject getProject() { +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">return</strong> project; <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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * Generates the JAR.</em> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * @return The instance of File for the created archive file.</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException in case of an error.</em> -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">public</strong> File createArchive() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L226" href="#L226">226</a> File jarFile = getJarFile(outputDirectory, finalName, getClassifier()); -<a class="jxr_linenumber" name="L227" href="#L227">227</a> -<a class="jxr_linenumber" name="L228" href="#L228">228</a> FileSetManager fileSetManager = <strong class="jxr_keyword">new</strong> FileSetManager(); -<a class="jxr_linenumber" name="L229" href="#L229">229</a> FileSet jarContentFileSet = <strong class="jxr_keyword">new</strong> FileSet(); -<a class="jxr_linenumber" name="L230" href="#L230">230</a> jarContentFileSet.setDirectory(getClassesDirectory().getAbsolutePath()); -<a class="jxr_linenumber" name="L231" href="#L231">231</a> jarContentFileSet.setIncludes(Arrays.asList(getIncludes())); -<a class="jxr_linenumber" name="L232" href="#L232">232</a> jarContentFileSet.setExcludes(Arrays.asList(getExcludes())); -<a class="jxr_linenumber" name="L233" href="#L233">233</a> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> String[] includedFiles = fileSetManager.getIncludedFiles(jarContentFileSet); -<a class="jxr_linenumber" name="L235" href="#L235">235</a> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">if</strong> (detectMultiReleaseJar -<a class="jxr_linenumber" name="L237" href="#L237">237</a> && Arrays.stream(includedFiles) -<a class="jxr_linenumber" name="L238" href="#L238">238</a> .anyMatch(p -> p.startsWith(<span class="jxr_string">"META-INF"</span> + SEPARATOR + <span class="jxr_string">"versions"</span> + SEPARATOR))) { -<a class="jxr_linenumber" name="L239" href="#L239">239</a> getLog().debug(<span class="jxr_string">"Adding 'Multi-Release: true' manifest entry."</span>); -<a class="jxr_linenumber" name="L240" href="#L240">240</a> archive.addManifestEntry(<span class="jxr_string">"Multi-Release"</span>, <span class="jxr_string">"true"</span>); -<a class="jxr_linenumber" name="L241" href="#L241">241</a> } -<a class="jxr_linenumber" name="L242" href="#L242">242</a> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_comment">// May give false positives if the files is named as module descriptor</em> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_comment">// but is not in the root of the archive or in the versioned area</em> -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_comment">// (and hence not actually a module descriptor).</em> -<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_comment">// That is fine since the modular Jar archiver will gracefully</em> -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_comment">// handle such case.</em> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_comment">// And also such case is unlikely to happen as file ending</em> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_comment">// with "module-info.class" is unlikely to be included in Jar file</em> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_comment">// unless it is a module descriptor.</em> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">boolean</strong> containsModuleDescriptor = -<a class="jxr_linenumber" name="L252" href="#L252">252</a> Arrays.stream(includedFiles).anyMatch(p -> p.endsWith(MODULE_DESCRIPTOR_FILE_NAME)); -<a class="jxr_linenumber" name="L253" href="#L253">253</a> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> String archiverName = containsModuleDescriptor ? <span class="jxr_string">"mjar"</span> : <span class="jxr_string">"jar"</span>; -<a class="jxr_linenumber" name="L255" href="#L255">255</a> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> MavenArchiver archiver = <strong class="jxr_keyword">new</strong> MavenArchiver(); -<a class="jxr_linenumber" name="L257" href="#L257">257</a> archiver.setCreatedBy(<span class="jxr_string">"Maven JAR Plugin"</span>, <span class="jxr_string">"org.apache.maven.plugins"</span>, <span class="jxr_string">"maven-jar-plugin"</span>); -<a class="jxr_linenumber" name="L258" href="#L258">258</a> archiver.setArchiver((JarArchiver) archivers.get(archiverName)); -<a class="jxr_linenumber" name="L259" href="#L259">259</a> archiver.setOutputFile(jarFile); +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * Overload this to produce a jar with another classifier, for example a test-jar.</em> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * @return get the classifier.</em> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getClassifier(); +<a class="jxr_linenumber" name="L225" href="#L225">225</a> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * Overload this to produce a test-jar, for example.</em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * @return return the type.</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getType(); +<a class="jxr_linenumber" name="L231" href="#L231">231</a> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * Returns the Jar file to generate, based on an optional classifier.</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @param basedir the output directory</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * @param resultFinalName the name of the ear file</em> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @param classifier an optional classifier</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @return the file to generate</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">protected</strong> File getJarFile(File basedir, String resultFinalName, String classifier) { +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> (basedir == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"basedir is not allowed to be null"</span>); +<a class="jxr_linenumber" name="L243" href="#L243">243</a> } +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">if</strong> (resultFinalName == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"finalName is not allowed to be null"</span>); +<a class="jxr_linenumber" name="L246" href="#L246">246</a> } +<a class="jxr_linenumber" name="L247" href="#L247">247</a> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> String fileName = resultFinalName + (hasClassifier() ? <span class="jxr_string">"-"</span> + classifier : <span class="jxr_string">""</span>) + <span class="jxr_string">".jar"</span>; +<a class="jxr_linenumber" name="L249" href="#L249">249</a> +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File(basedir, fileName); +<a class="jxr_linenumber" name="L251" href="#L251">251</a> } +<a class="jxr_linenumber" name="L252" href="#L252">252</a> +<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * Generates the JAR.</em> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * @return The instance of File for the created archive file.</em> +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException in case of an error.</em> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">public</strong> File createArchive() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L259" href="#L259">259</a> File jarFile = getJarFile(outputDirectory, finalName, getClassifier()); <a class="jxr_linenumber" name="L260" href="#L260">260</a> -<a class="jxr_linenumber" name="L261" href="#L261">261</a> Optional.ofNullable(toolchainManager.getToolchainFromBuildContext(<span class="jxr_string">"jdk"</span>, session)) -<a class="jxr_linenumber" name="L262" href="#L262">262</a> .ifPresent(toolchain -> toolchainsJdkSpecification -<a class="jxr_linenumber" name="L263" href="#L263">263</a> .getJDKSpecification(toolchain) -<a class="jxr_linenumber" name="L264" href="#L264">264</a> .ifPresent(jdkSpec -> { -<a class="jxr_linenumber" name="L265" href="#L265">265</a> archive.addManifestEntry(<span class="jxr_string">"Build-Jdk-Spec"</span>, jdkSpec); -<a class="jxr_linenumber" name="L266" href="#L266">266</a> archive.addManifestEntry( -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <span class="jxr_string">"Build-Tool-Jdk-Spec"</span>, System.getProperty(<span class="jxr_string">"java.specification.version"</span>)); -<a class="jxr_linenumber" name="L268" href="#L268">268</a> archiver.setBuildJdkSpecDefaultEntry(false); -<a class="jxr_linenumber" name="L269" href="#L269">269</a> getLog().info(<span class="jxr_string">"Set Build-Jdk-Spec based on toolchain in maven-jar-plugin "</span> + toolchain); -<a class="jxr_linenumber" name="L270" href="#L270">270</a> })); -<a class="jxr_linenumber" name="L271" href="#L271">271</a> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_comment">// configure for Reproducible Builds based on outputTimestamp value</em> -<a class="jxr_linenumber" name="L273" href="#L273">273</a> archiver.configureReproducibleBuild(outputTimestamp); -<a class="jxr_linenumber" name="L274" href="#L274">274</a> -<a class="jxr_linenumber" name="L275" href="#L275">275</a> archive.setForced(forceCreation); -<a class="jxr_linenumber" name="L276" href="#L276">276</a> -<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L278" href="#L278">278</a> File contentDirectory = getClassesDirectory(); -<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">if</strong> (!contentDirectory.exists()) { -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">if</strong> (!forceCreation) { -<a class="jxr_linenumber" name="L281" href="#L281">281</a> getLog().warn(<span class="jxr_string">"JAR will be empty - no content was marked for inclusion!"</span>); -<a class="jxr_linenumber" name="L282" href="#L282">282</a> } -<a class="jxr_linenumber" name="L283" href="#L283">283</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L284" href="#L284">284</a> archiver.getArchiver().addDirectory(contentDirectory, getIncludes(), getExcludes()); -<a class="jxr_linenumber" name="L285" href="#L285">285</a> } +<a class="jxr_linenumber" name="L261" href="#L261">261</a> FileSetManager fileSetManager = <strong class="jxr_keyword">new</strong> FileSetManager(); +<a class="jxr_linenumber" name="L262" href="#L262">262</a> FileSet jarContentFileSet = <strong class="jxr_keyword">new</strong> FileSet(); +<a class="jxr_linenumber" name="L263" href="#L263">263</a> jarContentFileSet.setDirectory(getClassesDirectory().getAbsolutePath()); +<a class="jxr_linenumber" name="L264" href="#L264">264</a> jarContentFileSet.setIncludes(Arrays.asList(getIncludes())); +<a class="jxr_linenumber" name="L265" href="#L265">265</a> jarContentFileSet.setExcludes(Arrays.asList(getExcludes())); +<a class="jxr_linenumber" name="L266" href="#L266">266</a> +<a class="jxr_linenumber" name="L267" href="#L267">267</a> String[] includedFiles = fileSetManager.getIncludedFiles(jarContentFileSet); +<a class="jxr_linenumber" name="L268" href="#L268">268</a> +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">if</strong> (detectMultiReleaseJar +<a class="jxr_linenumber" name="L270" href="#L270">270</a> && Arrays.stream(includedFiles) +<a class="jxr_linenumber" name="L271" href="#L271">271</a> .anyMatch(p -> p.startsWith(<span class="jxr_string">"META-INF"</span> + SEPARATOR + <span class="jxr_string">"versions"</span> + SEPARATOR))) { +<a class="jxr_linenumber" name="L272" href="#L272">272</a> getLog().debug(<span class="jxr_string">"Adding 'Multi-Release: true' manifest entry."</span>); +<a class="jxr_linenumber" name="L273" href="#L273">273</a> archive.addManifestEntry(<span class="jxr_string">"Multi-Release"</span>, <span class="jxr_string">"true"</span>); +<a class="jxr_linenumber" name="L274" href="#L274">274</a> } +<a class="jxr_linenumber" name="L275" href="#L275">275</a> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_comment">// May give false positives if the files is named as module descriptor</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_comment">// but is not in the root of the archive or in the versioned area</em> +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_comment">// (and hence not actually a module descriptor).</em> +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_comment">// That is fine since the modular Jar archiver will gracefully</em> +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_comment">// handle such case.</em> +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_comment">// And also such case is unlikely to happen as file ending</em> +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_comment">// with "module-info.class" is unlikely to be included in Jar file</em> +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_comment">// unless it is a module descriptor.</em> +<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">boolean</strong> containsModuleDescriptor = +<a class="jxr_linenumber" name="L285" href="#L285">285</a> Arrays.stream(includedFiles).anyMatch(p -> p.endsWith(MODULE_DESCRIPTOR_FILE_NAME)); <a class="jxr_linenumber" name="L286" href="#L286">286</a> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> archiver.createArchive(session, project, archive); +<a class="jxr_linenumber" name="L287" href="#L287">287</a> String archiverName = containsModuleDescriptor ? <span class="jxr_string">"mjar"</span> : <span class="jxr_string">"jar"</span>; <a class="jxr_linenumber" name="L288" href="#L288">288</a> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">return</strong> jarFile; -<a class="jxr_linenumber" name="L290" href="#L290">290</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_comment">// TODO: improve error handling</em> -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Error assembling JAR"</span>, e); -<a class="jxr_linenumber" name="L293" href="#L293">293</a> } -<a class="jxr_linenumber" name="L294" href="#L294">294</a> } -<a class="jxr_linenumber" name="L295" href="#L295">295</a> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * Generates the JAR.</em> -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException in case of an error.</em> -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L300" href="#L300">300</a> @Override -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">if</strong> (useDefaultManifestFile) { -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"You are using 'useDefaultManifestFile' which has been removed"</span> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> + <span class="jxr_string">" from the maven-jar-plugin. "</span> -<a class="jxr_linenumber" name="L305" href="#L305">305</a> + <span class="jxr_string">"Please see the >>Major Version Upgrade to version 3.0.0<< on the plugin site."</span>); -<a class="jxr_linenumber" name="L306" href="#L306">306</a> } +<a class="jxr_linenumber" name="L289" href="#L289">289</a> MavenArchiver archiver = <strong class="jxr_keyword">new</strong> MavenArchiver(); +<a class="jxr_linenumber" name="L290" href="#L290">290</a> archiver.setCreatedBy(<span class="jxr_string">"Maven JAR Plugin"</span>, <span class="jxr_string">"org.apache.maven.plugins"</span>, <span class="jxr_string">"maven-jar-plugin"</span>); +<a class="jxr_linenumber" name="L291" href="#L291">291</a> archiver.setArchiver((JarArchiver) archivers.get(archiverName)); +<a class="jxr_linenumber" name="L292" href="#L292">292</a> archiver.setOutputFile(jarFile); +<a class="jxr_linenumber" name="L293" href="#L293">293</a> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> Optional.ofNullable(toolchainManager.getToolchainFromBuildContext(<span class="jxr_string">"jdk"</span>, session)) +<a class="jxr_linenumber" name="L295" href="#L295">295</a> .ifPresent(toolchain -> toolchainsJdkSpecification +<a class="jxr_linenumber" name="L296" href="#L296">296</a> .getJDKSpecification(toolchain) +<a class="jxr_linenumber" name="L297" href="#L297">297</a> .ifPresent(jdkSpec -> { +<a class="jxr_linenumber" name="L298" href="#L298">298</a> archive.addManifestEntry(<span class="jxr_string">"Build-Jdk-Spec"</span>, jdkSpec); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> archive.addManifestEntry( +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <span class="jxr_string">"Build-Tool-Jdk-Spec"</span>, System.getProperty(<span class="jxr_string">"java.specification.version"</span>)); +<a class="jxr_linenumber" name="L301" href="#L301">301</a> archiver.setBuildJdkSpecDefaultEntry(false); +<a class="jxr_linenumber" name="L302" href="#L302">302</a> getLog().info(<span class="jxr_string">"Set Build-Jdk-Spec based on toolchain in maven-jar-plugin "</span> + toolchain); +<a class="jxr_linenumber" name="L303" href="#L303">303</a> })); +<a class="jxr_linenumber" name="L304" href="#L304">304</a> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_comment">// configure for Reproducible Builds based on outputTimestamp value</em> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> archiver.configureReproducibleBuild(outputTimestamp); <a class="jxr_linenumber" name="L307" href="#L307">307</a> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">if</strong> (skipIfEmpty -<a class="jxr_linenumber" name="L309" href="#L309">309</a> && (!getClassesDirectory().exists() || getClassesDirectory().list().length < 1)) { -<a class="jxr_linenumber" name="L310" href="#L310">310</a> getLog().info(<span class="jxr_string">"Skipping packaging of the "</span> + getType()); -<a class="jxr_linenumber" name="L311" href="#L311">311</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L312" href="#L312">312</a> File jarFile = createArchive(); -<a class="jxr_linenumber" name="L313" href="#L313">313</a> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">if</strong> (hasClassifier()) { -<a class="jxr_linenumber" name="L315" href="#L315">315</a> projectHelper.attachArtifact(getProject(), getType(), getClassifier(), jarFile); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> archive.setForced(forceCreation); +<a class="jxr_linenumber" name="L309" href="#L309">309</a> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L311" href="#L311">311</a> File contentDirectory = getClassesDirectory(); +<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">if</strong> (!contentDirectory.exists()) { +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">if</strong> (!forceCreation) { +<a class="jxr_linenumber" name="L314" href="#L314">314</a> getLog().warn(<span class="jxr_string">"JAR will be empty - no content was marked for inclusion!"</span>); +<a class="jxr_linenumber" name="L315" href="#L315">315</a> } <a class="jxr_linenumber" name="L316" href="#L316">316</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">if</strong> (projectHasAlreadySetAnArtifact()) { -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"You have to use a classifier "</span> -<a class="jxr_linenumber" name="L319" href="#L319">319</a> + <span class="jxr_string">"to attach supplemental artifacts to the project instead of replacing them."</span>); -<a class="jxr_linenumber" name="L320" href="#L320">320</a> } -<a class="jxr_linenumber" name="L321" href="#L321">321</a> getProject().getArtifact().setFile(jarFile); -<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> projectHasAlreadySetAnArtifact() { -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">if</strong> (getProject().getArtifact().getFile() == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L329" href="#L329">329</a> } -<a class="jxr_linenumber" name="L330" href="#L330">330</a> -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">return</strong> getProject().getArtifact().getFile().isFile(); -<a class="jxr_linenumber" name="L332" href="#L332">332</a> } -<a class="jxr_linenumber" name="L333" href="#L333">333</a> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * Return {@code true} in case where the classifier is not {@code null} and contains something else than white spaces.</em> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * @return {@code true} if the classifier is set.</em> -<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> hasClassifier() { -<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">return</strong> getClassifier() != <strong class="jxr_keyword">null</strong> && !getClassifier().trim().isEmpty(); -<a class="jxr_linenumber" name="L341" href="#L341">341</a> } -<a class="jxr_linenumber" name="L342" href="#L342">342</a> -<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">private</strong> String[] getIncludes() { -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">if</strong> (includes != <strong class="jxr_keyword">null</strong> && includes.length > 0) { -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">return</strong> includes; -<a class="jxr_linenumber" name="L346" href="#L346">346</a> } -<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">return</strong> DEFAULT_INCLUDES; -<a class="jxr_linenumber" name="L348" href="#L348">348</a> } -<a class="jxr_linenumber" name="L349" href="#L349">349</a> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">private</strong> String[] getExcludes() { -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">if</strong> (excludes != <strong class="jxr_keyword">null</strong> && excludes.length > 0) { -<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">return</strong> excludes; -<a class="jxr_linenumber" name="L353" href="#L353">353</a> } -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">return</strong> DEFAULT_EXCLUDES; -<a class="jxr_linenumber" name="L355" href="#L355">355</a> } -<a class="jxr_linenumber" name="L356" href="#L356">356</a> } +<a class="jxr_linenumber" name="L317" href="#L317">317</a> archiver.getArchiver().addFileSet(getFileSet(contentDirectory)); +<a class="jxr_linenumber" name="L318" href="#L318">318</a> } +<a class="jxr_linenumber" name="L319" href="#L319">319</a> +<a class="jxr_linenumber" name="L320" href="#L320">320</a> archiver.createArchive(session, project, archive); +<a class="jxr_linenumber" name="L321" href="#L321">321</a> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">return</strong> jarFile; +<a class="jxr_linenumber" name="L323" href="#L323">323</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_comment">// TODO: improve error handling</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Error assembling JAR"</span>, e); +<a class="jxr_linenumber" name="L326" href="#L326">326</a> } +<a class="jxr_linenumber" name="L327" href="#L327">327</a> } +<a class="jxr_linenumber" name="L328" href="#L328">328</a> +<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"> * Generates the JAR.</em> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException in case of an error.</em> +<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L333" href="#L333">333</a> @Override +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">if</strong> (useDefaultManifestFile) { +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"You are using 'useDefaultManifestFile' which has been removed"</span> +<a class="jxr_linenumber" name="L337" href="#L337">337</a> + <span class="jxr_string">" from the maven-jar-plugin. "</span> +<a class="jxr_linenumber" name="L338" href="#L338">338</a> + <span class="jxr_string">"Please see the >>Major Version Upgrade to version 3.0.0<< on the plugin site."</span>); +<a class="jxr_linenumber" name="L339" href="#L339">339</a> } +<a class="jxr_linenumber" name="L340" href="#L340">340</a> +<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">if</strong> (skipIfEmpty +<a class="jxr_linenumber" name="L342" href="#L342">342</a> && (!getClassesDirectory().exists() || getClassesDirectory().list().length < 1)) { +<a class="jxr_linenumber" name="L343" href="#L343">343</a> getLog().info(<span class="jxr_string">"Skipping packaging of the "</span> + getType()); +<a class="jxr_linenumber" name="L344" href="#L344">344</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L345" href="#L345">345</a> File jarFile = createArchive(); +<a class="jxr_linenumber" name="L346" href="#L346">346</a> +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">if</strong> (hasClassifier()) { +<a class="jxr_linenumber" name="L348" href="#L348">348</a> projectHelper.attachArtifact(getProject(), getType(), getClassifier(), jarFile); +<a class="jxr_linenumber" name="L349" href="#L349">349</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">if</strong> (projectHasAlreadySetAnArtifact()) { +<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"You have to use a classifier "</span> +<a class="jxr_linenumber" name="L352" href="#L352">352</a> + <span class="jxr_string">"to attach supplemental artifacts to the project instead of replacing them."</span>); +<a class="jxr_linenumber" name="L353" href="#L353">353</a> } +<a class="jxr_linenumber" name="L354" href="#L354">354</a> getProject().getArtifact().setFile(jarFile); +<a class="jxr_linenumber" name="L355" href="#L355">355</a> } +<a class="jxr_linenumber" name="L356" href="#L356">356</a> } +<a class="jxr_linenumber" name="L357" href="#L357">357</a> } +<a class="jxr_linenumber" name="L358" href="#L358">358</a> +<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> projectHasAlreadySetAnArtifact() { +<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">if</strong> (getProject().getArtifact().getFile() == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L362" href="#L362">362</a> } +<a class="jxr_linenumber" name="L363" href="#L363">363</a> +<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">return</strong> getProject().getArtifact().getFile().isFile(); +<a class="jxr_linenumber" name="L365" href="#L365">365</a> } +<a class="jxr_linenumber" name="L366" href="#L366">366</a> +<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * Return {@code true} in case where the classifier is not {@code null} and contains something else than white spaces.</em> +<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * @return {@code true} if the classifier is set.</em> +<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> hasClassifier() { +<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">return</strong> getClassifier() != <strong class="jxr_keyword">null</strong> && !getClassifier().trim().isEmpty(); +<a class="jxr_linenumber" name="L374" href="#L374">374</a> } +<a class="jxr_linenumber" name="L375" href="#L375">375</a> +<a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">private</strong> String[] getIncludes() { +<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">if</strong> (includes != <strong class="jxr_keyword">null</strong> && includes.length > 0) { +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">return</strong> includes; +<a class="jxr_linenumber" name="L379" href="#L379">379</a> } +<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">return</strong> DEFAULT_INCLUDES; +<a class="jxr_linenumber" name="L381" href="#L381">381</a> } +<a class="jxr_linenumber" name="L382" href="#L382">382</a> +<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">private</strong> String[] getExcludes() { +<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">if</strong> (excludes != <strong class="jxr_keyword">null</strong> && excludes.length > 0) { +<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">return</strong> excludes; +<a class="jxr_linenumber" name="L386" href="#L386">386</a> } +<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong class="jxr_keyword">return</strong> DEFAULT_EXCLUDES; +<a class="jxr_linenumber" name="L388" href="#L388">388</a> } +<a class="jxr_linenumber" name="L389" href="#L389">389</a> +<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">private</strong> org.codehaus.plexus.archiver.FileSet getFileSet(File contentDirectory) { +<a class="jxr_linenumber" name="L391" href="#L391">391</a> DefaultFileSet fileSet = DefaultFileSet.fileSet(contentDirectory) +<a class="jxr_linenumber" name="L392" href="#L392">392</a> .prefixed(<span class="jxr_string">""</span>) +<a class="jxr_linenumber" name="L393" href="#L393">393</a> .includeExclude(getIncludes(), getExcludes()) +<a class="jxr_linenumber" name="L394" href="#L394">394</a> .includeEmptyDirs(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L395" href="#L395">395</a> +<a class="jxr_linenumber" name="L396" href="#L396">396</a> fileSet.setUsingDefaultExcludes(addDefaultExcludes);
[... 7 lines stripped ...]
