Modified:
maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-plugin/xref/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.html
==============================================================================
---
maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-plugin/xref/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.html
(original)
+++
maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-plugin/xref/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.html
Sat Mar 30 02:00:43 2024
@@ -37,26 +37,26 @@
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.artifact.resolver.filter.ArtifactFilter;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.artifact.resolver.filter.IncludesArtifactFilter;
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.MojoExecutionException;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.descriptor.PluginDescriptor;
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Component;
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.LifecyclePhase;
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Parameter;
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.ResolutionScope;
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.settings.Settings;
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.DefaultPluginToolsRequest;
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.ExtendedPluginDescriptor;
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.PluginToolsRequest;
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.extractor.ExtractionException;
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.generator.GeneratorException;
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.generator.GeneratorUtils;
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.generator.PluginDescriptorFilesGenerator;
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.scanner.MojoScanner;
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong
class="jxr_keyword">import</strong>
org.codehaus.plexus.component.repository.ComponentDependency;
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong
class="jxr_keyword">import</strong> org.eclipse.aether.RepositorySystemSession;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.MojoExecutionException;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.descriptor.PluginDescriptor;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Component;
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.LifecyclePhase;
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Parameter;
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.ResolutionScope;
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.settings.Settings;
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.DefaultPluginToolsRequest;
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.ExtendedPluginDescriptor;
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.PluginToolsRequest;
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.extractor.ExtractionException;
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.generator.GeneratorException;
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.generator.GeneratorUtils;
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.generator.PluginDescriptorFilesGenerator;
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.tools.plugin.scanner.MojoScanner;
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong
class="jxr_keyword">import</strong>
org.codehaus.plexus.component.repository.ComponentDependency;
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong
class="jxr_keyword">import</strong>
org.sonatype.plexus.build.incremental.BuildContext;
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em
class="jxr_javadoccomment">/**</em>
@@ -234,241 +234,242 @@
<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"> * @since 3.7.0</em>
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L229" href="#L229">229</a>
@Parameter(defaultValue = <span class="jxr_string">"${settings}"</span>,
readonly = <strong class="jxr_keyword">true</strong>, required = <strong
class="jxr_keyword">true</strong>)
+<a class="jxr_linenumber" name="L229" href="#L229">229</a> @Component
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong
class="jxr_keyword">private</strong> Settings settings;
<a class="jxr_linenumber" name="L231" href="#L231">231</a>
-<a class="jxr_linenumber" name="L232" href="#L232">232</a>
@Parameter(defaultValue = <span
class="jxr_string">"${repositorySystemSession}"</span>, readonly = <strong
class="jxr_keyword">true</strong>, required = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong
class="jxr_keyword">private</strong> RepositorySystemSession repoSession;
-<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"> * The required Java version to set in the
plugin descriptor. This is evaluated by Maven 4 and ignored by earlier</em>
-<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em
class="jxr_javadoccomment"> * Maven versions. Can be either one of the
following formats:</em>
-<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em
class="jxr_javadoccomment"> * <ul></em>
-<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em
class="jxr_javadoccomment"> * <li>A version range which specifies the
supported Java versions. It can either use the usual mathematical</em>
-<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> * syntax like {@code "[1.7,9),[11,)"} or use a
single version like {@code "1.8"}. The latter is a short</em>
-<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> * form for {@code "[1.8,)"}, i.e. denotes the
minimum version required.</li></em>
-<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> * <li>{@code "auto"} to determine the
minimum Java version from the binary class version being generated during</em>
-<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em
class="jxr_javadoccomment"> * compilation (determined by the
extractor).</li></em>
-<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em
class="jxr_javadoccomment"> * </ul></em>
-<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em
class="jxr_javadoccomment"> * @since 3.8.0</em>
-<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L248" href="#L248">248</a>
@Parameter(defaultValue = VALUE_AUTO)
-<a class="jxr_linenumber" name="L249" href="#L249">249</a> String
requiredJavaVersion;
-<a class="jxr_linenumber" name="L250" href="#L250">250</a>
-<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em
class="jxr_javadoccomment"> * The required Maven version to set in the
plugin descriptor. This is evaluated by Maven 4 and ignored by earlier</em>
-<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em
class="jxr_javadoccomment"> * Maven versions. Can be either one of the
following formats:</em>
-<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em
class="jxr_javadoccomment"> * <ul></em>
-<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em
class="jxr_javadoccomment"> * <li>A version range which specifies the
supported Maven versions. It can either use the usual mathematical</em>
-<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em
class="jxr_javadoccomment"> * syntax like {@code "[2.0.10,2.1.0),[3.0,)"}
or use a single version like {@code "2.2.1"}. The latter is a short</em>
-<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_javadoccomment"> * form for {@code "[2.2.1,)"}, i.e. denotes the
minimum version required.</li></em>
-<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em
class="jxr_javadoccomment"> * <li>{@code "auto"} to determine the
minimum Maven version from the POM's Maven prerequisite, or if not set the</em>
-<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em
class="jxr_javadoccomment"> * referenced Maven Plugin API
version.</li></em>
-<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em
class="jxr_javadoccomment"> * </ul></em>
-<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em
class="jxr_javadoccomment"> * This value takes precedence over the</em>
-<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em
class="jxr_javadoccomment"> * <a href="<a
href="https://maven.apache.org/pom.html";
target="alexandria_uri">https://maven.apache.org/pom.html</a>#Prerequisites">POM's
Maven prerequisite</a> in Maven 4.</em>
-<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em
class="jxr_javadoccomment"> * @since 3.8.0</em>
-<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L267" href="#L267">267</a>
@Parameter(defaultValue = VALUE_AUTO)
-<a class="jxr_linenumber" name="L268" href="#L268">268</a> String
requiredMavenVersion;
-<a class="jxr_linenumber" name="L269" href="#L269">269</a>
-<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em
class="jxr_javadoccomment"> * The component used for scanning the source
tree for mojos.</em>
-<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L273" href="#L273">273</a> @Component
-<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong
class="jxr_keyword">private</strong> MojoScanner mojoScanner;
-<a class="jxr_linenumber" name="L275" href="#L275">275</a>
-<a class="jxr_linenumber" name="L276" href="#L276">276</a> @Component
-<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong
class="jxr_keyword">protected</strong> BuildContext buildContext;
-<a class="jxr_linenumber" name="L278" href="#L278">278</a>
-<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
generate() <strong class="jxr_keyword">throws</strong> MojoExecutionException {
-<a class="jxr_linenumber" name="L280" href="#L280">280</a>
-<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong
class="jxr_keyword">if</strong> (!<span
class="jxr_string">"maven-plugin"</span>.equalsIgnoreCase(project.getArtifactId())
-<a class="jxr_linenumber" name="L282" href="#L282">282</a>
&& project.getArtifactId().toLowerCase().startsWith(<span
class="jxr_string">"maven-"</span>)
-<a class="jxr_linenumber" name="L283" href="#L283">283</a>
&& project.getArtifactId().toLowerCase().endsWith(<span
class="jxr_string">"-plugin"</span>)
-<a class="jxr_linenumber" name="L284" href="#L284">284</a>
&& !<span
class="jxr_string">"org.apache.maven.plugins"</span>.equals(project.getGroupId()))
{
-<a class="jxr_linenumber" name="L285" href="#L285">285</a>
getLog().warn(LS + LS + <span class="jxr_string">"Artifact Ids of the format
maven-___-plugin are reserved for"</span> + LS
-<a class="jxr_linenumber" name="L286" href="#L286">286</a>
+ <span class="jxr_string">"plugins in the Group Id
org.apache.maven.plugins"</span> + LS
-<a class="jxr_linenumber" name="L287" href="#L287">287</a>
+ <span class="jxr_string">"Please change your artifactId to the format
___-maven-plugin"</span> + LS
-<a class="jxr_linenumber" name="L288" href="#L288">288</a>
+ <span class="jxr_string">"In the future this error will break the
build."</span> + LS + LS);
-<a class="jxr_linenumber" name="L289" href="#L289">289</a> }
-<a class="jxr_linenumber" name="L290" href="#L290">290</a>
-<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong
class="jxr_keyword">if</strong> (skipDescriptor) {
-<a class="jxr_linenumber" name="L292" href="#L292">292</a>
getLog().warn(<span class="jxr_string">"Execution skipped"</span>);
-<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong
class="jxr_keyword">return</strong>;
-<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> <strong
class="jxr_keyword">if</strong> (checkExpectedProvidedScope) {
-<a class="jxr_linenumber" name="L297" href="#L297">297</a>
Set<Artifact> wrongScopedArtifacts = dependenciesNotInProvidedScope();
-<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong
class="jxr_keyword">if</strong> (!wrongScopedArtifacts.isEmpty()) {
-<a class="jxr_linenumber" name="L299" href="#L299">299</a>
StringBuilder message = <strong class="jxr_keyword">new</strong> StringBuilder(
-<a class="jxr_linenumber" name="L300" href="#L300">300</a>
LS + LS + <span class="jxr_string">"Some dependencies of Maven Plugins are
expected to be in provided scope."</span> + LS
-<a class="jxr_linenumber" name="L301" href="#L301">301</a>
+ <span class="jxr_string">"Please make sure that dependencies
listed below declared in POM"</span> + LS
-<a class="jxr_linenumber" name="L302" href="#L302">302</a>
+ <span class="jxr_string">"have set
'<scope>provided</scope>' as well."</span> + LS + LS
-<a class="jxr_linenumber" name="L303" href="#L303">303</a>
+ <span class="jxr_string">"The following dependencies are in wrong
scope:"</span> + LS);
-<a class="jxr_linenumber" name="L304" href="#L304">304</a>
<strong class="jxr_keyword">for</strong> (Artifact artifact :
wrongScopedArtifacts) {
-<a class="jxr_linenumber" name="L305" href="#L305">305</a>
message.append(<span class="jxr_string">" *
"</span>).append(artifact).append(LS);
-<a class="jxr_linenumber" name="L306" href="#L306">306</a> }
-<a class="jxr_linenumber" name="L307" href="#L307">307</a>
message.append(LS).append(LS);
-<a class="jxr_linenumber" name="L308" href="#L308">308</a>
-<a class="jxr_linenumber" name="L309" href="#L309">309</a>
getLog().warn(message.toString());
-<a class="jxr_linenumber" name="L310" href="#L310">310</a> }
-<a class="jxr_linenumber" name="L311" href="#L311">311</a> }
-<a class="jxr_linenumber" name="L312" href="#L312">312</a>
-<a class="jxr_linenumber" name="L313" href="#L313">313</a>
mojoScanner.setActiveExtractors(extractors);
-<a class="jxr_linenumber" name="L314" href="#L314">314</a>
-<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em
class="jxr_comment">// TODO: could use this more, eg in the writing of the
plugin descriptor!</em>
-<a class="jxr_linenumber" name="L316" href="#L316">316</a>
PluginDescriptor pluginDescriptor = <strong class="jxr_keyword">new</strong>
PluginDescriptor();
-<a class="jxr_linenumber" name="L317" href="#L317">317</a>
-<a class="jxr_linenumber" name="L318" href="#L318">318</a>
pluginDescriptor.setGroupId(project.getGroupId());
-<a class="jxr_linenumber" name="L319" href="#L319">319</a>
-<a class="jxr_linenumber" name="L320" href="#L320">320</a>
pluginDescriptor.setArtifactId(project.getArtifactId());
-<a class="jxr_linenumber" name="L321" href="#L321">321</a>
-<a class="jxr_linenumber" name="L322" href="#L322">322</a>
pluginDescriptor.setVersion(project.getVersion());
-<a class="jxr_linenumber" name="L323" href="#L323">323</a>
-<a class="jxr_linenumber" name="L324" href="#L324">324</a>
pluginDescriptor.setGoalPrefix(goalPrefix);
-<a class="jxr_linenumber" name="L325" href="#L325">325</a>
-<a class="jxr_linenumber" name="L326" href="#L326">326</a>
pluginDescriptor.setName(project.getName());
-<a class="jxr_linenumber" name="L327" href="#L327">327</a>
-<a class="jxr_linenumber" name="L328" href="#L328">328</a>
pluginDescriptor.setDescription(project.getDescription());
-<a class="jxr_linenumber" name="L329" href="#L329">329</a>
-<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong
class="jxr_keyword">if</strong> (encoding == <strong
class="jxr_keyword">null</strong> || encoding.length() < 1) {
-<a class="jxr_linenumber" name="L331" href="#L331">331</a>
getLog().warn(<span class="jxr_string">"Using platform encoding ("</span> +
ReaderFactory.FILE_ENCODING
-<a class="jxr_linenumber" name="L332" href="#L332">332</a>
+ <span class="jxr_string">" actually) to read mojo source files, i.e. build is
platform dependent!"</span>);
-<a class="jxr_linenumber" name="L333" href="#L333">333</a> } <strong
class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L334" href="#L334">334</a>
getLog().info(<span class="jxr_string">"Using '"</span> + encoding + <span
class="jxr_string">"' encoding to read mojo source files."</span>);
-<a class="jxr_linenumber" name="L335" href="#L335">335</a> }
-<a class="jxr_linenumber" name="L336" href="#L336">336</a>
-<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong
class="jxr_keyword">if</strong> (internalJavadocBaseUrl != <strong
class="jxr_keyword">null</strong> &&
!internalJavadocBaseUrl.getPath().endsWith(<span
class="jxr_string">"/"</span>)) {
-<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(<span class="jxr_string">"Given parameter
'internalJavadocBaseUrl' must end with a slash but is '"</span>
-<a class="jxr_linenumber" name="L339" href="#L339">339</a>
+ internalJavadocBaseUrl + <span class="jxr_string">"'"</span>);
-<a class="jxr_linenumber" name="L340" href="#L340">340</a> }
-<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong
class="jxr_keyword">try</strong> {
-<a class="jxr_linenumber" name="L342" href="#L342">342</a>
List<ComponentDependency> deps =
GeneratorUtils.toComponentDependencies(project.getArtifacts());
-<a class="jxr_linenumber" name="L343" href="#L343">343</a>
pluginDescriptor.setDependencies(deps);
-<a class="jxr_linenumber" name="L344" href="#L344">344</a>
-<a class="jxr_linenumber" name="L345" href="#L345">345</a>
PluginToolsRequest request = <strong class="jxr_keyword">new</strong>
DefaultPluginToolsRequest(project, pluginDescriptor);
-<a class="jxr_linenumber" name="L346" href="#L346">346</a>
request.setEncoding(encoding);
-<a class="jxr_linenumber" name="L347" href="#L347">347</a>
request.setSkipErrorNoDescriptorsFound(skipErrorNoDescriptorsFound);
-<a class="jxr_linenumber" name="L348" href="#L348">348</a>
request.setDependencies(filterMojoDependencies());
-<a class="jxr_linenumber" name="L349" href="#L349">349</a>
request.setRepoSession(repoSession);
-<a class="jxr_linenumber" name="L350" href="#L350">350</a>
request.setInternalJavadocBaseUrl(internalJavadocBaseUrl);
-<a class="jxr_linenumber" name="L351" href="#L351">351</a>
request.setInternalJavadocVersion(internalJavadocVersion);
-<a class="jxr_linenumber" name="L352" href="#L352">352</a>
request.setExternalJavadocBaseUrls(externalJavadocBaseUrls);
-<a class="jxr_linenumber" name="L353" href="#L353">353</a>
request.setSettings(settings);
-<a class="jxr_linenumber" name="L354" href="#L354">354</a>
-<a class="jxr_linenumber" name="L355" href="#L355">355</a>
mojoScanner.populatePluginDescriptor(request);
-<a class="jxr_linenumber" name="L356" href="#L356">356</a>
request.setPluginDescriptor(extendPluginDescriptor(request));
-<a class="jxr_linenumber" name="L357" href="#L357">357</a>
-<a class="jxr_linenumber" name="L358" href="#L358">358</a>
outputDirectory.mkdirs();
-<a class="jxr_linenumber" name="L359" href="#L359">359</a>
-<a class="jxr_linenumber" name="L360" href="#L360">360</a>
PluginDescriptorFilesGenerator pluginDescriptorGenerator = <strong
class="jxr_keyword">new</strong> PluginDescriptorFilesGenerator();
-<a class="jxr_linenumber" name="L361" href="#L361">361</a>
pluginDescriptorGenerator.execute(outputDirectory, request);
-<a class="jxr_linenumber" name="L362" href="#L362">362</a>
-<a class="jxr_linenumber" name="L363" href="#L363">363</a>
buildContext.refresh(outputDirectory);
-<a class="jxr_linenumber" name="L364" href="#L364">364</a> } <strong
class="jxr_keyword">catch</strong> (GeneratorException e) {
-<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(<span class="jxr_string">"Error writing plugin
descriptor"</span>, e);
-<a class="jxr_linenumber" name="L366" href="#L366">366</a> } <strong
class="jxr_keyword">catch</strong> (InvalidPluginDescriptorException |
ExtractionException e) {
-<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(
-<a class="jxr_linenumber" name="L368" href="#L368">368</a>
<span class="jxr_string">"Error extracting plugin descriptor: '"</span> +
e.getLocalizedMessage() + <span class="jxr_string">"'"</span>, e);
-<a class="jxr_linenumber" name="L369" href="#L369">369</a> } <strong
class="jxr_keyword">catch</strong> (LinkageError e) {
-<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(
-<a class="jxr_linenumber" name="L371" href="#L371">371</a>
<span class="jxr_string">"The API of the mojo scanner is not compatible with
this plugin version."</span>
-<a class="jxr_linenumber" name="L372" href="#L372">372</a>
+ <span class="jxr_string">" Please check the plugin dependencies
configured"</span>
-<a class="jxr_linenumber" name="L373" href="#L373">373</a>
+ <span class="jxr_string">" in the POM and ensure the versions
match."</span>,
-<a class="jxr_linenumber" name="L374" href="#L374">374</a>
e);
-<a class="jxr_linenumber" name="L375" href="#L375">375</a> }
-<a class="jxr_linenumber" name="L376" href="#L376">376</a> }
-<a class="jxr_linenumber" name="L377" href="#L377">377</a>
-<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong
class="jxr_keyword">private</strong> PluginDescriptor
extendPluginDescriptor(PluginToolsRequest request) {
-<a class="jxr_linenumber" name="L379" href="#L379">379</a>
ExtendedPluginDescriptor extendedPluginDescriptor = <strong
class="jxr_keyword">new</strong>
ExtendedPluginDescriptor(request.getPluginDescriptor());
-<a class="jxr_linenumber" name="L380" href="#L380">380</a>
extendedPluginDescriptor.setRequiredJavaVersion(getRequiredJavaVersion(request));
-<a class="jxr_linenumber" name="L381" href="#L381">381</a>
extendedPluginDescriptor.setRequiredMavenVersion(getRequiredMavenVersion(request));
-<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong
class="jxr_keyword">return</strong> extendedPluginDescriptor;
-<a class="jxr_linenumber" name="L383" href="#L383">383</a> }
-<a class="jxr_linenumber" name="L384" href="#L384">384</a>
-<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong
class="jxr_keyword">private</strong> String
getRequiredMavenVersion(PluginToolsRequest request) {
-<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong
class="jxr_keyword">if</strong> (!VALUE_AUTO.equals(requiredMavenVersion)) {
-<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong
class="jxr_keyword">return</strong> requiredMavenVersion;
-<a class="jxr_linenumber" name="L388" href="#L388">388</a> }
-<a class="jxr_linenumber" name="L389" href="#L389">389</a>
getLog().debug(<span class="jxr_string">"Trying to derive Maven version
automatically from project prerequisites..."</span>);
-<a class="jxr_linenumber" name="L390" href="#L390">390</a> String
requiredMavenVersion =
-<a class="jxr_linenumber" name="L391" href="#L391">391</a>
project.getPrerequisites() != <strong class="jxr_keyword">null</strong> ?
project.getPrerequisites().getMaven() : <strong
class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong
class="jxr_keyword">if</strong> (requiredMavenVersion == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L393" href="#L393">393</a>
getLog().debug(<span class="jxr_string">"Trying to derive Maven version
automatically from referenced Maven Plugin API artifact "</span>
-<a class="jxr_linenumber" name="L394" href="#L394">394</a>
+ <span class="jxr_string">"version..."</span>);
-<a class="jxr_linenumber" name="L395" href="#L395">395</a>
requiredMavenVersion = request.getUsedMavenApiVersion();
-<a class="jxr_linenumber" name="L396" href="#L396">396</a> }
-<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong
class="jxr_keyword">if</strong> (requiredMavenVersion == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L398" href="#L398">398</a>
getLog().warn(<span class="jxr_string">"Cannot determine the required Maven
version automatically, it is recommended to "</span>
-<a class="jxr_linenumber" name="L399" href="#L399">399</a>
+ <span class="jxr_string">"configure some explicit value manually."</span>);
-<a class="jxr_linenumber" name="L400" href="#L400">400</a> }
-<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong
class="jxr_keyword">return</strong> requiredMavenVersion;
-<a class="jxr_linenumber" name="L402" href="#L402">402</a> }
-<a class="jxr_linenumber" name="L403" href="#L403">403</a>
-<a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong
class="jxr_keyword">private</strong> String
getRequiredJavaVersion(PluginToolsRequest request) {
-<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong
class="jxr_keyword">if</strong> (!VALUE_AUTO.equals(requiredJavaVersion)) {
-<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong
class="jxr_keyword">return</strong> requiredJavaVersion;
-<a class="jxr_linenumber" name="L407" href="#L407">407</a> }
-<a class="jxr_linenumber" name="L408" href="#L408">408</a> String
minRequiredJavaVersion = request.getRequiredJavaVersion();
-<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong
class="jxr_keyword">if</strong> (minRequiredJavaVersion == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L410" href="#L410">410</a>
getLog().warn(<span class="jxr_string">"Cannot determine the minimally required
Java version automatically, it is recommended to "</span>
-<a class="jxr_linenumber" name="L411" href="#L411">411</a>
+ <span class="jxr_string">"configure some explicit value manually."</span>);
-<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L413" href="#L413">413</a> }
-<a class="jxr_linenumber" name="L414" href="#L414">414</a>
-<a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong
class="jxr_keyword">return</strong> minRequiredJavaVersion;
-<a class="jxr_linenumber" name="L416" href="#L416">416</a> }
-<a class="jxr_linenumber" name="L417" href="#L417">417</a>
-<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em
class="jxr_javadoccomment"> * Collects all dependencies expected to be in
"provided" scope but are NOT in "provided" scope.</em>
-<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong
class="jxr_keyword">private</strong> Set<Artifact>
dependenciesNotInProvidedScope() {
-<a class="jxr_linenumber" name="L422" href="#L422">422</a>
LinkedHashSet<Artifact> wrongScopedDependencies = <strong
class="jxr_keyword">new</strong> LinkedHashSet<>();
-<a class="jxr_linenumber" name="L423" href="#L423">423</a>
-<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong
class="jxr_keyword">for</strong> (Artifact dependency : project.getArtifacts())
{
-<a class="jxr_linenumber" name="L425" href="#L425">425</a> String
ga = dependency.getGroupId() + <span class="jxr_string">":"</span> +
dependency.getArtifactId();
-<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong
class="jxr_keyword">if</strong>
(expectedProvidedScopeGroupIds.contains(dependency.getGroupId())
-<a class="jxr_linenumber" name="L427" href="#L427">427</a>
&& !expectedProvidedScopeExclusions.contains(ga)
-<a class="jxr_linenumber" name="L428" href="#L428">428</a>
&& !Artifact.SCOPE_PROVIDED.equals(dependency.getScope())) {
-<a class="jxr_linenumber" name="L429" href="#L429">429</a>
wrongScopedDependencies.add(dependency);
-<a class="jxr_linenumber" name="L430" href="#L430">430</a> }
-<a class="jxr_linenumber" name="L431" href="#L431">431</a> }
-<a class="jxr_linenumber" name="L432" href="#L432">432</a>
-<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong
class="jxr_keyword">return</strong> wrongScopedDependencies;
-<a class="jxr_linenumber" name="L434" href="#L434">434</a> }
-<a class="jxr_linenumber" name="L435" href="#L435">435</a>
-<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em
class="jxr_javadoccomment"> * Get dependencies filtered with
mojoDependencies configuration.</em>
-<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em
class="jxr_javadoccomment"> * @return eventually filtered dependencies, or
even <code>null</code> if configured with empty
mojoDependencies</em>
-<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em
class="jxr_javadoccomment"> * list</em>
-<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em
class="jxr_javadoccomment"> * @see #mojoDependencies</em>
-<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong
class="jxr_keyword">private</strong> Set<Artifact>
filterMojoDependencies() {
-<a class="jxr_linenumber" name="L444" href="#L444">444</a>
Set<Artifact> filteredArtifacts;
-<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong
class="jxr_keyword">if</strong> (mojoDependencies == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L446" href="#L446">446</a>
filteredArtifacts = <strong class="jxr_keyword">new</strong>
LinkedHashSet<>(project.getArtifacts());
-<a class="jxr_linenumber" name="L447" href="#L447">447</a> } <strong
class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>
(mojoDependencies.isEmpty()) {
-<a class="jxr_linenumber" name="L448" href="#L448">448</a>
filteredArtifacts = <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L449" href="#L449">449</a> } <strong
class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L450" href="#L450">450</a>
filteredArtifacts = <strong class="jxr_keyword">new</strong>
LinkedHashSet<>();
-<a class="jxr_linenumber" name="L451" href="#L451">451</a>
-<a class="jxr_linenumber" name="L452" href="#L452">452</a>
ArtifactFilter filter = <strong class="jxr_keyword">new</strong>
IncludesArtifactFilter(mojoDependencies);
-<a class="jxr_linenumber" name="L453" href="#L453">453</a>
-<a class="jxr_linenumber" name="L454" href="#L454">454</a> <strong
class="jxr_keyword">for</strong> (Artifact artifact : project.getArtifacts()) {
-<a class="jxr_linenumber" name="L455" href="#L455">455</a>
<strong class="jxr_keyword">if</strong> (filter.include(artifact)) {
-<a class="jxr_linenumber" name="L456" href="#L456">456</a>
filteredArtifacts.add(artifact);
-<a class="jxr_linenumber" name="L457" href="#L457">457</a> }
-<a class="jxr_linenumber" name="L458" href="#L458">458</a> }
-<a class="jxr_linenumber" name="L459" href="#L459">459</a> }
-<a class="jxr_linenumber" name="L460" href="#L460">460</a>
-<a class="jxr_linenumber" name="L461" href="#L461">461</a> <strong
class="jxr_keyword">return</strong> filteredArtifacts;
-<a class="jxr_linenumber" name="L462" href="#L462">462</a> }
-<a class="jxr_linenumber" name="L463" href="#L463">463</a> }
+<a class="jxr_linenumber" name="L232" href="#L232">232</a> @Component
+<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong
class="jxr_keyword">private</strong> MavenSession mavenSession;
+<a class="jxr_linenumber" name="L234" href="#L234">234</a>
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em
class="jxr_javadoccomment"> * The required Java version to set in the
plugin descriptor. This is evaluated by Maven 4 and ignored by earlier</em>
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em
class="jxr_javadoccomment"> * Maven versions. Can be either one of the
following formats:</em>
+<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em
class="jxr_javadoccomment"> * <ul></em>
+<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> * <li>A version range which specifies the
supported Java versions. It can either use the usual mathematical</em>
+<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> * syntax like {@code "[1.7,9),[11,)"} or use a
single version like {@code "1.8"}. The latter is a short</em>
+<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> * form for {@code "[1.8,)"}, i.e. denotes the
minimum version required.</li></em>
+<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em
class="jxr_javadoccomment"> * <li>{@code "auto"} to determine the
minimum Java version from the binary class version being generated during</em>
+<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em
class="jxr_javadoccomment"> * compilation (determined by the
extractor).</li></em>
+<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em
class="jxr_javadoccomment"> * </ul></em>
+<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em
class="jxr_javadoccomment"> * @since 3.8.0</em>
+<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L249" href="#L249">249</a>
@Parameter(defaultValue = VALUE_AUTO)
+<a class="jxr_linenumber" name="L250" href="#L250">250</a> String
requiredJavaVersion;
+<a class="jxr_linenumber" name="L251" href="#L251">251</a>
+<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em
class="jxr_javadoccomment"> * The required Maven version to set in the
plugin descriptor. This is evaluated by Maven 4 and ignored by earlier</em>
+<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em
class="jxr_javadoccomment"> * Maven versions. Can be either one of the
following formats:</em>
+<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em
class="jxr_javadoccomment"> * <ul></em>
+<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em
class="jxr_javadoccomment"> * <li>A version range which specifies the
supported Maven versions. It can either use the usual mathematical</em>
+<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_javadoccomment"> * syntax like {@code "[2.0.10,2.1.0),[3.0,)"}
or use a single version like {@code "2.2.1"}. The latter is a short</em>
+<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em
class="jxr_javadoccomment"> * form for {@code "[2.2.1,)"}, i.e. denotes the
minimum version required.</li></em>
+<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em
class="jxr_javadoccomment"> * <li>{@code "auto"} to determine the
minimum Maven version from the POM's Maven prerequisite, or if not set the</em>
+<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em
class="jxr_javadoccomment"> * referenced Maven Plugin API
version.</li></em>
+<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em
class="jxr_javadoccomment"> * </ul></em>
+<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em
class="jxr_javadoccomment"> * This value takes precedence over the</em>
+<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em
class="jxr_javadoccomment"> * <a href="<a
href="https://maven.apache.org/pom.html";
target="alexandria_uri">https://maven.apache.org/pom.html</a>#Prerequisites">POM's
Maven prerequisite</a> in Maven 4.</em>
+<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em
class="jxr_javadoccomment"> * @since 3.8.0</em>
+<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L268" href="#L268">268</a>
@Parameter(defaultValue = VALUE_AUTO)
+<a class="jxr_linenumber" name="L269" href="#L269">269</a> String
requiredMavenVersion;
+<a class="jxr_linenumber" name="L270" href="#L270">270</a>
+<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em
class="jxr_javadoccomment"> * The component used for scanning the source
tree for mojos.</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> @Component
+<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong
class="jxr_keyword">private</strong> MojoScanner mojoScanner;
+<a class="jxr_linenumber" name="L276" href="#L276">276</a>
+<a class="jxr_linenumber" name="L277" href="#L277">277</a> @Component
+<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong
class="jxr_keyword">protected</strong> BuildContext buildContext;
+<a class="jxr_linenumber" name="L279" href="#L279">279</a>
+<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
generate() <strong class="jxr_keyword">throws</strong> MojoExecutionException {
+<a class="jxr_linenumber" name="L281" href="#L281">281</a>
+<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong
class="jxr_keyword">if</strong> (!<span
class="jxr_string">"maven-plugin"</span>.equalsIgnoreCase(project.getArtifactId())
+<a class="jxr_linenumber" name="L283" href="#L283">283</a>
&& project.getArtifactId().toLowerCase().startsWith(<span
class="jxr_string">"maven-"</span>)
+<a class="jxr_linenumber" name="L284" href="#L284">284</a>
&& project.getArtifactId().toLowerCase().endsWith(<span
class="jxr_string">"-plugin"</span>)
+<a class="jxr_linenumber" name="L285" href="#L285">285</a>
&& !<span
class="jxr_string">"org.apache.maven.plugins"</span>.equals(project.getGroupId()))
{
+<a class="jxr_linenumber" name="L286" href="#L286">286</a>
getLog().warn(LS + LS + <span class="jxr_string">"Artifact Ids of the format
maven-___-plugin are reserved for"</span> + LS
+<a class="jxr_linenumber" name="L287" href="#L287">287</a>
+ <span class="jxr_string">"plugins in the Group Id
org.apache.maven.plugins"</span> + LS
+<a class="jxr_linenumber" name="L288" href="#L288">288</a>
+ <span class="jxr_string">"Please change your artifactId to the format
___-maven-plugin"</span> + LS
+<a class="jxr_linenumber" name="L289" href="#L289">289</a>
+ <span class="jxr_string">"In the future this error will break the
build."</span> + LS + LS);
+<a class="jxr_linenumber" name="L290" href="#L290">290</a> }
+<a class="jxr_linenumber" name="L291" href="#L291">291</a>
+<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong
class="jxr_keyword">if</strong> (skipDescriptor) {
+<a class="jxr_linenumber" name="L293" href="#L293">293</a>
getLog().warn(<span class="jxr_string">"Execution skipped"</span>);
+<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong
class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="L295" href="#L295">295</a> }
+<a class="jxr_linenumber" name="L296" href="#L296">296</a>
+<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong
class="jxr_keyword">if</strong> (checkExpectedProvidedScope) {
+<a class="jxr_linenumber" name="L298" href="#L298">298</a>
Set<Artifact> wrongScopedArtifacts = dependenciesNotInProvidedScope();
+<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong
class="jxr_keyword">if</strong> (!wrongScopedArtifacts.isEmpty()) {
+<a class="jxr_linenumber" name="L300" href="#L300">300</a>
StringBuilder message = <strong class="jxr_keyword">new</strong> StringBuilder(
+<a class="jxr_linenumber" name="L301" href="#L301">301</a>
LS + LS + <span class="jxr_string">"Some dependencies of Maven Plugins are
expected to be in provided scope."</span> + LS
+<a class="jxr_linenumber" name="L302" href="#L302">302</a>
+ <span class="jxr_string">"Please make sure that dependencies
listed below declared in POM"</span> + LS
+<a class="jxr_linenumber" name="L303" href="#L303">303</a>
+ <span class="jxr_string">"have set
'<scope>provided</scope>' as well."</span> + LS + LS
+<a class="jxr_linenumber" name="L304" href="#L304">304</a>
+ <span class="jxr_string">"The following dependencies are in wrong
scope:"</span> + LS);
+<a class="jxr_linenumber" name="L305" href="#L305">305</a>
<strong class="jxr_keyword">for</strong> (Artifact artifact :
wrongScopedArtifacts) {
+<a class="jxr_linenumber" name="L306" href="#L306">306</a>
message.append(<span class="jxr_string">" *
"</span>).append(artifact).append(LS);
+<a class="jxr_linenumber" name="L307" href="#L307">307</a> }
+<a class="jxr_linenumber" name="L308" href="#L308">308</a>
message.append(LS).append(LS);
+<a class="jxr_linenumber" name="L309" href="#L309">309</a>
+<a class="jxr_linenumber" name="L310" href="#L310">310</a>
getLog().warn(message.toString());
+<a class="jxr_linenumber" name="L311" href="#L311">311</a> }
+<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
+<a class="jxr_linenumber" name="L313" href="#L313">313</a>
+<a class="jxr_linenumber" name="L314" href="#L314">314</a>
mojoScanner.setActiveExtractors(extractors);
+<a class="jxr_linenumber" name="L315" href="#L315">315</a>
+<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em
class="jxr_comment">// TODO: could use this more, eg in the writing of the
plugin descriptor!</em>
+<a class="jxr_linenumber" name="L317" href="#L317">317</a>
PluginDescriptor pluginDescriptor = <strong class="jxr_keyword">new</strong>
PluginDescriptor();
+<a class="jxr_linenumber" name="L318" href="#L318">318</a>
+<a class="jxr_linenumber" name="L319" href="#L319">319</a>
pluginDescriptor.setGroupId(project.getGroupId());
+<a class="jxr_linenumber" name="L320" href="#L320">320</a>
+<a class="jxr_linenumber" name="L321" href="#L321">321</a>
pluginDescriptor.setArtifactId(project.getArtifactId());
+<a class="jxr_linenumber" name="L322" href="#L322">322</a>
+<a class="jxr_linenumber" name="L323" href="#L323">323</a>
pluginDescriptor.setVersion(project.getVersion());
+<a class="jxr_linenumber" name="L324" href="#L324">324</a>
+<a class="jxr_linenumber" name="L325" href="#L325">325</a>
pluginDescriptor.setGoalPrefix(goalPrefix);
+<a class="jxr_linenumber" name="L326" href="#L326">326</a>
+<a class="jxr_linenumber" name="L327" href="#L327">327</a>
pluginDescriptor.setName(project.getName());
+<a class="jxr_linenumber" name="L328" href="#L328">328</a>
+<a class="jxr_linenumber" name="L329" href="#L329">329</a>
pluginDescriptor.setDescription(project.getDescription());
+<a class="jxr_linenumber" name="L330" href="#L330">330</a>
+<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong
class="jxr_keyword">if</strong> (encoding == <strong
class="jxr_keyword">null</strong> || encoding.length() < 1) {
+<a class="jxr_linenumber" name="L332" href="#L332">332</a>
getLog().warn(<span class="jxr_string">"Using platform encoding ("</span> +
ReaderFactory.FILE_ENCODING
+<a class="jxr_linenumber" name="L333" href="#L333">333</a>
+ <span class="jxr_string">" actually) to read mojo source files, i.e. build is
platform dependent!"</span>);
+<a class="jxr_linenumber" name="L334" href="#L334">334</a> } <strong
class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L335" href="#L335">335</a>
getLog().info(<span class="jxr_string">"Using '"</span> + encoding + <span
class="jxr_string">"' encoding to read mojo source files."</span>);
+<a class="jxr_linenumber" name="L336" href="#L336">336</a> }
+<a class="jxr_linenumber" name="L337" href="#L337">337</a>
+<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong
class="jxr_keyword">if</strong> (internalJavadocBaseUrl != <strong
class="jxr_keyword">null</strong> &&
!internalJavadocBaseUrl.getPath().endsWith(<span
class="jxr_string">"/"</span>)) {
+<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(<span class="jxr_string">"Given parameter
'internalJavadocBaseUrl' must end with a slash but is '"</span>
+<a class="jxr_linenumber" name="L340" href="#L340">340</a>
+ internalJavadocBaseUrl + <span class="jxr_string">"'"</span>);
+<a class="jxr_linenumber" name="L341" href="#L341">341</a> }
+<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong
class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L343" href="#L343">343</a>
List<ComponentDependency> deps =
GeneratorUtils.toComponentDependencies(project.getArtifacts());
+<a class="jxr_linenumber" name="L344" href="#L344">344</a>
pluginDescriptor.setDependencies(deps);
+<a class="jxr_linenumber" name="L345" href="#L345">345</a>
+<a class="jxr_linenumber" name="L346" href="#L346">346</a>
PluginToolsRequest request = <strong class="jxr_keyword">new</strong>
DefaultPluginToolsRequest(project, pluginDescriptor);
+<a class="jxr_linenumber" name="L347" href="#L347">347</a>
request.setEncoding(encoding);
+<a class="jxr_linenumber" name="L348" href="#L348">348</a>
request.setSkipErrorNoDescriptorsFound(skipErrorNoDescriptorsFound);
+<a class="jxr_linenumber" name="L349" href="#L349">349</a>
request.setDependencies(filterMojoDependencies());
+<a class="jxr_linenumber" name="L350" href="#L350">350</a>
request.setRepoSession(mavenSession.getRepositorySession());
+<a class="jxr_linenumber" name="L351" href="#L351">351</a>
request.setInternalJavadocBaseUrl(internalJavadocBaseUrl);
+<a class="jxr_linenumber" name="L352" href="#L352">352</a>
request.setInternalJavadocVersion(internalJavadocVersion);
+<a class="jxr_linenumber" name="L353" href="#L353">353</a>
request.setExternalJavadocBaseUrls(externalJavadocBaseUrls);
+<a class="jxr_linenumber" name="L354" href="#L354">354</a>
request.setSettings(settings);
+<a class="jxr_linenumber" name="L355" href="#L355">355</a>
+<a class="jxr_linenumber" name="L356" href="#L356">356</a>
mojoScanner.populatePluginDescriptor(request);
+<a class="jxr_linenumber" name="L357" href="#L357">357</a>
request.setPluginDescriptor(extendPluginDescriptor(request));
+<a class="jxr_linenumber" name="L358" href="#L358">358</a>
+<a class="jxr_linenumber" name="L359" href="#L359">359</a>
outputDirectory.mkdirs();
+<a class="jxr_linenumber" name="L360" href="#L360">360</a>
+<a class="jxr_linenumber" name="L361" href="#L361">361</a>
PluginDescriptorFilesGenerator pluginDescriptorGenerator = <strong
class="jxr_keyword">new</strong> PluginDescriptorFilesGenerator();
+<a class="jxr_linenumber" name="L362" href="#L362">362</a>
pluginDescriptorGenerator.execute(outputDirectory, request);
+<a class="jxr_linenumber" name="L363" href="#L363">363</a>
+<a class="jxr_linenumber" name="L364" href="#L364">364</a>
buildContext.refresh(outputDirectory);
+<a class="jxr_linenumber" name="L365" href="#L365">365</a> } <strong
class="jxr_keyword">catch</strong> (GeneratorException e) {
+<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(<span class="jxr_string">"Error writing plugin
descriptor"</span>, e);
+<a class="jxr_linenumber" name="L367" href="#L367">367</a> } <strong
class="jxr_keyword">catch</strong> (InvalidPluginDescriptorException |
ExtractionException e) {
+<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(
+<a class="jxr_linenumber" name="L369" href="#L369">369</a>
<span class="jxr_string">"Error extracting plugin descriptor: '"</span> +
e.getLocalizedMessage() + <span class="jxr_string">"'"</span>, e);
+<a class="jxr_linenumber" name="L370" href="#L370">370</a> } <strong
class="jxr_keyword">catch</strong> (LinkageError e) {
+<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(
+<a class="jxr_linenumber" name="L372" href="#L372">372</a>
<span class="jxr_string">"The API of the mojo scanner is not compatible with
this plugin version."</span>
+<a class="jxr_linenumber" name="L373" href="#L373">373</a>
+ <span class="jxr_string">" Please check the plugin dependencies
configured"</span>
+<a class="jxr_linenumber" name="L374" href="#L374">374</a>
+ <span class="jxr_string">" in the POM and ensure the versions
match."</span>,
+<a class="jxr_linenumber" name="L375" href="#L375">375</a>
e);
+<a class="jxr_linenumber" name="L376" href="#L376">376</a> }
+<a class="jxr_linenumber" name="L377" href="#L377">377</a> }
+<a class="jxr_linenumber" name="L378" href="#L378">378</a>
+<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong
class="jxr_keyword">private</strong> PluginDescriptor
extendPluginDescriptor(PluginToolsRequest request) {
+<a class="jxr_linenumber" name="L380" href="#L380">380</a>
ExtendedPluginDescriptor extendedPluginDescriptor = <strong
class="jxr_keyword">new</strong>
ExtendedPluginDescriptor(request.getPluginDescriptor());
+<a class="jxr_linenumber" name="L381" href="#L381">381</a>
extendedPluginDescriptor.setRequiredJavaVersion(getRequiredJavaVersion(request));
+<a class="jxr_linenumber" name="L382" href="#L382">382</a>
extendedPluginDescriptor.setRequiredMavenVersion(getRequiredMavenVersion(request));
+<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong
class="jxr_keyword">return</strong> extendedPluginDescriptor;
+<a class="jxr_linenumber" name="L384" href="#L384">384</a> }
+<a class="jxr_linenumber" name="L385" href="#L385">385</a>
+<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong
class="jxr_keyword">private</strong> String
getRequiredMavenVersion(PluginToolsRequest request) {
+<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong
class="jxr_keyword">if</strong> (!VALUE_AUTO.equals(requiredMavenVersion)) {
+<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong
class="jxr_keyword">return</strong> requiredMavenVersion;
+<a class="jxr_linenumber" name="L389" href="#L389">389</a> }
+<a class="jxr_linenumber" name="L390" href="#L390">390</a>
getLog().debug(<span class="jxr_string">"Trying to derive Maven version
automatically from project prerequisites..."</span>);
+<a class="jxr_linenumber" name="L391" href="#L391">391</a> String
requiredMavenVersion =
+<a class="jxr_linenumber" name="L392" href="#L392">392</a>
project.getPrerequisites() != <strong class="jxr_keyword">null</strong> ?
project.getPrerequisites().getMaven() : <strong
class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong
class="jxr_keyword">if</strong> (requiredMavenVersion == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L394" href="#L394">394</a>
getLog().debug(<span class="jxr_string">"Trying to derive Maven version
automatically from referenced Maven Plugin API artifact "</span>
+<a class="jxr_linenumber" name="L395" href="#L395">395</a>
+ <span class="jxr_string">"version..."</span>);
+<a class="jxr_linenumber" name="L396" href="#L396">396</a>
requiredMavenVersion = request.getUsedMavenApiVersion();
+<a class="jxr_linenumber" name="L397" href="#L397">397</a> }
+<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong
class="jxr_keyword">if</strong> (requiredMavenVersion == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L399" href="#L399">399</a>
getLog().warn(<span class="jxr_string">"Cannot determine the required Maven
version automatically, it is recommended to "</span>
+<a class="jxr_linenumber" name="L400" href="#L400">400</a>
+ <span class="jxr_string">"configure some explicit value manually."</span>);
+<a class="jxr_linenumber" name="L401" href="#L401">401</a> }
+<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong
class="jxr_keyword">return</strong> requiredMavenVersion;
+<a class="jxr_linenumber" name="L403" href="#L403">403</a> }
+<a class="jxr_linenumber" name="L404" href="#L404">404</a>
+<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong
class="jxr_keyword">private</strong> String
getRequiredJavaVersion(PluginToolsRequest request) {
+<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong
class="jxr_keyword">if</strong> (!VALUE_AUTO.equals(requiredJavaVersion)) {
+<a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong
class="jxr_keyword">return</strong> requiredJavaVersion;
+<a class="jxr_linenumber" name="L408" href="#L408">408</a> }
+<a class="jxr_linenumber" name="L409" href="#L409">409</a> String
minRequiredJavaVersion = request.getRequiredJavaVersion();
+<a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong
class="jxr_keyword">if</strong> (minRequiredJavaVersion == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L411" href="#L411">411</a>
getLog().warn(<span class="jxr_string">"Cannot determine the minimally required
Java version automatically, it is recommended to "</span>
+<a class="jxr_linenumber" name="L412" href="#L412">412</a>
+ <span class="jxr_string">"configure some explicit value manually."</span>);
+<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L414" href="#L414">414</a> }
+<a class="jxr_linenumber" name="L415" href="#L415">415</a>
+<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong
class="jxr_keyword">return</strong> minRequiredJavaVersion;
+<a class="jxr_linenumber" name="L417" href="#L417">417</a> }
+<a class="jxr_linenumber" name="L418" href="#L418">418</a>
+<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em
class="jxr_javadoccomment"> * Collects all dependencies expected to be in
"provided" scope but are NOT in "provided" scope.</em>
+<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong
class="jxr_keyword">private</strong> Set<Artifact>
dependenciesNotInProvidedScope() {
+<a class="jxr_linenumber" name="L423" href="#L423">423</a>
LinkedHashSet<Artifact> wrongScopedDependencies = <strong
class="jxr_keyword">new</strong> LinkedHashSet<>();
+<a class="jxr_linenumber" name="L424" href="#L424">424</a>
+<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong
class="jxr_keyword">for</strong> (Artifact dependency : project.getArtifacts())
{
+<a class="jxr_linenumber" name="L426" href="#L426">426</a> String
ga = dependency.getGroupId() + <span class="jxr_string">":"</span> +
dependency.getArtifactId();
+<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong
class="jxr_keyword">if</strong>
(expectedProvidedScopeGroupIds.contains(dependency.getGroupId())
+<a class="jxr_linenumber" name="L428" href="#L428">428</a>
&& !expectedProvidedScopeExclusions.contains(ga)
+<a class="jxr_linenumber" name="L429" href="#L429">429</a>
&& !Artifact.SCOPE_PROVIDED.equals(dependency.getScope())) {
+<a class="jxr_linenumber" name="L430" href="#L430">430</a>
wrongScopedDependencies.add(dependency);
+<a class="jxr_linenumber" name="L431" href="#L431">431</a> }
+<a class="jxr_linenumber" name="L432" href="#L432">432</a> }
+<a class="jxr_linenumber" name="L433" href="#L433">433</a>
+<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong
class="jxr_keyword">return</strong> wrongScopedDependencies;
+<a class="jxr_linenumber" name="L435" href="#L435">435</a> }
+<a class="jxr_linenumber" name="L436" href="#L436">436</a>
+<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em
class="jxr_javadoccomment"> * Get dependencies filtered with
mojoDependencies configuration.</em>
+<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em
class="jxr_javadoccomment"> * @return eventually filtered dependencies, or
even <code>null</code> if configured with empty
mojoDependencies</em>
+<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em
class="jxr_javadoccomment"> * list</em>
+<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em
class="jxr_javadoccomment"> * @see #mojoDependencies</em>
+<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong
class="jxr_keyword">private</strong> Set<Artifact>
filterMojoDependencies() {
+<a class="jxr_linenumber" name="L445" href="#L445">445</a>
Set<Artifact> filteredArtifacts;
+<a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong
class="jxr_keyword">if</strong> (mojoDependencies == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L447" href="#L447">447</a>
filteredArtifacts = <strong class="jxr_keyword">new</strong>
LinkedHashSet<>(project.getArtifacts());
+<a class="jxr_linenumber" name="L448" href="#L448">448</a> } <strong
class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>
(mojoDependencies.isEmpty()) {
+<a class="jxr_linenumber" name="L449" href="#L449">449</a>
filteredArtifacts = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L450" href="#L450">450</a> } <strong
class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L451" href="#L451">451</a>
filteredArtifacts = <strong class="jxr_keyword">new</strong>
LinkedHashSet<>();
+<a class="jxr_linenumber" name="L452" href="#L452">452</a>
+<a class="jxr_linenumber" name="L453" href="#L453">453</a>
ArtifactFilter filter = <strong class="jxr_keyword">new</strong>
IncludesArtifactFilter(mojoDependencies);
+<a class="jxr_linenumber" name="L454" href="#L454">454</a>
+<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong
class="jxr_keyword">for</strong> (Artifact artifact : project.getArtifacts()) {
+<a class="jxr_linenumber" name="L456" href="#L456">456</a>
<strong class="jxr_keyword">if</strong> (filter.include(artifact)) {
+<a class="jxr_linenumber" name="L457" href="#L457">457</a>
filteredArtifacts.add(artifact);
+<a class="jxr_linenumber" name="L458" href="#L458">458</a> }
+<a class="jxr_linenumber" name="L459" href="#L459">459</a> }
+<a class="jxr_linenumber" name="L460" href="#L460">460</a> }
+<a class="jxr_linenumber" name="L461" href="#L461">461</a>
+<a class="jxr_linenumber" name="L462" href="#L462">462</a> <strong
class="jxr_keyword">return</strong> filteredArtifacts;
+<a class="jxr_linenumber" name="L463" href="#L463">463</a> }
+<a class="jxr_linenumber" name="L464" href="#L464">464</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2004–2024 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
Modified:
maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-plugin/xref/org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.html
==============================================================================
---
maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-plugin/xref/org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.html
(original)
+++
maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-plugin/xref/org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.html
Sat Mar 30 02:00:43 2024
@@ -33,81 +33,82 @@
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.descriptor.PluginDescriptor;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.LifecyclePhase;
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Parameter;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
-<a class="jxr_linenumber" name="L32" href="#L32">32</a>
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em
class="jxr_javadoccomment"> * Inject any plugin-specific</em>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em
class="jxr_javadoccomment"> * <a
href="/ref/current/maven-repository-metadata/repository-metadata.html">artifact
metadata</a> to the project's</em>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em
class="jxr_javadoccomment"> * artifact, for subsequent installation and
deployment.</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em
class="jxr_javadoccomment"> * It is used:</em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment"> * <ol></em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment"> * <li>to add the
<code>latest</code> metadata (which is plugin-specific) for
shipping alongside the plugin's</em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em
class="jxr_javadoccomment"> * artifact</li></em>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment"> * <li>to define plugin mapping in the
group</li></em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> * </ol></em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment"> * @see ArtifactRepositoryMetadata</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment"> * @see GroupRepositoryMetadata</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> * @since 2.0</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> @Mojo(name = <span
class="jxr_string">"addPluginArtifactMetadata"</span>, defaultPhase =
LifecyclePhase.PACKAGE, threadSafe = <strong class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a name="AddPluginArtifactMetadataMojo"
href="../../../../../../org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.html#AddPluginArtifactMetadataMojo">AddPluginArtifactMetadataMojo</a>
<strong class="jxr_keyword">extends</strong> AbstractMojo {
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em
class="jxr_javadoccomment"> * The project artifact, which should have the
<code>latest</code> metadata added to it.</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</a>
@Parameter(defaultValue = <span class="jxr_string">"${project}"</span>,
readonly = <strong class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong
class="jxr_keyword">private</strong> MavenProject project;
-<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 prefix for the plugin goal.</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Parameter
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong
class="jxr_keyword">private</strong> String goalPrefix;
-<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"> * Set this to "true" to skip invoking any goals
or reports of the plugin.</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"> * @since 2.8</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(defaultValue = <span class="jxr_string">"false"</span>, property =
<span class="jxr_string">"maven.plugin.skip"</span>)
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> skip;
-<a class="jxr_linenumber" name="L70" href="#L70">70</a>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em
class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> @Override
-<a class="jxr_linenumber" name="L73" href="#L73">73</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="L74" href="#L74">74</a> <strong
class="jxr_keyword">if</strong> (skip) {
-<a class="jxr_linenumber" name="L75" href="#L75">75</a>
getLog().warn(<span class="jxr_string">"Execution skipped"</span>);
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong
class="jxr_keyword">return</strong>;
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> }
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> Artifact
projectArtifact = project.getArtifact();
-<a class="jxr_linenumber" name="L79" href="#L79">79</a>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> Versioning
versioning = <strong class="jxr_keyword">new</strong> Versioning();
-<a class="jxr_linenumber" name="L81" href="#L81">81</a>
versioning.setLatest(projectArtifact.getVersion());
-<a class="jxr_linenumber" name="L82" href="#L82">82</a>
versioning.updateTimestamp();
-<a class="jxr_linenumber" name="L83" href="#L83">83</a>
ArtifactRepositoryMetadata metadata = <strong class="jxr_keyword">new</strong>
ArtifactRepositoryMetadata(projectArtifact, versioning);
-<a class="jxr_linenumber" name="L84" href="#L84">84</a>
projectArtifact.addMetadata(metadata);
-<a class="jxr_linenumber" name="L85" href="#L85">85</a>
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <a
name="GroupRepositoryMetadata"
href="../../../../../../org/apache/maven/artifact/repository/metadata/GroupRepositoryMetadata.html#GroupRepositoryMetadata">GroupRepositoryMetadata</a>
groupMetadata = <strong class="jxr_keyword">new</strong> <a
name="GroupRepositoryMetadata"
href="../../../../../../org/apache/maven/artifact/repository/metadata/GroupRepositoryMetadata.html#GroupRepositoryMetadata">GroupRepositoryMetadata</a>(project.getGroupId());
-<a class="jxr_linenumber" name="L87" href="#L87">87</a>
groupMetadata.addPluginMapping(getGoalPrefix(), project.getArtifactId(),
project.getName());
-<a class="jxr_linenumber" name="L88" href="#L88">88</a>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a>
projectArtifact.addMetadata(groupMetadata);
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
-<a class="jxr_linenumber" name="L91" href="#L91">91</a>
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment"> * @return the goal prefix parameter or the goal
prefix from the Plugin artifactId.</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> <strong
class="jxr_keyword">private</strong> String getGoalPrefix() {
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong
class="jxr_keyword">if</strong> (goalPrefix == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L97" href="#L97">97</a>
goalPrefix =
PluginDescriptor.getGoalPrefixFromArtifactId(project.getArtifactId());
-<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> goalPrefix;
-<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="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Component;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.LifecyclePhase;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Parameter;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em
class="jxr_javadoccomment"> * Inject any plugin-specific</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em
class="jxr_javadoccomment"> * <a
href="/ref/current/maven-repository-metadata/repository-metadata.html">artifact
metadata</a> to the project's</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em
class="jxr_javadoccomment"> * artifact, for subsequent installation and
deployment.</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment"> * It is used:</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment"> * <ol></em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em
class="jxr_javadoccomment"> * <li>to add the
<code>latest</code> metadata (which is plugin-specific) for
shipping alongside the plugin's</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment"> * artifact</li></em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> * <li>to define plugin mapping in the
group</li></em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> * </ol></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"> * @see ArtifactRepositoryMetadata</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> * @see GroupRepositoryMetadata</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em
class="jxr_javadoccomment"> * @since 2.0</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> @Mojo(name = <span
class="jxr_string">"addPluginArtifactMetadata"</span>, defaultPhase =
LifecyclePhase.PACKAGE, threadSafe = <strong class="jxr_keyword">true</strong>)
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a name="AddPluginArtifactMetadataMojo"
href="../../../../../../org/apache/maven/plugin/plugin/metadata/AddPluginArtifactMetadataMojo.html#AddPluginArtifactMetadataMojo">AddPluginArtifactMetadataMojo</a>
<strong class="jxr_keyword">extends</strong> AbstractMojo {
+<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"> * The project artifact, which should have the
<code>latest</code> metadata added to it.</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> @Component
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong
class="jxr_keyword">private</strong> MavenProject project;
+<a class="jxr_linenumber" name="L57" href="#L57">57</a>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> * The prefix for the plugin goal.</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Parameter
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong
class="jxr_keyword">private</strong> String goalPrefix;
+<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"> * Set this to "true" to skip invoking any goals
or reports of the plugin.</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em
class="jxr_javadoccomment"> * @since 2.8</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(defaultValue = <span class="jxr_string">"false"</span>, property =
<span class="jxr_string">"maven.plugin.skip"</span>)
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> skip;
+<a class="jxr_linenumber" name="L71" href="#L71">71</a>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em
class="jxr_javadoccomment">/** {@inheritDoc} */</em>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> @Override
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException {
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong
class="jxr_keyword">if</strong> (skip) {
+<a class="jxr_linenumber" name="L76" href="#L76">76</a>
getLog().warn(<span class="jxr_string">"Execution skipped"</span>);
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong
class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> Artifact
projectArtifact = project.getArtifact();
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> Versioning
versioning = <strong class="jxr_keyword">new</strong> Versioning();
+<a class="jxr_linenumber" name="L82" href="#L82">82</a>
versioning.setLatest(projectArtifact.getVersion());
+<a class="jxr_linenumber" name="L83" href="#L83">83</a>
versioning.updateTimestamp();
+<a class="jxr_linenumber" name="L84" href="#L84">84</a>
ArtifactRepositoryMetadata metadata = <strong class="jxr_keyword">new</strong>
ArtifactRepositoryMetadata(projectArtifact, versioning);
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>
projectArtifact.addMetadata(metadata);
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <a
name="GroupRepositoryMetadata"
href="../../../../../../org/apache/maven/artifact/repository/metadata/GroupRepositoryMetadata.html#GroupRepositoryMetadata">GroupRepositoryMetadata</a>
groupMetadata = <strong class="jxr_keyword">new</strong> <a
name="GroupRepositoryMetadata"
href="../../../../../../org/apache/maven/artifact/repository/metadata/GroupRepositoryMetadata.html#GroupRepositoryMetadata">GroupRepositoryMetadata</a>(project.getGroupId());
+<a class="jxr_linenumber" name="L88" href="#L88">88</a>
groupMetadata.addPluginMapping(getGoalPrefix(), project.getArtifactId(),
project.getName());
+<a class="jxr_linenumber" name="L89" href="#L89">89</a>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a>
projectArtifact.addMetadata(groupMetadata);
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
+<a class="jxr_linenumber" name="L92" href="#L92">92</a>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em
class="jxr_javadoccomment"> * @return the goal prefix parameter or the goal
prefix from the Plugin artifactId.</em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong
class="jxr_keyword">private</strong> String getGoalPrefix() {
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong
class="jxr_keyword">if</strong> (goalPrefix == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L98" href="#L98">98</a>
goalPrefix =
PluginDescriptor.getGoalPrefixFromArtifactId(project.getArtifactId());
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
+<a class="jxr_linenumber" name="L100" href="#L100">100</a>
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong
class="jxr_keyword">return</strong> goalPrefix;
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2004–2024 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
