Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AbstractHelpMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AbstractHelpMojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AbstractHelpMojo.html Sun Jun 2 15:20:18 2024 @@ -1,215 +1,214 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> -<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> -<title>AbstractHelpMojo xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/AbstractHelpMojo.html">View Javadoc</a></div><pre> -<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> -<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; -<a class="jxr_linenumber" name="L20" href="#L20">20</a> -<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File; -<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.Writer; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.building.ModelBuildingRequest; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.DefaultProjectBuildingRequest; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.ProjectBuilder; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.ProjectBuildingRequest; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.WriterFactory; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositoryException; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositorySystem; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositorySystemSession; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.artifact.DefaultArtifact; -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.resolution.ArtifactDescriptorRequest; -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.resolution.ArtifactDescriptorResult; -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.resolution.ArtifactRequest; -<a class="jxr_linenumber" name="L45" href="#L45">45</a> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Base class with some Help Mojo functionalities.</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.sive...@gmail.com"; target="alexandria_uri">mailto:vincent.sive...@gmail.com</a>">Vincent Siveton</a></em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractHelpMojo" href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo">AbstractHelpMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/** The maximum length of a display line. */</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> LINE_LENGTH = 79; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/** The line separator for the current OS. */</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LS = System.getProperty(<span class="jxr_string">"line.separator"</span>); -<a class="jxr_linenumber" name="L58" href="#L58">58</a> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Maven Project Builder component.</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> @Component -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">protected</strong> ProjectBuilder projectBuilder; -<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"> * Component used to resolve artifacts and download their files from remote repositories.</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> @Component -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">protected</strong> RepositorySystem repositorySystem; -<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"> * Current Maven project.</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> @Parameter(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="L75" href="#L75">75</a> <strong class="jxr_keyword">protected</strong> MavenProject project; -<a class="jxr_linenumber" name="L76" href="#L76">76</a> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * The current build session instance. This is used for</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * plugin manager API calls.</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">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">protected</strong> MavenSession session; -<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"> * Optional parameter to write the output of this help in a given file, instead of writing to the console.</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * <br></em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Could be a relative path.</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> @Parameter(property = <span class="jxr_string">"output"</span>) -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">protected</strong> File output; -<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"> * Utility method to write a content in a given file.</em> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param output is the wanted output file.</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @param content contains the content to be written to the file.</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @throws IOException if any</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @see #writeFile(File, String)</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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeFile(File output, StringBuilder content) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L101" href="#L101">101</a> writeFile(output, content.toString()); -<a class="jxr_linenumber" name="L102" href="#L102">102</a> } -<a class="jxr_linenumber" name="L103" href="#L103">103</a> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * Utility method to write a content in a given file.</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @param output is the wanted output file.</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param content contains the content to be written to the file.</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @throws IOException if any</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeFile(File output, String content) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">if</strong> (output == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L114" href="#L114">114</a> } -<a class="jxr_linenumber" name="L115" href="#L115">115</a> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> output.getParentFile().mkdirs(); -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">try</strong> (Writer out = WriterFactory.newPlatformWriter(output)) { -<a class="jxr_linenumber" name="L118" href="#L118">118</a> out.write(content); -<a class="jxr_linenumber" name="L119" href="#L119">119</a> } -<a class="jxr_linenumber" name="L120" href="#L120">120</a> } -<a class="jxr_linenumber" name="L121" href="#L121">121</a> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Parses the given String into GAV artifact coordinate information, adding the given type.</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @param artifactString should respect the format <code>groupId:artifactId[:version]</code></em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param type The extension for the artifact, must not be <code>null</code>.</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @return the <code>Artifact</code> object for the <code>artifactString</code> parameter.</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the <code>artifactString</code> doesn't respect the format.</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> <strong class="jxr_keyword">protected</strong> org.eclipse.aether.artifact.Artifact getAetherArtifact(String artifactString, String type) -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(artifactString)) { -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"artifact parameter could not be empty"</span>); -<a class="jxr_linenumber" name="L134" href="#L134">134</a> } -<a class="jxr_linenumber" name="L135" href="#L135">135</a> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> String groupId; <em class="jxr_comment">// required</em> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> String artifactId; <em class="jxr_comment">// required</em> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> String version; <em class="jxr_comment">// optional</em> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> String[] artifactParts = artifactString.split(<span class="jxr_string">":"</span>); -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">switch</strong> (artifactParts.length) { -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">case</strong> 2: -<a class="jxr_linenumber" name="L143" href="#L143">143</a> groupId = artifactParts[0]; -<a class="jxr_linenumber" name="L144" href="#L144">144</a> artifactId = artifactParts[1]; -<a class="jxr_linenumber" name="L145" href="#L145">145</a> version = Artifact.LATEST_VERSION; -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">case</strong> 3: -<a class="jxr_linenumber" name="L148" href="#L148">148</a> groupId = artifactParts[0]; -<a class="jxr_linenumber" name="L149" href="#L149">149</a> artifactId = artifactParts[1]; -<a class="jxr_linenumber" name="L150" href="#L150">150</a> version = artifactParts[2]; -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">default</strong>: -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"The artifact parameter '"</span> + artifactString -<a class="jxr_linenumber" name="L154" href="#L154">154</a> + <span class="jxr_string">"' should be conform to: "</span> + <span class="jxr_string">"'groupId:artifactId[:version]'."</span>); -<a class="jxr_linenumber" name="L155" href="#L155">155</a> } -<a class="jxr_linenumber" name="L156" href="#L156">156</a> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> DefaultArtifact(groupId, artifactId, type, version); -<a class="jxr_linenumber" name="L158" href="#L158">158</a> } -<a class="jxr_linenumber" name="L159" href="#L159">159</a> -<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> <em class="jxr_javadoccomment"> * Retrieves the Maven Project associated with the given artifact String, in the form of</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * <code>groupId:artifactId[:version]</code>. This resolves the POM artifact at those coordinates and then builds</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * the Maven project from it.</em> -<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"> * @param artifactString Coordinates of the Maven project to get.</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @return New Maven project.</em> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException If there was an error while getting the Maven project.</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> <strong class="jxr_keyword">protected</strong> MavenProject getMavenProject(String artifactString) <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L171" href="#L171">171</a> ProjectBuildingRequest pbr = <strong class="jxr_keyword">new</strong> DefaultProjectBuildingRequest(session.getProjectBuildingRequest()); -<a class="jxr_linenumber" name="L172" href="#L172">172</a> pbr.setRemoteRepositories(project.getRemoteArtifactRepositories()); -<a class="jxr_linenumber" name="L173" href="#L173">173</a> pbr.setPluginArtifactRepositories(project.getPluginArtifactRepositories()); -<a class="jxr_linenumber" name="L174" href="#L174">174</a> pbr.setProject(<strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L175" href="#L175">175</a> pbr.setValidationLevel(ModelBuildingRequest.VALIDATION_LEVEL_MINIMAL); -<a class="jxr_linenumber" name="L176" href="#L176">176</a> pbr.setResolveDependencies(<strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L177" href="#L177">177</a> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> org.eclipse.aether.artifact.Artifact artifact = -<a class="jxr_linenumber" name="L179" href="#L179">179</a> resolveArtifact(getAetherArtifact(artifactString, <span class="jxr_string">"pom"</span>)).getArtifact(); -<a class="jxr_linenumber" name="L180" href="#L180">180</a> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">return</strong> projectBuilder.build(artifact.getFile(), pbr).getProject(); -<a class="jxr_linenumber" name="L182" href="#L182">182</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <span class="jxr_string">"Unable to get the POM for the artifact '"</span> + artifactString + <span class="jxr_string">"'. Verify the artifact parameter."</span>, -<a class="jxr_linenumber" name="L185" href="#L185">185</a> e); -<a class="jxr_linenumber" name="L186" href="#L186">186</a> } -<a class="jxr_linenumber" name="L187" href="#L187">187</a> } -<a class="jxr_linenumber" name="L188" href="#L188">188</a> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">protected</strong> org.eclipse.aether.resolution.ArtifactResult resolveArtifact( -<a class="jxr_linenumber" name="L190" href="#L190">190</a> org.eclipse.aether.artifact.Artifact artifact) <strong class="jxr_keyword">throws</strong> RepositoryException { -<a class="jxr_linenumber" name="L191" href="#L191">191</a> RepositorySystemSession repositorySession = session.getRepositorySession(); -<a class="jxr_linenumber" name="L192" href="#L192">192</a> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_comment">// use descriptor to respect relocation</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> ArtifactDescriptorResult artifactDescriptor = repositorySystem.readArtifactDescriptor( -<a class="jxr_linenumber" name="L195" href="#L195">195</a> repositorySession, -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">new</strong> ArtifactDescriptorRequest(artifact, project.getRemoteProjectRepositories(), <strong class="jxr_keyword">null</strong>)); -<a class="jxr_linenumber" name="L197" href="#L197">197</a> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">return</strong> repositorySystem.resolveArtifact( -<a class="jxr_linenumber" name="L199" href="#L199">199</a> repositorySession, -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">new</strong> ArtifactRequest(artifactDescriptor.getArtifact(), project.getRemoteProjectRepositories(), <strong class="jxr_keyword">null</strong>)); -<a class="jxr_linenumber" name="L201" href="#L201">201</a> } -<a class="jxr_linenumber" name="L202" href="#L202">202</a> } -</pre> -<hr/> -<div id="footer">Copyright © 2001–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> -</body> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>AbstractHelpMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/AbstractHelpMojo.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.Writer; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.building.ModelBuildingRequest; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.DefaultProjectBuildingRequest; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.ProjectBuilder; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.ProjectBuildingRequest; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.WriterFactory; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositoryException; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositorySystem; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositorySystemSession; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.artifact.DefaultArtifact; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.resolution.ArtifactDescriptorRequest; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.resolution.ArtifactDescriptorResult; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.resolution.ArtifactRequest; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Base class with some Help Mojo functionalities.</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"> * @author <a href="<a href="mailto:vincent.sive...@gmail.com"; target="alexandria_uri">mailto:vincent.sive...@gmail.com</a>">Vincent Siveton</a></em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractHelpMojo" href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo">AbstractHelpMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/** The maximum length of a display line. */</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> LINE_LENGTH = 79; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/** The line separator for the current OS. */</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LS = System.getProperty(<span class="jxr_string">"line.separator"</span>); +<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"> * Maven Project Builder component.</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> @Component +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">protected</strong> ProjectBuilder projectBuilder; +<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"> * Component used to resolve artifacts and download their files from remote repositories.</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> @Component +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">protected</strong> RepositorySystem repositorySystem; +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Current Maven project.</em> +<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> @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="L74" href="#L74">74</a> <strong class="jxr_keyword">protected</strong> MavenProject project; +<a class="jxr_linenumber" name="L75" href="#L75">75</a> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * The current build session instance. This is used for</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * plugin manager API calls.</em> +<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> @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="L81" href="#L81">81</a> <strong class="jxr_keyword">protected</strong> MavenSession session; +<a class="jxr_linenumber" name="L82" href="#L82">82</a> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * Optional parameter to write the output of this help in a given file, instead of writing to the console.</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * <br></em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Could be a relative path.</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(property = <span class="jxr_string">"output"</span>) +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">protected</strong> File output; +<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"> * Utility method to write a content in a given file.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param output is the wanted output file.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param content contains the content to be written to the file.</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @throws IOException if any</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @see #writeFile(File, String)</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeFile(File output, StringBuilder content) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L100" href="#L100">100</a> writeFile(output, content.toString()); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> } +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Utility method to write a content in a given file.</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> <em class="jxr_javadoccomment"> * @param output is the wanted output file.</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @param content contains the content to be written to the file.</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @throws IOException if any</em> +<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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeFile(File output, String content) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">if</strong> (output == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L113" href="#L113">113</a> } +<a class="jxr_linenumber" name="L114" href="#L114">114</a> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> output.getParentFile().mkdirs(); +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">try</strong> (Writer out = WriterFactory.newPlatformWriter(output)) { +<a class="jxr_linenumber" name="L117" href="#L117">117</a> out.write(content); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> } +<a class="jxr_linenumber" name="L119" href="#L119">119</a> } +<a class="jxr_linenumber" name="L120" href="#L120">120</a> +<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> <em class="jxr_javadoccomment"> * Parses the given String into GAV artifact coordinate information, adding the given type.</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * @param artifactString should respect the format <code>groupId:artifactId[:version]</code></em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @param type The extension for the artifact, must not be <code>null</code>.</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @return the <code>Artifact</code> object for the <code>artifactString</code> parameter.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the <code>artifactString</code> doesn't respect the format.</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> <strong class="jxr_keyword">protected</strong> org.eclipse.aether.artifact.Artifact getAetherArtifact(String artifactString, String type) +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">if</strong> (artifactString == <strong class="jxr_keyword">null</strong> || artifactString.isEmpty()) { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"artifact parameter could not be empty"</span>); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> } +<a class="jxr_linenumber" name="L134" href="#L134">134</a> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> String groupId; <em class="jxr_comment">// required</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> String artifactId; <em class="jxr_comment">// required</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> String version; <em class="jxr_comment">// optional</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> String[] artifactParts = artifactString.split(<span class="jxr_string">":"</span>); +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">switch</strong> (artifactParts.length) { +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">case</strong> 2: +<a class="jxr_linenumber" name="L142" href="#L142">142</a> groupId = artifactParts[0]; +<a class="jxr_linenumber" name="L143" href="#L143">143</a> artifactId = artifactParts[1]; +<a class="jxr_linenumber" name="L144" href="#L144">144</a> version = Artifact.LATEST_VERSION; +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">case</strong> 3: +<a class="jxr_linenumber" name="L147" href="#L147">147</a> groupId = artifactParts[0]; +<a class="jxr_linenumber" name="L148" href="#L148">148</a> artifactId = artifactParts[1]; +<a class="jxr_linenumber" name="L149" href="#L149">149</a> version = artifactParts[2]; +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">default</strong>: +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"The artifact parameter '"</span> + artifactString +<a class="jxr_linenumber" name="L153" href="#L153">153</a> + <span class="jxr_string">"' should be conform to: "</span> + <span class="jxr_string">"'groupId:artifactId[:version]'."</span>); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> } +<a class="jxr_linenumber" name="L155" href="#L155">155</a> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> DefaultArtifact(groupId, artifactId, type, version); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> } +<a class="jxr_linenumber" name="L158" href="#L158">158</a> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * Retrieves the Maven Project associated with the given artifact String, in the form of</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * <code>groupId:artifactId[:version]</code>. This resolves the POM artifact at those coordinates and then builds</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * the Maven project from it.</em> +<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"> * @param artifactString Coordinates of the Maven project to get.</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @return New Maven project.</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException If there was an error while getting the Maven project.</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> <strong class="jxr_keyword">protected</strong> MavenProject getMavenProject(String artifactString) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L170" href="#L170">170</a> ProjectBuildingRequest pbr = <strong class="jxr_keyword">new</strong> DefaultProjectBuildingRequest(session.getProjectBuildingRequest()); +<a class="jxr_linenumber" name="L171" href="#L171">171</a> pbr.setRemoteRepositories(project.getRemoteArtifactRepositories()); +<a class="jxr_linenumber" name="L172" href="#L172">172</a> pbr.setPluginArtifactRepositories(project.getPluginArtifactRepositories()); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> pbr.setProject(<strong class="jxr_keyword">null</strong>); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> pbr.setValidationLevel(ModelBuildingRequest.VALIDATION_LEVEL_MINIMAL); +<a class="jxr_linenumber" name="L175" href="#L175">175</a> pbr.setResolveDependencies(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L176" href="#L176">176</a> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> org.eclipse.aether.artifact.Artifact artifact = +<a class="jxr_linenumber" name="L178" href="#L178">178</a> resolveArtifact(getAetherArtifact(artifactString, <span class="jxr_string">"pom"</span>)).getArtifact(); +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">return</strong> projectBuilder.build(artifact.getFile(), pbr).getProject(); +<a class="jxr_linenumber" name="L181" href="#L181">181</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <span class="jxr_string">"Unable to get the POM for the artifact '"</span> + artifactString + <span class="jxr_string">"'. Verify the artifact parameter."</span>, +<a class="jxr_linenumber" name="L184" href="#L184">184</a> e); +<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> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">protected</strong> org.eclipse.aether.resolution.ArtifactResult resolveArtifact( +<a class="jxr_linenumber" name="L189" href="#L189">189</a> org.eclipse.aether.artifact.Artifact artifact) <strong class="jxr_keyword">throws</strong> RepositoryException { +<a class="jxr_linenumber" name="L190" href="#L190">190</a> RepositorySystemSession repositorySession = session.getRepositorySession(); +<a class="jxr_linenumber" name="L191" href="#L191">191</a> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_comment">// use descriptor to respect relocation</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> ArtifactDescriptorResult artifactDescriptor = repositorySystem.readArtifactDescriptor( +<a class="jxr_linenumber" name="L194" href="#L194">194</a> repositorySession, +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">new</strong> ArtifactDescriptorRequest(artifact, project.getRemoteProjectRepositories(), <strong class="jxr_keyword">null</strong>)); +<a class="jxr_linenumber" name="L196" href="#L196">196</a> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">return</strong> repositorySystem.resolveArtifact( +<a class="jxr_linenumber" name="L198" href="#L198">198</a> repositorySession, +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">new</strong> ArtifactRequest(artifactDescriptor.getArtifact(), project.getRemoteProjectRepositories(), <strong class="jxr_keyword">null</strong>)); +<a class="jxr_linenumber" name="L200" href="#L200">200</a> } +<a class="jxr_linenumber" name="L201" href="#L201">201</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2001–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> </html> \ No newline at end of file
Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/ActiveProfilesMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/ActiveProfilesMojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/ActiveProfilesMojo.html Sun Jun 2 15:20:18 2024 @@ -1,126 +1,126 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> -<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> -<title>ActiveProfilesMojo xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/ActiveProfilesMojo.html">View Javadoc</a></div><pre> -<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> -<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; -<a class="jxr_linenumber" name="L20" href="#L20">20</a> -<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Map; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Displays a list of the profiles which are currently active for this build.</em> -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> @Mojo(name = <span class="jxr_string">"active-profiles"</span>, aggregator = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ActiveProfilesMojo" href="../../../../../org/apache/maven/plugins/help/ActiveProfilesMojo.html#ActiveProfilesMojo">ActiveProfilesMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractHelpMojo" href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo">AbstractHelpMojo</a> { -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_comment">// Mojo parameters</em> -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L40" href="#L40">40</a> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * This is the list of projects currently slated to be built by Maven.</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> @Parameter(defaultValue = <span class="jxr_string">"${reactorProjects}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> List<MavenProject> projects; -<a class="jxr_linenumber" name="L46" href="#L46">46</a> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_comment">// Public methods</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</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="L53" href="#L53">53</a> StringBuilder message = <strong class="jxr_keyword">new</strong> StringBuilder(); -<a class="jxr_linenumber" name="L54" href="#L54">54</a> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">for</strong> (MavenProject project : projects) { -<a class="jxr_linenumber" name="L56" href="#L56">56</a> getActiveProfileStatement(project, message); -<a class="jxr_linenumber" name="L57" href="#L57">57</a> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> message.append(LS).append(LS); -<a class="jxr_linenumber" name="L59" href="#L59">59</a> } -<a class="jxr_linenumber" name="L60" href="#L60">60</a> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (output != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L62" href="#L62">62</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(); -<a class="jxr_linenumber" name="L63" href="#L63">63</a> sb.append(<span class="jxr_string">"Generated by Maven Help Plugin"</span>).append(LS); -<a class="jxr_linenumber" name="L64" href="#L64">64</a> sb.append(<span class="jxr_string">"See: https://maven.apache.org/plugins/maven-help-plugin/";</span>) -<a class="jxr_linenumber" name="L65" href="#L65">65</a> .append(LS) -<a class="jxr_linenumber" name="L66" href="#L66">66</a> .append(LS); -<a class="jxr_linenumber" name="L67" href="#L67">67</a> sb.append(message.toString()); -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L70" href="#L70">70</a> writeFile(output, sb); -<a class="jxr_linenumber" name="L71" href="#L71">71</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot write active profiles to output: "</span> + output, e); -<a class="jxr_linenumber" name="L73" href="#L73">73</a> } -<a class="jxr_linenumber" name="L74" href="#L74">74</a> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> getLog().info(<span class="jxr_string">"Active profile report written to: "</span> + output); -<a class="jxr_linenumber" name="L76" href="#L76">76</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L77" href="#L77">77</a> getLog().info(message); -<a class="jxr_linenumber" name="L78" href="#L78">78</a> } -<a class="jxr_linenumber" name="L79" href="#L79">79</a> } -<a class="jxr_linenumber" name="L80" href="#L80">80</a> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment">// Private methods</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<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"> * Method to get the active profiles for the project</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> <em class="jxr_javadoccomment"> * @param project the current project</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @param message the object where the information will be appended to</em> -<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> getActiveProfileStatement(MavenProject project, StringBuilder message) { -<a class="jxr_linenumber" name="L92" href="#L92">92</a> Map<String, List<String>> activeProfileIds = project.getInjectedProfileIds(); -<a class="jxr_linenumber" name="L93" href="#L93">93</a> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> message.append(LS); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> message.append(<span class="jxr_string">"Active Profiles for Project '"</span>).append(project.getId()).append(<span class="jxr_string">"':"</span>); -<a class="jxr_linenumber" name="L96" href="#L96">96</a> message.append(LS).append(LS); -<a class="jxr_linenumber" name="L97" href="#L97">97</a> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">if</strong> (activeProfileIds.isEmpty()) { -<a class="jxr_linenumber" name="L99" href="#L99">99</a> message.append(<span class="jxr_string">"There are no active profiles."</span>); -<a class="jxr_linenumber" name="L100" href="#L100">100</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L101" href="#L101">101</a> message.append(<span class="jxr_string">"The following profiles are active:"</span>).append(LS); -<a class="jxr_linenumber" name="L102" href="#L102">102</a> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">for</strong> (Map.Entry<String, List<String>> entry : activeProfileIds.entrySet()) { -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">for</strong> (String profileId : entry.getValue()) { -<a class="jxr_linenumber" name="L105" href="#L105">105</a> message.append(LS).append(<span class="jxr_string">" - "</span>).append(profileId); -<a class="jxr_linenumber" name="L106" href="#L106">106</a> message.append(<span class="jxr_string">" (source: "</span>).append(entry.getKey()).append(<span class="jxr_string">")"</span>); -<a class="jxr_linenumber" name="L107" href="#L107">107</a> } -<a class="jxr_linenumber" name="L108" href="#L108">108</a> } -<a class="jxr_linenumber" name="L109" href="#L109">109</a> } -<a class="jxr_linenumber" name="L110" href="#L110">110</a> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> message.append(LS); -<a class="jxr_linenumber" name="L112" href="#L112">112</a> } -<a class="jxr_linenumber" name="L113" href="#L113">113</a> } -</pre> -<hr/> -<div id="footer">Copyright © 2001–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> -</body> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>ActiveProfilesMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/ActiveProfilesMojo.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Displays a list of the profiles which are currently active for this build.</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> @Mojo(name = <span class="jxr_string">"active-profiles"</span>, aggregator = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ActiveProfilesMojo" href="../../../../../org/apache/maven/plugins/help/ActiveProfilesMojo.html#ActiveProfilesMojo">ActiveProfilesMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractHelpMojo" href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo">AbstractHelpMojo</a> { +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_comment">// Mojo parameters</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * This is the list of projects currently slated to be built by Maven.</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> @Parameter(defaultValue = <span class="jxr_string">"${reactorProjects}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> List<MavenProject> projects; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_comment">// Public methods</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</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="L53" href="#L53">53</a> StringBuilder message = <strong class="jxr_keyword">new</strong> StringBuilder(); +<a class="jxr_linenumber" name="L54" href="#L54">54</a> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">for</strong> (MavenProject project : projects) { +<a class="jxr_linenumber" name="L56" href="#L56">56</a> getActiveProfileStatement(project, message); +<a class="jxr_linenumber" name="L57" href="#L57">57</a> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> message.append(LS).append(LS); +<a class="jxr_linenumber" name="L59" href="#L59">59</a> } +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (output != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L62" href="#L62">62</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(); +<a class="jxr_linenumber" name="L63" href="#L63">63</a> sb.append(<span class="jxr_string">"Generated by Maven Help Plugin"</span>).append(LS); +<a class="jxr_linenumber" name="L64" href="#L64">64</a> sb.append(<span class="jxr_string">"See: https://maven.apache.org/plugins/maven-help-plugin/";</span>) +<a class="jxr_linenumber" name="L65" href="#L65">65</a> .append(LS) +<a class="jxr_linenumber" name="L66" href="#L66">66</a> .append(LS); +<a class="jxr_linenumber" name="L67" href="#L67">67</a> sb.append(message.toString()); +<a class="jxr_linenumber" name="L68" href="#L68">68</a> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L70" href="#L70">70</a> writeFile(output, sb); +<a class="jxr_linenumber" name="L71" href="#L71">71</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot write active profiles to output: "</span> + output, e); +<a class="jxr_linenumber" name="L73" href="#L73">73</a> } +<a class="jxr_linenumber" name="L74" href="#L74">74</a> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> getLog().info(<span class="jxr_string">"Active profile report written to: "</span> + output); +<a class="jxr_linenumber" name="L76" href="#L76">76</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L77" href="#L77">77</a> getLog().info(message); +<a class="jxr_linenumber" name="L78" href="#L78">78</a> } +<a class="jxr_linenumber" name="L79" href="#L79">79</a> } +<a class="jxr_linenumber" name="L80" href="#L80">80</a> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment">// Private methods</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<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"> * Method to get the active profiles for the project</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> <em class="jxr_javadoccomment"> * @param project the current project</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @param message the object where the information will be appended to</em> +<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> getActiveProfileStatement(MavenProject project, StringBuilder message) { +<a class="jxr_linenumber" name="L92" href="#L92">92</a> Map<String, List<String>> activeProfileIds = project.getInjectedProfileIds(); +<a class="jxr_linenumber" name="L93" href="#L93">93</a> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> message.append(LS); +<a class="jxr_linenumber" name="L95" href="#L95">95</a> message.append(<span class="jxr_string">"Active Profiles for Project '"</span>).append(project.getId()).append(<span class="jxr_string">"':"</span>); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> message.append(LS).append(LS); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">if</strong> (activeProfileIds.isEmpty()) { +<a class="jxr_linenumber" name="L99" href="#L99">99</a> message.append(<span class="jxr_string">"There are no active profiles."</span>); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L101" href="#L101">101</a> message.append(<span class="jxr_string">"The following profiles are active:"</span>).append(LS); +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">for</strong> (Map.Entry<String, List<String>> entry : activeProfileIds.entrySet()) { +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">for</strong> (String profileId : entry.getValue()) { +<a class="jxr_linenumber" name="L105" href="#L105">105</a> message.append(LS).append(<span class="jxr_string">" - "</span>).append(profileId); +<a class="jxr_linenumber" name="L106" href="#L106">106</a> message.append(<span class="jxr_string">" (source: "</span>).append(entry.getKey()).append(<span class="jxr_string">")"</span>); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> } +<a class="jxr_linenumber" name="L108" href="#L108">108</a> } +<a class="jxr_linenumber" name="L109" href="#L109">109</a> } +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> message.append(LS); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> } +<a class="jxr_linenumber" name="L113" href="#L113">113</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2001–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> </html> \ No newline at end of file
