Modified: websites/production/maven/content/plugins/maven-help-plugin/xref/org/apache/maven/plugins/help/EffectivePomMojo.html ============================================================================== --- websites/production/maven/content/plugins/maven-help-plugin/xref/org/apache/maven/plugins/help/EffectivePomMojo.html (original) +++ websites/production/maven/content/plugins/maven-help-plugin/xref/org/apache/maven/plugins/help/EffectivePomMojo.html Sat Feb 23 22:01:58 2013 @@ -1,238 +1,231 @@ -<!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=ISO-8859-1" /> -<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 name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; -<a name="2" href="#2">2</a> -<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em> -<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> -<a name="12" href="#12">12</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 name="13" href="#13">13</a> <em class="jxr_comment"> *</em> -<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em> -<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em> -<a name="21" href="#21">21</a> -<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.StringReader; -<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.StringWriter; -<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; -<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Properties; -<a name="28" href="#28">28</a> -<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Model; -<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.io.xpp3.MavenXpp3Writer; -<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.PrettyPrintXMLWriter; -<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XMLWriter; -<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XmlWriterUtil; -<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.jdom.Document; -<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.jdom.JDOMException; -<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.jdom.input.SAXBuilder; -<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.jdom.output.Format; -<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.jdom.output.XMLOutputter; -<a name="42" href="#42">42</a> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em> -<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Displays the effective POM as an XML for this build, with the active profiles factored in.</em> -<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> *</em> -<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @version $Id: EffectivePomMojo.java 688495 2008-08-24 11:11:01Z vsiveton $</em> -<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @goal effective-pom</em> -<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @aggregator</em> -<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em> -<a name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/help/EffectivePomMojo.html">EffectivePomMojo</a> -<a name="52" href="#52">52</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.html">AbstractEffectiveMojo</a> -<a name="53" href="#53">53</a> { -<a name="54" href="#54">54</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="55" href="#55">55</a> <em class="jxr_comment">// Mojo parameters</em> -<a name="56" href="#56">56</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="57" href="#57">57</a> -<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em> -<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * The Maven project.</em> -<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em> -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @since 2.0.2</em> -<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @parameter expression="${project}"</em> -<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> -<a name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> MavenProject project; -<a name="67" href="#67">67</a> -<a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em> -<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * The projects in the current build. The effective-POM for</em> -<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * each of these projects will written.</em> -<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @parameter expression="${reactorProjects}"</em> -<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> -<a name="76" href="#76">76</a> <strong class="jxr_keyword">private</strong> List projects; -<a name="77" href="#77">77</a> -<a name="78" href="#78">78</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="79" href="#79">79</a> <em class="jxr_comment">// Public methods</em> -<a name="80" href="#80">80</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="81" href="#81">81</a> -<a name="82" href="#82">82</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="83" href="#83">83</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() -<a name="84" href="#84">84</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException -<a name="85" href="#85">85</a> { -<a name="86" href="#86">86</a> StringWriter w = <strong class="jxr_keyword">new</strong> StringWriter(); -<a name="87" href="#87">87</a> XMLWriter writer = -<a name="88" href="#88">88</a> <strong class="jxr_keyword">new</strong> PrettyPrintXMLWriter( w, StringUtils.repeat( <span class="jxr_string">" "</span>, XmlWriterUtil.DEFAULT_INDENTATION_SIZE ), -<a name="89" href="#89">89</a> project.getModel().getModelEncoding(), <strong class="jxr_keyword">null</strong> ); -<a name="90" href="#90">90</a> -<a name="91" href="#91">91</a> writeHeader( writer ); -<a name="92" href="#92">92</a> -<a name="93" href="#93">93</a> String effectivePom; -<a name="94" href="#94">94</a> <strong class="jxr_keyword">if</strong> ( projects.get( 0 ).equals( project ) && projects.size() > 1 ) -<a name="95" href="#95">95</a> { -<a name="96" href="#96">96</a> <em class="jxr_comment">// outer root element</em> -<a name="97" href="#97">97</a> writer.startElement( <span class="jxr_string">"projects"</span> ); -<a name="98" href="#98">98</a> <strong class="jxr_keyword">for</strong> ( Iterator it = projects.iterator(); it.hasNext(); ) -<a name="99" href="#99">99</a> { -<a name="100" href="#100">100</a> MavenProject subProject = (MavenProject) it.next(); -<a name="101" href="#101">101</a> -<a name="102" href="#102">102</a> writeEffectivePom( subProject, writer ); -<a name="103" href="#103">103</a> } -<a name="104" href="#104">104</a> writer.endElement(); -<a name="105" href="#105">105</a> -<a name="106" href="#106">106</a> effectivePom = w.toString(); -<a name="107" href="#107">107</a> effectivePom = prettyFormat( effectivePom ); -<a name="108" href="#108">108</a> } -<a name="109" href="#109">109</a> <strong class="jxr_keyword">else</strong> -<a name="110" href="#110">110</a> { -<a name="111" href="#111">111</a> writeEffectivePom( project, writer ); -<a name="112" href="#112">112</a> -<a name="113" href="#113">113</a> effectivePom = w.toString(); -<a name="114" href="#114">114</a> } -<a name="115" href="#115">115</a> -<a name="116" href="#116">116</a> <strong class="jxr_keyword">if</strong> ( output != <strong class="jxr_keyword">null</strong> ) -<a name="117" href="#117">117</a> { -<a name="118" href="#118">118</a> <strong class="jxr_keyword">try</strong> -<a name="119" href="#119">119</a> { -<a name="120" href="#120">120</a> writeXmlFile( output, effectivePom, project.getModel().getModelEncoding() ); -<a name="121" href="#121">121</a> } -<a name="122" href="#122">122</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a name="123" href="#123">123</a> { -<a name="124" href="#124">124</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 name="125" href="#125">125</a> } -<a name="126" href="#126">126</a> -<a name="127" href="#127">127</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() ) -<a name="128" href="#128">128</a> { -<a name="129" href="#129">129</a> getLog().info( <span class="jxr_string">"Effective-POM written to: "</span> + output ); -<a name="130" href="#130">130</a> } -<a name="131" href="#131">131</a> } -<a name="132" href="#132">132</a> <strong class="jxr_keyword">else</strong> -<a name="133" href="#133">133</a> { -<a name="134" href="#134">134</a> StringBuffer message = <strong class="jxr_keyword">new</strong> StringBuffer(); -<a name="135" href="#135">135</a> -<a name="136" href="#136">136</a> message.append( <span class="jxr_string">"\nEffective POMs, after inheritance, interpolation, and profiles are applied:\n\n"</span> ); -<a name="137" href="#137">137</a> message.append( effectivePom ); -<a name="138" href="#138">138</a> message.append( <span class="jxr_string">"\n"</span> ); -<a name="139" href="#139">139</a> -<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() ) -<a name="141" href="#141">141</a> { -<a name="142" href="#142">142</a> getLog().info( message.toString() ); -<a name="143" href="#143">143</a> } -<a name="144" href="#144">144</a> } -<a name="145" href="#145">145</a> } -<a name="146" href="#146">146</a> -<a name="147" href="#147">147</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="148" href="#148">148</a> <em class="jxr_comment">// Private methods</em> -<a name="149" href="#149">149</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="150" href="#150">150</a> -<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">/**</em> -<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * Method for writing the effective pom informations of the current build.</em> -<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> *</em> -<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * @param project the project of the current build, not null.</em> -<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * @param writer the XML writer , not null, not null.</em> -<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if any</em> -<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> */</em> -<a name="158" href="#158">158</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeEffectivePom( MavenProject project, XMLWriter writer ) -<a name="159" href="#159">159</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException -<a name="160" href="#160">160</a> { -<a name="161" href="#161">161</a> Model pom = project.getModel(); -<a name="162" href="#162">162</a> cleanModel( pom ); -<a name="163" href="#163">163</a> -<a name="164" href="#164">164</a> String effectivePom; -<a name="165" href="#165">165</a> -<a name="166" href="#166">166</a> StringWriter sWriter = <strong class="jxr_keyword">new</strong> StringWriter(); -<a name="167" href="#167">167</a> MavenXpp3Writer pomWriter = <strong class="jxr_keyword">new</strong> MavenXpp3Writer(); -<a name="168" href="#168">168</a> <strong class="jxr_keyword">try</strong> -<a name="169" href="#169">169</a> { -<a name="170" href="#170">170</a> pomWriter.write( sWriter, pom ); -<a name="171" href="#171">171</a> } -<a name="172" href="#172">172</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a name="173" href="#173">173</a> { -<a name="174" href="#174">174</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 name="175" href="#175">175</a> } -<a name="176" href="#176">176</a> -<a name="177" href="#177">177</a> effectivePom = addMavenNamespace( sWriter.toString(), <strong class="jxr_keyword">true</strong> ); -<a name="178" href="#178">178</a> -<a name="179" href="#179">179</a> writeComment( writer, <span class="jxr_string">"Effective POM for project \'"</span> + project.getId() + <span class="jxr_string">"\'"</span> ); -<a name="180" href="#180">180</a> -<a name="181" href="#181">181</a> writer.writeMarkup( effectivePom ); -<a name="182" href="#182">182</a> } -<a name="183" href="#183">183</a> -<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">/**</em> -<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * Apply some logic to clean the model before writing it.</em> -<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> *</em> -<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * @param pom not null</em> -<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> */</em> -<a name="189" href="#189">189</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> cleanModel( Model pom ) -<a name="190" href="#190">190</a> { -<a name="191" href="#191">191</a> Properties properties = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.html">SortedProperties</a>(); -<a name="192" href="#192">192</a> properties.putAll( pom.getProperties() ); -<a name="193" href="#193">193</a> pom.setProperties( properties ); -<a name="194" href="#194">194</a> } -<a name="195" href="#195">195</a> -<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">/**</em> -<a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * @param effectivePom not null</em> -<a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * @return pretty format of the xml or the original <code>effectivePom</code> if an error occurred.</em> -<a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> */</em> -<a name="200" href="#200">200</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String prettyFormat( String effectivePom ) -<a name="201" href="#201">201</a> { -<a name="202" href="#202">202</a> SAXBuilder builder = <strong class="jxr_keyword">new</strong> SAXBuilder(); -<a name="203" href="#203">203</a> -<a name="204" href="#204">204</a> <strong class="jxr_keyword">try</strong> -<a name="205" href="#205">205</a> { -<a name="206" href="#206">206</a> Document effectiveDocument = builder.build( <strong class="jxr_keyword">new</strong> StringReader( effectivePom ) ); -<a name="207" href="#207">207</a> -<a name="208" href="#208">208</a> StringWriter w = <strong class="jxr_keyword">new</strong> StringWriter(); -<a name="209" href="#209">209</a> Format format = Format.getPrettyFormat(); -<a name="210" href="#210">210</a> XMLOutputter out = <strong class="jxr_keyword">new</strong> XMLOutputter( format ); -<a name="211" href="#211">211</a> out.output( effectiveDocument, w ); -<a name="212" href="#212">212</a> -<a name="213" href="#213">213</a> <strong class="jxr_keyword">return</strong> w.toString(); -<a name="214" href="#214">214</a> } -<a name="215" href="#215">215</a> <strong class="jxr_keyword">catch</strong> ( JDOMException e ) -<a name="216" href="#216">216</a> { -<a name="217" href="#217">217</a> <strong class="jxr_keyword">return</strong> effectivePom; -<a name="218" href="#218">218</a> } -<a name="219" href="#219">219</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a name="220" href="#220">220</a> { -<a name="221" href="#221">221</a> <strong class="jxr_keyword">return</strong> effectivePom; -<a name="222" href="#222">222</a> } -<a name="223" href="#223">223</a> } -<a name="224" href="#224">224</a> } -</pre> -<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> -</html> - +<!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="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; +<a class="jxr_linenumber" name="2" href="#2">2</a> +<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="12" href="#12">12</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="13" href="#13">13</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="21" href="#21">21</a> +<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Model; +<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.io.xpp3.MavenXpp3Writer; +<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.PrettyPrintXMLWriter; +<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XMLWriter; +<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XmlWriterUtil; +<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.jdom.Document; +<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.jdom.JDOMException; +<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.jdom.input.SAXBuilder; +<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.jdom.output.Format; +<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.jdom.output.XMLOutputter; +<a class="jxr_linenumber" name="38" href="#38">38</a> +<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> java.io.StringReader; +<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> java.io.StringWriter; +<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> java.util.Properties; +<a class="jxr_linenumber" name="44" href="#44">44</a> +<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Displays the effective POM as an XML for this build, with the active profiles factored in.</em> +<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @version $Id: EffectivePomMojo.java 1423092 2012-12-17 18:53:49Z hboutemy $</em> +<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="51" href="#51">51</a> @Mojo( name = <span class="jxr_string">"effective-pom"</span>, aggregator = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/help/EffectivePomMojo.html">EffectivePomMojo</a> +<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.html">AbstractEffectiveMojo</a> +<a class="jxr_linenumber" name="54" href="#54">54</a> { +<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_comment">// Mojo parameters</em> +<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="58" href="#58">58</a> +<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * The Maven project.</em> +<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @since 2.0.2</em> +<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="64" href="#64">64</a> @Component +<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> MavenProject project; +<a class="jxr_linenumber" name="66" href="#66">66</a> +<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * The projects in the current build. The effective-POM for</em> +<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * each of these projects will written.</em> +<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="71" href="#71">71</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="72" href="#72">72</a> <strong class="jxr_keyword">private</strong> List<MavenProject> projects; +<a class="jxr_linenumber" name="73" href="#73">73</a> +<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_comment">// Public methods</em> +<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="77" href="#77">77</a> +<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> +<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() +<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException +<a class="jxr_linenumber" name="81" href="#81">81</a> { +<a class="jxr_linenumber" name="82" href="#82">82</a> StringWriter w = <strong class="jxr_keyword">new</strong> StringWriter(); +<a class="jxr_linenumber" name="83" href="#83">83</a> XMLWriter writer = +<a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">new</strong> PrettyPrintXMLWriter( w, StringUtils.repeat( <span class="jxr_string">" "</span>, XmlWriterUtil.DEFAULT_INDENTATION_SIZE ), +<a class="jxr_linenumber" name="85" href="#85">85</a> project.getModel().getModelEncoding(), <strong class="jxr_keyword">null</strong> ); +<a class="jxr_linenumber" name="86" href="#86">86</a> +<a class="jxr_linenumber" name="87" href="#87">87</a> writeHeader( writer ); +<a class="jxr_linenumber" name="88" href="#88">88</a> +<a class="jxr_linenumber" name="89" href="#89">89</a> String effectivePom; +<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">if</strong> ( projects.get( 0 ).equals( project ) && projects.size() > 1 ) +<a class="jxr_linenumber" name="91" href="#91">91</a> { +<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_comment">// outer root element</em> +<a class="jxr_linenumber" name="93" href="#93">93</a> writer.startElement( <span class="jxr_string">"projects"</span> ); +<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">for</strong> ( MavenProject subProject : projects ) +<a class="jxr_linenumber" name="95" href="#95">95</a> { +<a class="jxr_linenumber" name="96" href="#96">96</a> writeEffectivePom( subProject, writer ); +<a class="jxr_linenumber" name="97" href="#97">97</a> } +<a class="jxr_linenumber" name="98" href="#98">98</a> writer.endElement(); +<a class="jxr_linenumber" name="99" href="#99">99</a> +<a class="jxr_linenumber" name="100" href="#100">100</a> effectivePom = w.toString(); +<a class="jxr_linenumber" name="101" href="#101">101</a> effectivePom = prettyFormat( effectivePom ); +<a class="jxr_linenumber" name="102" href="#102">102</a> } +<a class="jxr_linenumber" name="103" href="#103">103</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="104" href="#104">104</a> { +<a class="jxr_linenumber" name="105" href="#105">105</a> writeEffectivePom( project, writer ); +<a class="jxr_linenumber" name="106" href="#106">106</a> +<a class="jxr_linenumber" name="107" href="#107">107</a> effectivePom = w.toString(); +<a class="jxr_linenumber" name="108" href="#108">108</a> } +<a class="jxr_linenumber" name="109" href="#109">109</a> +<a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> ( output != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="111" href="#111">111</a> { +<a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="113" href="#113">113</a> { +<a class="jxr_linenumber" name="114" href="#114">114</a> writeXmlFile( output, effectivePom, project.getModel().getModelEncoding() ); +<a class="jxr_linenumber" name="115" href="#115">115</a> } +<a class="jxr_linenumber" name="116" href="#116">116</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="117" href="#117">117</a> { +<a class="jxr_linenumber" name="118" href="#118">118</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="119" href="#119">119</a> } +<a class="jxr_linenumber" name="120" href="#120">120</a> +<a class="jxr_linenumber" name="121" href="#121">121</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() ) +<a class="jxr_linenumber" name="122" href="#122">122</a> { +<a class="jxr_linenumber" name="123" href="#123">123</a> getLog().info( <span class="jxr_string">"Effective-POM written to: "</span> + output ); +<a class="jxr_linenumber" name="124" href="#124">124</a> } +<a class="jxr_linenumber" name="125" href="#125">125</a> } +<a class="jxr_linenumber" name="126" href="#126">126</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="127" href="#127">127</a> { +<a class="jxr_linenumber" name="128" href="#128">128</a> StringBuilder message = <strong class="jxr_keyword">new</strong> StringBuilder(); +<a class="jxr_linenumber" name="129" href="#129">129</a> +<a class="jxr_linenumber" name="130" href="#130">130</a> message.append( <span class="jxr_string">"\nEffective POMs, after inheritance, interpolation, and profiles are applied:\n\n"</span> ); +<a class="jxr_linenumber" name="131" href="#131">131</a> message.append( effectivePom ); +<a class="jxr_linenumber" name="132" href="#132">132</a> message.append( <span class="jxr_string">"\n"</span> ); +<a class="jxr_linenumber" name="133" href="#133">133</a> +<a class="jxr_linenumber" name="134" href="#134">134</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() ) +<a class="jxr_linenumber" name="135" href="#135">135</a> { +<a class="jxr_linenumber" name="136" href="#136">136</a> getLog().info( message.toString() ); +<a class="jxr_linenumber" name="137" href="#137">137</a> } +<a class="jxr_linenumber" name="138" href="#138">138</a> } +<a class="jxr_linenumber" name="139" href="#139">139</a> } +<a class="jxr_linenumber" name="140" href="#140">140</a> +<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_comment">// Private methods</em> +<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="144" href="#144">144</a> +<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * Method for writing the effective pom informations of the current build.</em> +<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @param project the project of the current build, not null.</em> +<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @param writer the XML writer , not null, not null.</em> +<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if any</em> +<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="152" href="#152">152</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeEffectivePom( MavenProject project, XMLWriter writer ) +<a class="jxr_linenumber" name="153" href="#153">153</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException +<a class="jxr_linenumber" name="154" href="#154">154</a> { +<a class="jxr_linenumber" name="155" href="#155">155</a> Model pom = project.getModel(); +<a class="jxr_linenumber" name="156" href="#156">156</a> cleanModel( pom ); +<a class="jxr_linenumber" name="157" href="#157">157</a> +<a class="jxr_linenumber" name="158" href="#158">158</a> String effectivePom; +<a class="jxr_linenumber" name="159" href="#159">159</a> +<a class="jxr_linenumber" name="160" href="#160">160</a> StringWriter sWriter = <strong class="jxr_keyword">new</strong> StringWriter(); +<a class="jxr_linenumber" name="161" href="#161">161</a> MavenXpp3Writer pomWriter = <strong class="jxr_keyword">new</strong> MavenXpp3Writer(); +<a class="jxr_linenumber" name="162" href="#162">162</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="163" href="#163">163</a> { +<a class="jxr_linenumber" name="164" href="#164">164</a> pomWriter.write( sWriter, pom ); +<a class="jxr_linenumber" name="165" href="#165">165</a> } +<a class="jxr_linenumber" name="166" href="#166">166</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="167" href="#167">167</a> { +<a class="jxr_linenumber" name="168" href="#168">168</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="169" href="#169">169</a> } +<a class="jxr_linenumber" name="170" href="#170">170</a> +<a class="jxr_linenumber" name="171" href="#171">171</a> effectivePom = addMavenNamespace( sWriter.toString(), <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="172" href="#172">172</a> +<a class="jxr_linenumber" name="173" href="#173">173</a> writeComment( writer, <span class="jxr_string">"Effective POM for project \'"</span> + project.getId() + <span class="jxr_string">"\'"</span> ); +<a class="jxr_linenumber" name="174" href="#174">174</a> +<a class="jxr_linenumber" name="175" href="#175">175</a> writer.writeMarkup( effectivePom ); +<a class="jxr_linenumber" name="176" href="#176">176</a> } +<a class="jxr_linenumber" name="177" href="#177">177</a> +<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * Apply some logic to clean the model before writing it.</em> +<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * @param pom not null</em> +<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="183" href="#183">183</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="184" href="#184">184</a> { +<a class="jxr_linenumber" name="185" href="#185">185</a> Properties properties = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.html">SortedProperties</a>(); +<a class="jxr_linenumber" name="186" href="#186">186</a> properties.putAll( pom.getProperties() ); +<a class="jxr_linenumber" name="187" href="#187">187</a> pom.setProperties( properties ); +<a class="jxr_linenumber" name="188" href="#188">188</a> } +<a class="jxr_linenumber" name="189" href="#189">189</a> +<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * @param effectivePom not null</em> +<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * @return pretty format of the xml or the original <code>effectivePom</code> if an error occurred.</em> +<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="194" href="#194">194</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String prettyFormat( String effectivePom ) +<a class="jxr_linenumber" name="195" href="#195">195</a> { +<a class="jxr_linenumber" name="196" href="#196">196</a> SAXBuilder builder = <strong class="jxr_keyword">new</strong> SAXBuilder(); +<a class="jxr_linenumber" name="197" href="#197">197</a> +<a class="jxr_linenumber" name="198" href="#198">198</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="199" href="#199">199</a> { +<a class="jxr_linenumber" name="200" href="#200">200</a> Document effectiveDocument = builder.build( <strong class="jxr_keyword">new</strong> StringReader( effectivePom ) ); +<a class="jxr_linenumber" name="201" href="#201">201</a> +<a class="jxr_linenumber" name="202" href="#202">202</a> StringWriter w = <strong class="jxr_keyword">new</strong> StringWriter(); +<a class="jxr_linenumber" name="203" href="#203">203</a> Format format = Format.getPrettyFormat(); +<a class="jxr_linenumber" name="204" href="#204">204</a> XMLOutputter out = <strong class="jxr_keyword">new</strong> XMLOutputter( format ); +<a class="jxr_linenumber" name="205" href="#205">205</a> out.output( effectiveDocument, w ); +<a class="jxr_linenumber" name="206" href="#206">206</a> +<a class="jxr_linenumber" name="207" href="#207">207</a> <strong class="jxr_keyword">return</strong> w.toString(); +<a class="jxr_linenumber" name="208" href="#208">208</a> } +<a class="jxr_linenumber" name="209" href="#209">209</a> <strong class="jxr_keyword">catch</strong> ( JDOMException e ) +<a class="jxr_linenumber" name="210" href="#210">210</a> { +<a class="jxr_linenumber" name="211" href="#211">211</a> <strong class="jxr_keyword">return</strong> effectivePom; +<a class="jxr_linenumber" name="212" href="#212">212</a> } +<a class="jxr_linenumber" name="213" href="#213">213</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="214" href="#214">214</a> { +<a class="jxr_linenumber" name="215" href="#215">215</a> <strong class="jxr_keyword">return</strong> effectivePom; +<a class="jxr_linenumber" name="216" href="#216">216</a> } +<a class="jxr_linenumber" name="217" href="#217">217</a> } +<a class="jxr_linenumber" name="218" href="#218">218</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> +</html>
