Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AllProfilesMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AllProfilesMojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AllProfilesMojo.html Sun Jun 2 15:20:18 2024 @@ -1,177 +1,177 @@ -<!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>AllProfilesMojo xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/AllProfilesMojo.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.HashMap; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Map; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Profile; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; -<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> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.SettingsUtils; -<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"> * Displays a list of available profiles under the current project.</em> -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <br></em> -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <b>Note</b>: it will list <b>all</b> profiles for a project. If a</em> -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * profile comes up with a status <b>inactive</b> then there might be a need to</em> -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * set profile activation switches/property.</em> -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:rahul.thakur.x...@gmail.com"; target="alexandria_uri">mailto:rahul.thakur.x...@gmail.com</a>">Rahul Thakur</a></em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @since 2.1</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> @Mojo(name = <span class="jxr_string">"all-profiles"</span>, requiresProject = false) -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="AllProfilesMojo" href="../../../../../org/apache/maven/plugins/help/AllProfilesMojo.html#AllProfilesMojo">AllProfilesMojo</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="L46" href="#L46">46</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_comment">// Mojo parameters</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * This is the list of projects currently slated to be built by Maven.</em> -<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> @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="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> List<MavenProject> projects; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * The list of profiles defined in the current Maven settings.</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> @Parameter(defaultValue = <span class="jxr_string">"${settings.profiles}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> List<org.apache.maven.settings.Profile> settingsProfiles; -<a class="jxr_linenumber" name="L61" href="#L61">61</a> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_comment">// Public methods</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { -<a class="jxr_linenumber" name="L68" href="#L68">68</a> StringBuilder descriptionBuffer = <strong class="jxr_keyword">new</strong> StringBuilder(); -<a class="jxr_linenumber" name="L69" href="#L69">69</a> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">for</strong> (MavenProject project : projects) { -<a class="jxr_linenumber" name="L71" href="#L71">71</a> descriptionBuffer -<a class="jxr_linenumber" name="L72" href="#L72">72</a> .append(<span class="jxr_string">"Listing Profiles for Project: "</span>) -<a class="jxr_linenumber" name="L73" href="#L73">73</a> .append(project.getId()) -<a class="jxr_linenumber" name="L74" href="#L74">74</a> .append(LS); -<a class="jxr_linenumber" name="L75" href="#L75">75</a> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> Map<String, Profile> allProfilesByIds = <strong class="jxr_keyword">new</strong> HashMap<>(); -<a class="jxr_linenumber" name="L77" href="#L77">77</a> Map<String, Profile> activeProfilesByIds = <strong class="jxr_keyword">new</strong> HashMap<>(); -<a class="jxr_linenumber" name="L78" href="#L78">78</a> addSettingsProfiles(allProfilesByIds); -<a class="jxr_linenumber" name="L79" href="#L79">79</a> addProjectPomProfiles(project, allProfilesByIds, activeProfilesByIds); -<a class="jxr_linenumber" name="L80" href="#L80">80</a> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">// now display</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">if</strong> (allProfilesByIds.isEmpty()) { -<a class="jxr_linenumber" name="L83" href="#L83">83</a> getLog().warn(<span class="jxr_string">"No profiles detected!"</span>); -<a class="jxr_linenumber" name="L84" href="#L84">84</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">// active Profiles will be a subset of *all* profiles</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> allProfilesByIds.keySet().removeAll(activeProfilesByIds.keySet()); -<a class="jxr_linenumber" name="L87" href="#L87">87</a> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> writeProfilesDescription(descriptionBuffer, activeProfilesByIds, <strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L89" href="#L89">89</a> writeProfilesDescription(descriptionBuffer, allProfilesByIds, false); -<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> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">if</strong> (output != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L95" href="#L95">95</a> writeFile(output, descriptionBuffer); -<a class="jxr_linenumber" name="L96" href="#L96">96</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot write profiles description to output: "</span> + output, e); -<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> getLog().info(<span class="jxr_string">"Wrote descriptions to: "</span> + output); -<a class="jxr_linenumber" name="L101" href="#L101">101</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L102" href="#L102">102</a> getLog().info(descriptionBuffer.toString()); -<a class="jxr_linenumber" name="L103" href="#L103">103</a> } -<a class="jxr_linenumber" name="L104" href="#L104">104</a> } -<a class="jxr_linenumber" name="L105" href="#L105">105</a> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_comment">// Private methods</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProfilesDescription(StringBuilder sb, Map<String, Profile> profilesByIds, <strong class="jxr_keyword">boolean</strong> active) { -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">for</strong> (Profile p : profilesByIds.values()) { -<a class="jxr_linenumber" name="L112" href="#L112">112</a> sb.append(<span class="jxr_string">" Profile Id: "</span>).append(p.getId()); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> sb.append(<span class="jxr_string">" (Active: "</span>) -<a class="jxr_linenumber" name="L114" href="#L114">114</a> .append(active) -<a class="jxr_linenumber" name="L115" href="#L115">115</a> .append(<span class="jxr_string">", Source: "</span>) -<a class="jxr_linenumber" name="L116" href="#L116">116</a> .append(p.getSource()) -<a class="jxr_linenumber" name="L117" href="#L117">117</a> .append(<span class="jxr_string">")"</span>); -<a class="jxr_linenumber" name="L118" href="#L118">118</a> sb.append(LS); -<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"> * Adds the profiles from <code>pom.xml</code> and all of its parents.</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 project could be null</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param allProfiles Map to add the profiles to.</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @param activeProfiles Map to add the active profiles to.</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">private</strong> <strong class="jxr_keyword">void</strong> addProjectPomProfiles( -<a class="jxr_linenumber" name="L130" href="#L130">130</a> MavenProject project, Map<String, Profile> allProfiles, Map<String, Profile> activeProfiles) { -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">if</strong> (project == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_comment">// shouldn't happen as this mojo requires a project</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> getLog().debug(<span class="jxr_string">"No pom.xml found to read Profiles from."</span>); -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L135" href="#L135">135</a> } -<a class="jxr_linenumber" name="L136" href="#L136">136</a> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> getLog().debug(<span class="jxr_string">"Attempting to read profiles from pom.xml..."</span>); -<a class="jxr_linenumber" name="L138" href="#L138">138</a> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">while</strong> (project != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">for</strong> (Profile profile : project.getModel().getProfiles()) { -<a class="jxr_linenumber" name="L141" href="#L141">141</a> allProfiles.put(profile.getId(), profile); -<a class="jxr_linenumber" name="L142" href="#L142">142</a> } -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (project.getActiveProfiles() != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">for</strong> (Profile profile : project.getActiveProfiles()) { -<a class="jxr_linenumber" name="L145" href="#L145">145</a> activeProfiles.put(profile.getId(), profile); -<a class="jxr_linenumber" name="L146" href="#L146">146</a> } -<a class="jxr_linenumber" name="L147" href="#L147">147</a> } -<a class="jxr_linenumber" name="L148" href="#L148">148</a> project = project.getParent(); -<a class="jxr_linenumber" name="L149" href="#L149">149</a> } -<a class="jxr_linenumber" name="L150" href="#L150">150</a> } -<a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Adds the profiles from <code>settings.xml</code>.</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @param allProfiles Map to add the profiles to.</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addSettingsProfiles(Map<String, Profile> allProfiles) { -<a class="jxr_linenumber" name="L158" href="#L158">158</a> getLog().debug(<span class="jxr_string">"Attempting to read profiles from settings.xml..."</span>); -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">for</strong> (org.apache.maven.settings.Profile settingsProfile : settingsProfiles) { -<a class="jxr_linenumber" name="L160" href="#L160">160</a> Profile profile = SettingsUtils.convertFromSettingsProfile(settingsProfile); -<a class="jxr_linenumber" name="L161" href="#L161">161</a> allProfiles.put(profile.getId(), profile); -<a class="jxr_linenumber" name="L162" href="#L162">162</a> } -<a class="jxr_linenumber" name="L163" href="#L163">163</a> } -<a class="jxr_linenumber" name="L164" href="#L164">164</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>AllProfilesMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/AllProfilesMojo.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.HashMap; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Profile; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<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> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.SettingsUtils; +<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"> * Displays a list of available profiles under the current project.</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <br></em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <b>Note</b>: it will list <b>all</b> profiles for a project. If a</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * profile comes up with a status <b>inactive</b> then there might be a need to</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * set profile activation switches/property.</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:rahul.thakur.x...@gmail.com"; target="alexandria_uri">mailto:rahul.thakur.x...@gmail.com</a>">Rahul Thakur</a></em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @since 2.1</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> @Mojo(name = <span class="jxr_string">"all-profiles"</span>, requiresProject = false) +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="AllProfilesMojo" href="../../../../../org/apache/maven/plugins/help/AllProfilesMojo.html#AllProfilesMojo">AllProfilesMojo</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="L46" href="#L46">46</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_comment">// Mojo parameters</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * This is the list of projects currently slated to be built by Maven.</em> +<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> @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="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> List<MavenProject> projects; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * The list of profiles defined in the current Maven settings.</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> @Parameter(defaultValue = <span class="jxr_string">"${settings.profiles}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> List<org.apache.maven.settings.Profile> settingsProfiles; +<a class="jxr_linenumber" name="L61" href="#L61">61</a> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_comment">// Public methods</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { +<a class="jxr_linenumber" name="L68" href="#L68">68</a> StringBuilder descriptionBuffer = <strong class="jxr_keyword">new</strong> StringBuilder(); +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">for</strong> (MavenProject project : projects) { +<a class="jxr_linenumber" name="L71" href="#L71">71</a> descriptionBuffer +<a class="jxr_linenumber" name="L72" href="#L72">72</a> .append(<span class="jxr_string">"Listing Profiles for Project: "</span>) +<a class="jxr_linenumber" name="L73" href="#L73">73</a> .append(project.getId()) +<a class="jxr_linenumber" name="L74" href="#L74">74</a> .append(LS); +<a class="jxr_linenumber" name="L75" href="#L75">75</a> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> Map<String, Profile> allProfilesByIds = <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L77" href="#L77">77</a> Map<String, Profile> activeProfilesByIds = <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L78" href="#L78">78</a> addSettingsProfiles(allProfilesByIds); +<a class="jxr_linenumber" name="L79" href="#L79">79</a> addProjectPomProfiles(project, allProfilesByIds, activeProfilesByIds); +<a class="jxr_linenumber" name="L80" href="#L80">80</a> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">// now display</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">if</strong> (allProfilesByIds.isEmpty()) { +<a class="jxr_linenumber" name="L83" href="#L83">83</a> getLog().warn(<span class="jxr_string">"No profiles detected!"</span>); +<a class="jxr_linenumber" name="L84" href="#L84">84</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">// active Profiles will be a subset of *all* profiles</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> allProfilesByIds.keySet().removeAll(activeProfilesByIds.keySet()); +<a class="jxr_linenumber" name="L87" href="#L87">87</a> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> writeProfilesDescription(descriptionBuffer, activeProfilesByIds, <strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L89" href="#L89">89</a> writeProfilesDescription(descriptionBuffer, allProfilesByIds, false); +<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> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">if</strong> (output != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L95" href="#L95">95</a> writeFile(output, descriptionBuffer); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot write profiles description to output: "</span> + output, e); +<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> getLog().info(<span class="jxr_string">"Wrote descriptions to: "</span> + output); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L102" href="#L102">102</a> getLog().info(descriptionBuffer.toString()); +<a class="jxr_linenumber" name="L103" href="#L103">103</a> } +<a class="jxr_linenumber" name="L104" href="#L104">104</a> } +<a class="jxr_linenumber" name="L105" href="#L105">105</a> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_comment">// Private methods</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProfilesDescription(StringBuilder sb, Map<String, Profile> profilesByIds, <strong class="jxr_keyword">boolean</strong> active) { +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">for</strong> (Profile p : profilesByIds.values()) { +<a class="jxr_linenumber" name="L112" href="#L112">112</a> sb.append(<span class="jxr_string">" Profile Id: "</span>).append(p.getId()); +<a class="jxr_linenumber" name="L113" href="#L113">113</a> sb.append(<span class="jxr_string">" (Active: "</span>) +<a class="jxr_linenumber" name="L114" href="#L114">114</a> .append(active) +<a class="jxr_linenumber" name="L115" href="#L115">115</a> .append(<span class="jxr_string">", Source: "</span>) +<a class="jxr_linenumber" name="L116" href="#L116">116</a> .append(p.getSource()) +<a class="jxr_linenumber" name="L117" href="#L117">117</a> .append(<span class="jxr_string">")"</span>); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> sb.append(LS); +<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"> * Adds the profiles from <code>pom.xml</code> and all of its parents.</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 project could be null</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param allProfiles Map to add the profiles to.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @param activeProfiles Map to add the active profiles to.</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">private</strong> <strong class="jxr_keyword">void</strong> addProjectPomProfiles( +<a class="jxr_linenumber" name="L130" href="#L130">130</a> MavenProject project, Map<String, Profile> allProfiles, Map<String, Profile> activeProfiles) { +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">if</strong> (project == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_comment">// shouldn't happen as this mojo requires a project</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> getLog().debug(<span class="jxr_string">"No pom.xml found to read Profiles from."</span>); +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> } +<a class="jxr_linenumber" name="L136" href="#L136">136</a> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> getLog().debug(<span class="jxr_string">"Attempting to read profiles from pom.xml..."</span>); +<a class="jxr_linenumber" name="L138" href="#L138">138</a> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">while</strong> (project != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">for</strong> (Profile profile : project.getModel().getProfiles()) { +<a class="jxr_linenumber" name="L141" href="#L141">141</a> allProfiles.put(profile.getId(), profile); +<a class="jxr_linenumber" name="L142" href="#L142">142</a> } +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (project.getActiveProfiles() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">for</strong> (Profile profile : project.getActiveProfiles()) { +<a class="jxr_linenumber" name="L145" href="#L145">145</a> activeProfiles.put(profile.getId(), profile); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> } +<a class="jxr_linenumber" name="L147" href="#L147">147</a> } +<a class="jxr_linenumber" name="L148" href="#L148">148</a> project = project.getParent(); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> } +<a class="jxr_linenumber" name="L150" href="#L150">150</a> } +<a class="jxr_linenumber" name="L151" href="#L151">151</a> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Adds the profiles from <code>settings.xml</code>.</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @param allProfiles Map to add the profiles to.</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addSettingsProfiles(Map<String, Profile> allProfiles) { +<a class="jxr_linenumber" name="L158" href="#L158">158</a> getLog().debug(<span class="jxr_string">"Attempting to read profiles from settings.xml..."</span>); +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">for</strong> (org.apache.maven.settings.Profile settingsProfile : settingsProfiles) { +<a class="jxr_linenumber" name="L160" href="#L160">160</a> Profile profile = SettingsUtils.convertFromSettingsProfile(settingsProfile); +<a class="jxr_linenumber" name="L161" href="#L161">161</a> allProfiles.put(profile.getId(), profile); +<a class="jxr_linenumber" name="L162" href="#L162">162</a> } +<a class="jxr_linenumber" name="L163" href="#L163">163</a> } +<a class="jxr_linenumber" name="L164" href="#L164">164</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
