Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/EffectivePomMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/EffectivePomMojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/EffectivePomMojo.html Sun Jun 2 15:20:18 2024 @@ -1,234 +1,234 @@ -<!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>EffectivePomMojo xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/EffectivePomMojo.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.io.StringWriter; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Collections; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Properties; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.InputLocation; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.InputSource; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Model; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.io.xpp3.MavenXpp3Writer; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.io.xpp3.MavenXpp3WriterEx; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecution; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecution.Source; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.logging.MessageUtils; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.PrettyPrintXMLWriter; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XMLWriter; -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XmlWriterUtil; -<a class="jxr_linenumber" name="L43" href="#L43">43</a> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Displays the effective POM as an XML for this build, with the active profiles factored in, or a specified artifact.</em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * If <code>verbose</code>, a comment is added to each XML element describing the origin of the line.</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> @Mojo(name = <span class="jxr_string">"effective-pom"</span>, aggregator = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="EffectivePomMojo" href="../../../../../org/apache/maven/plugins/help/EffectivePomMojo.html#EffectivePomMojo">EffectivePomMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractEffectiveMojo" href="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.html#AbstractEffectiveMojo">AbstractEffectiveMojo</a> { -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_comment">// Mojo parameters</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<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 projects in the current build. The effective-POM for</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * each of these projects will written.</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Parameter(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="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> List<MavenProject> projects; -<a class="jxr_linenumber" name="L62" href="#L62">62</a> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * This mojo execution, used to determine if it was launched from the lifecycle or the command-line.</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Parameter(defaultValue = <span class="jxr_string">"${mojo}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> MojoExecution mojoExecution; -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * The artifact for which to display the effective POM.</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * <br></em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Should respect the Maven format, i.e. <code>groupId:artifactId[:version]</code>. The</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * latest version of the artifact will be used when no version is specified.</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @since 3.0.0</em> -<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> @Parameter(property = <span class="jxr_string">"artifact"</span>) -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> String artifact; -<a class="jxr_linenumber" name="L79" href="#L79">79</a> -<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> <em class="jxr_javadoccomment"> * Output POM input location as comments.</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @since 3.2.0</em> -<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> @Parameter(property = <span class="jxr_string">"verbose"</span>, defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> verbose = false; -<a class="jxr_linenumber" name="L87" href="#L87">87</a> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// Public methods</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L93" href="#L93">93</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="L94" href="#L94">94</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotEmpty(artifact)) { -<a class="jxr_linenumber" name="L95" href="#L95">95</a> project = getMavenProject(artifact); -<a class="jxr_linenumber" name="L96" href="#L96">96</a> projects = Collections.singletonList(project); -<a class="jxr_linenumber" name="L97" href="#L97">97</a> } -<a class="jxr_linenumber" name="L98" href="#L98">98</a> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> StringWriter w = <strong class="jxr_keyword">new</strong> StringWriter(); -<a class="jxr_linenumber" name="L100" href="#L100">100</a> String encoding = output != <strong class="jxr_keyword">null</strong> ? project.getModel().getModelEncoding() : System.getProperty(<span class="jxr_string">"file.encoding"</span>); -<a class="jxr_linenumber" name="L101" href="#L101">101</a> XMLWriter writer = <strong class="jxr_keyword">new</strong> PrettyPrintXMLWriter( -<a class="jxr_linenumber" name="L102" href="#L102">102</a> w, StringUtils.repeat(<span class="jxr_string">" "</span>, XmlWriterUtil.DEFAULT_INDENTATION_SIZE), encoding, <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L103" href="#L103">103</a> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> writeHeader(writer); -<a class="jxr_linenumber" name="L105" href="#L105">105</a> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> (shouldWriteAllEffectivePOMsInReactor()) { -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_comment">// outer root element</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> writer.startElement(<span class="jxr_string">"projects"</span>); -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">for</strong> (MavenProject subProject : projects) { -<a class="jxr_linenumber" name="L110" href="#L110">110</a> writeEffectivePom(subProject, writer); -<a class="jxr_linenumber" name="L111" href="#L111">111</a> } -<a class="jxr_linenumber" name="L112" href="#L112">112</a> writer.endElement(); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L114" href="#L114">114</a> writeEffectivePom(project, writer); -<a class="jxr_linenumber" name="L115" href="#L115">115</a> } -<a class="jxr_linenumber" name="L116" href="#L116">116</a> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> String effectivePom = prettyFormat(w.toString(), encoding, false); -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">if</strong> (verbose) { -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment">// tweak location tracking comment, that are put on a separate line by pretty print</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> effectivePom = effectivePom.replaceAll(<span class="jxr_string">"(?m)>\\s+<!--}"</span>, <span class="jxr_string">"> <!-- "</span>); -<a class="jxr_linenumber" name="L121" href="#L121">121</a> } -<a class="jxr_linenumber" name="L122" href="#L122">122</a> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">if</strong> (output != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L125" href="#L125">125</a> writeXmlFile(output, effectivePom); -<a class="jxr_linenumber" name="L126" href="#L126">126</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot write effective-POM to output: "</span> + output, e); -<a class="jxr_linenumber" name="L128" href="#L128">128</a> } -<a class="jxr_linenumber" name="L129" href="#L129">129</a> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> getLog().info(<span class="jxr_string">"Effective-POM written to: "</span> + output); -<a class="jxr_linenumber" name="L131" href="#L131">131</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">if</strong> (MessageUtils.isColorEnabled()) { -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_comment">// add color to comments</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> String comment = MessageUtils.buffer().project(<span class="jxr_string">"<!--.-->"</span>).toString(); -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">int</strong> dotIndex = comment.indexOf(<span class="jxr_string">"."</span>); -<a class="jxr_linenumber" name="L136" href="#L136">136</a> String commentStart = comment.substring(0, dotIndex); -<a class="jxr_linenumber" name="L137" href="#L137">137</a> String commentEnd = comment.substring(dotIndex + 1); -<a class="jxr_linenumber" name="L138" href="#L138">138</a> effectivePom = effectivePom.replace(<span class="jxr_string">"<!--"</span>, commentStart).replace(<span class="jxr_string">"-->"</span>, commentEnd); -<a class="jxr_linenumber" name="L139" href="#L139">139</a> } -<a class="jxr_linenumber" name="L140" href="#L140">140</a> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> getLog().info(LS + <span class="jxr_string">"Effective POMs, after inheritance, interpolation, and profiles are applied:"</span> + LS + LS -<a class="jxr_linenumber" name="L142" href="#L142">142</a> + effectivePom + LS); -<a class="jxr_linenumber" name="L143" href="#L143">143</a> } -<a class="jxr_linenumber" name="L144" href="#L144">144</a> } -<a class="jxr_linenumber" name="L145" href="#L145">145</a> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Determines if all effective POMs of all the projects in the reactor should be written. When this goal is started</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * on the command-line, it is always the case. However, when it is bound to a phase in the lifecycle, it is only the</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * case when the current project being built is the head project in the reactor.</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if all effective POMs should be written, <code>false</code> otherwise.</em> -<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> shouldWriteAllEffectivePOMsInReactor() { -<a class="jxr_linenumber" name="L154" href="#L154">154</a> Source source = mojoExecution.getSource(); -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_comment">// [MNG-5550] For Maven < 3.2.1, the source is null, instead of LIFECYCLE: only rely on comparisons with CLI</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> projects.size() > 1 && (source == Source.CLI || projects.get(0).equals(project)); -<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_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_comment">// Private methods</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Method for writing the effective pom informations of the current build.</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @param project the project of the current build, not null.</em> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @param writer the XML writer , not null, not null.</em> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if any</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeEffectivePom(MavenProject project, XMLWriter writer) <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L171" href="#L171">171</a> Model pom = project.getModel(); -<a class="jxr_linenumber" name="L172" href="#L172">172</a> cleanModel(pom); -<a class="jxr_linenumber" name="L173" href="#L173">173</a> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> StringWriter sWriter = <strong class="jxr_keyword">new</strong> StringWriter(); -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">if</strong> (verbose) { -<a class="jxr_linenumber" name="L177" href="#L177">177</a> MavenXpp3WriterEx mavenXpp3WriterEx = <strong class="jxr_keyword">new</strong> MavenXpp3WriterEx(); -<a class="jxr_linenumber" name="L178" href="#L178">178</a> mavenXpp3WriterEx.setStringFormatter(<strong class="jxr_keyword">new</strong> InputLocationStringFormatter()); -<a class="jxr_linenumber" name="L179" href="#L179">179</a> mavenXpp3WriterEx.write(sWriter, pom); -<a class="jxr_linenumber" name="L180" href="#L180">180</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">new</strong> MavenXpp3Writer().write(sWriter, pom); -<a class="jxr_linenumber" name="L182" href="#L182">182</a> } -<a class="jxr_linenumber" name="L183" href="#L183">183</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot serialize POM to XML."</span>, 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> <em class="jxr_comment">// This removes the XML declaration written by MavenXpp3Writer</em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> String effectivePom = prettyFormat(sWriter.toString(), <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L189" href="#L189">189</a> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> writeComment(writer, <span class="jxr_string">"Effective POM for project '"</span> + project.getId() + <span class="jxr_string">"'"</span>); -<a class="jxr_linenumber" name="L191" href="#L191">191</a> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> writer.writeMarkup(effectivePom); -<a class="jxr_linenumber" name="L193" href="#L193">193</a> } -<a class="jxr_linenumber" name="L194" href="#L194">194</a> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * Apply some logic to clean the model before writing it.</em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * @param pom not null</em> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> cleanModel(Model pom) { -<a class="jxr_linenumber" name="L201" href="#L201">201</a> Properties properties = <strong class="jxr_keyword">new</strong> SortedProperties(); -<a class="jxr_linenumber" name="L202" href="#L202">202</a> properties.putAll(pom.getProperties()); -<a class="jxr_linenumber" name="L203" href="#L203">203</a> pom.setProperties(properties); -<a class="jxr_linenumber" name="L204" href="#L204">204</a> } -<a class="jxr_linenumber" name="L205" href="#L205">205</a> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> InputLocationStringFormatter <strong class="jxr_keyword">extends</strong> InputLocation.StringFormatter { -<a class="jxr_linenumber" name="L207" href="#L207">207</a> @Override -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">public</strong> String toString(InputLocation location) { -<a class="jxr_linenumber" name="L209" href="#L209">209</a> InputSource source = location.getSource(); -<a class="jxr_linenumber" name="L210" href="#L210">210</a> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> String s = source.getModelId(); <em class="jxr_comment">// by default, display modelId</em> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">if</strong> (StringUtils.isBlank(s) || s.contains(<span class="jxr_string">"[unknown-version]"</span>)) { -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_comment">// unless it is blank or does not provide version information</em> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> s = source.toString(); -<a class="jxr_linenumber" name="L216" href="#L216">216</a> } -<a class="jxr_linenumber" name="L217" href="#L217">217</a> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">return</strong> '}' + s + ((location.getLineNumber() >= 0) ? <span class="jxr_string">", line "</span> + location.getLineNumber() : <span class="jxr_string">""</span>) + ' '; -<a class="jxr_linenumber" name="L219" href="#L219">219</a> } -<a class="jxr_linenumber" name="L220" href="#L220">220</a> } -<a class="jxr_linenumber" name="L221" href="#L221">221</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>EffectivePomMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/EffectivePomMojo.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.io.StringWriter; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Collections; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Properties; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.InputLocation; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.InputSource; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Model; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.io.xpp3.MavenXpp3Writer; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.io.xpp3.MavenXpp3WriterEx; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecution; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecution.Source; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.logging.MessageUtils; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.PrettyPrintXMLWriter; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XMLWriter; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XmlWriterUtil; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Displays the effective POM as an XML for this build, with the active profiles factored in, or a specified artifact.</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * If <code>verbose</code>, a comment is added to each XML element describing the origin of the line.</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> @Mojo(name = <span class="jxr_string">"effective-pom"</span>, aggregator = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="EffectivePomMojo" href="../../../../../org/apache/maven/plugins/help/EffectivePomMojo.html#EffectivePomMojo">EffectivePomMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractEffectiveMojo" href="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.html#AbstractEffectiveMojo">AbstractEffectiveMojo</a> { +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_comment">// Mojo parameters</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<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 projects in the current build. The effective-POM for</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * each of these projects will written.</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Parameter(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="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> List<MavenProject> projects; +<a class="jxr_linenumber" name="L62" href="#L62">62</a> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * This mojo execution, used to determine if it was launched from the lifecycle or the command-line.</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Parameter(defaultValue = <span class="jxr_string">"${mojo}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> MojoExecution mojoExecution; +<a class="jxr_linenumber" name="L68" href="#L68">68</a> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * The artifact for which to display the effective POM.</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * <br></em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Should respect the Maven format, i.e. <code>groupId:artifactId[:version]</code>. The</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * latest version of the artifact will be used when no version is specified.</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @since 3.0.0</em> +<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> @Parameter(property = <span class="jxr_string">"artifact"</span>) +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> String artifact; +<a class="jxr_linenumber" name="L79" href="#L79">79</a> +<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> <em class="jxr_javadoccomment"> * Output POM input location as comments.</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @since 3.2.0</em> +<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> @Parameter(property = <span class="jxr_string">"verbose"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> verbose = false; +<a class="jxr_linenumber" name="L87" href="#L87">87</a> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// Public methods</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</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="L94" href="#L94">94</a> <strong class="jxr_keyword">if</strong> (artifact != <strong class="jxr_keyword">null</strong> && !artifact.isEmpty()) { +<a class="jxr_linenumber" name="L95" href="#L95">95</a> project = getMavenProject(artifact); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> projects = Collections.singletonList(project); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> } +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> StringWriter w = <strong class="jxr_keyword">new</strong> StringWriter(); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> String encoding = output != <strong class="jxr_keyword">null</strong> ? project.getModel().getModelEncoding() : System.getProperty(<span class="jxr_string">"file.encoding"</span>); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> XMLWriter writer = <strong class="jxr_keyword">new</strong> PrettyPrintXMLWriter( +<a class="jxr_linenumber" name="L102" href="#L102">102</a> w, StringUtils.repeat(<span class="jxr_string">" "</span>, XmlWriterUtil.DEFAULT_INDENTATION_SIZE), encoding, <strong class="jxr_keyword">null</strong>); +<a class="jxr_linenumber" name="L103" href="#L103">103</a> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> writeHeader(writer); +<a class="jxr_linenumber" name="L105" href="#L105">105</a> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> (shouldWriteAllEffectivePOMsInReactor()) { +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_comment">// outer root element</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> writer.startElement(<span class="jxr_string">"projects"</span>); +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">for</strong> (MavenProject subProject : projects) { +<a class="jxr_linenumber" name="L110" href="#L110">110</a> writeEffectivePom(subProject, writer); +<a class="jxr_linenumber" name="L111" href="#L111">111</a> } +<a class="jxr_linenumber" name="L112" href="#L112">112</a> writer.endElement(); +<a class="jxr_linenumber" name="L113" href="#L113">113</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> writeEffectivePom(project, writer); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> } +<a class="jxr_linenumber" name="L116" href="#L116">116</a> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> String effectivePom = prettyFormat(w.toString(), encoding, false); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">if</strong> (verbose) { +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment">// tweak location tracking comment, that are put on a separate line by pretty print</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> effectivePom = effectivePom.replaceAll(<span class="jxr_string">"(?m)>\\s+<!--}"</span>, <span class="jxr_string">"> <!-- "</span>); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> } +<a class="jxr_linenumber" name="L122" href="#L122">122</a> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">if</strong> (output != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L125" href="#L125">125</a> writeXmlFile(output, effectivePom); +<a class="jxr_linenumber" name="L126" href="#L126">126</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot write effective-POM to output: "</span> + output, e); +<a class="jxr_linenumber" name="L128" href="#L128">128</a> } +<a class="jxr_linenumber" name="L129" href="#L129">129</a> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> getLog().info(<span class="jxr_string">"Effective-POM written to: "</span> + output); +<a class="jxr_linenumber" name="L131" href="#L131">131</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">if</strong> (MessageUtils.isColorEnabled()) { +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_comment">// add color to comments</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> String comment = MessageUtils.buffer().project(<span class="jxr_string">"<!--.-->"</span>).toString(); +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">int</strong> dotIndex = comment.indexOf(<span class="jxr_string">"."</span>); +<a class="jxr_linenumber" name="L136" href="#L136">136</a> String commentStart = comment.substring(0, dotIndex); +<a class="jxr_linenumber" name="L137" href="#L137">137</a> String commentEnd = comment.substring(dotIndex + 1); +<a class="jxr_linenumber" name="L138" href="#L138">138</a> effectivePom = effectivePom.replace(<span class="jxr_string">"<!--"</span>, commentStart).replace(<span class="jxr_string">"-->"</span>, commentEnd); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> } +<a class="jxr_linenumber" name="L140" href="#L140">140</a> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> getLog().info(LS + <span class="jxr_string">"Effective POMs, after inheritance, interpolation, and profiles are applied:"</span> + LS + LS +<a class="jxr_linenumber" name="L142" href="#L142">142</a> + effectivePom + LS); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> } +<a class="jxr_linenumber" name="L144" href="#L144">144</a> } +<a class="jxr_linenumber" name="L145" href="#L145">145</a> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Determines if all effective POMs of all the projects in the reactor should be written. When this goal is started</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * on the command-line, it is always the case. However, when it is bound to a phase in the lifecycle, it is only the</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * case when the current project being built is the head project in the reactor.</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if all effective POMs should be written, <code>false</code> otherwise.</em> +<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> shouldWriteAllEffectivePOMsInReactor() { +<a class="jxr_linenumber" name="L154" href="#L154">154</a> Source source = mojoExecution.getSource(); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_comment">// [MNG-5550] For Maven < 3.2.1, the source is null, instead of LIFECYCLE: only rely on comparisons with CLI</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> projects.size() > 1 && (source == Source.CLI || projects.get(0).equals(project)); +<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_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_comment">// Private methods</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Method for writing the effective pom informations of the current build.</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @param project the project of the current build, not null.</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @param writer the XML writer , not null, not null.</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if any</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeEffectivePom(MavenProject project, XMLWriter writer) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L171" href="#L171">171</a> Model pom = project.getModel(); +<a class="jxr_linenumber" name="L172" href="#L172">172</a> cleanModel(pom); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> StringWriter sWriter = <strong class="jxr_keyword">new</strong> StringWriter(); +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">if</strong> (verbose) { +<a class="jxr_linenumber" name="L177" href="#L177">177</a> MavenXpp3WriterEx mavenXpp3WriterEx = <strong class="jxr_keyword">new</strong> MavenXpp3WriterEx(); +<a class="jxr_linenumber" name="L178" href="#L178">178</a> mavenXpp3WriterEx.setStringFormatter(<strong class="jxr_keyword">new</strong> InputLocationStringFormatter()); +<a class="jxr_linenumber" name="L179" href="#L179">179</a> mavenXpp3WriterEx.write(sWriter, pom); +<a class="jxr_linenumber" name="L180" href="#L180">180</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">new</strong> MavenXpp3Writer().write(sWriter, pom); +<a class="jxr_linenumber" name="L182" href="#L182">182</a> } +<a class="jxr_linenumber" name="L183" href="#L183">183</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot serialize POM to XML."</span>, 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> <em class="jxr_comment">// This removes the XML declaration written by MavenXpp3Writer</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> String effectivePom = prettyFormat(sWriter.toString(), <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L189" href="#L189">189</a> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> writeComment(writer, <span class="jxr_string">"Effective POM for project '"</span> + project.getId() + <span class="jxr_string">"'"</span>); +<a class="jxr_linenumber" name="L191" href="#L191">191</a> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> writer.writeMarkup(effectivePom); +<a class="jxr_linenumber" name="L193" href="#L193">193</a> } +<a class="jxr_linenumber" name="L194" href="#L194">194</a> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * Apply some logic to clean the model before writing it.</em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * @param pom not null</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> cleanModel(Model pom) { +<a class="jxr_linenumber" name="L201" href="#L201">201</a> Properties properties = <strong class="jxr_keyword">new</strong> SortedProperties(); +<a class="jxr_linenumber" name="L202" href="#L202">202</a> properties.putAll(pom.getProperties()); +<a class="jxr_linenumber" name="L203" href="#L203">203</a> pom.setProperties(properties); +<a class="jxr_linenumber" name="L204" href="#L204">204</a> } +<a class="jxr_linenumber" name="L205" href="#L205">205</a> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> InputLocationStringFormatter <strong class="jxr_keyword">extends</strong> InputLocation.StringFormatter { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> @Override +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">public</strong> String toString(InputLocation location) { +<a class="jxr_linenumber" name="L209" href="#L209">209</a> InputSource source = location.getSource(); +<a class="jxr_linenumber" name="L210" href="#L210">210</a> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> String s = source.getModelId(); <em class="jxr_comment">// by default, display modelId</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">if</strong> (StringUtils.isBlank(s) || s.contains(<span class="jxr_string">"[unknown-version]"</span>)) { +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_comment">// unless it is blank or does not provide version information</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> s = source.toString(); +<a class="jxr_linenumber" name="L216" href="#L216">216</a> } +<a class="jxr_linenumber" name="L217" href="#L217">217</a> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">return</strong> '}' + s + ((location.getLineNumber() >= 0) ? <span class="jxr_string">", line "</span> + location.getLineNumber() : <span class="jxr_string">""</span>) + ' '; +<a class="jxr_linenumber" name="L219" href="#L219">219</a> } +<a class="jxr_linenumber" name="L220" href="#L220">220</a> } +<a class="jxr_linenumber" name="L221" href="#L221">221</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
