Modified: websites/production/maven/content/plugins/maven-help-plugin/xref/org/apache/maven/plugins/help/ExpressionsMojo.html ============================================================================== --- websites/production/maven/content/plugins/maven-help-plugin/xref/org/apache/maven/plugins/help/ExpressionsMojo.html (original) +++ websites/production/maven/content/plugins/maven-help-plugin/xref/org/apache/maven/plugins/help/ExpressionsMojo.html Sat Feb 23 22:01:58 2013 @@ -1,195 +1,191 @@ -<!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>ExpressionsMojo xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/ExpressionsMojo.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.lang.reflect.Field; -<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; -<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.Map; -<a name="28" href="#28">28</a> -<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; -<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.usability.plugin.Expression; -<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.usability.plugin.ExpressionDocumentationException; -<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.usability.plugin.ExpressionDocumenter; -<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a name="35" href="#35">35</a> -<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> -<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Displays the supported Plugin expressions used by Maven.</em> -<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> *</em> -<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Vincent Siveton</a></em> -<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @version $Id: ExpressionsMojo.java 689770 2008-08-28 09:47:18Z vsiveton $</em> -<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @goal expressions</em> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @requiresProject false</em> -<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em> -<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/help/ExpressionsMojo.html">ExpressionsMojo</a> -<a name="46" href="#46">46</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html">AbstractHelpMojo</a> -<a name="47" href="#47">47</a> { -<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> English sentence when no description exists */</em> -<a name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NO_DESCRIPTION_AVAILABLE = <span class="jxr_string">"No description available."</span>; -<a name="50" href="#50">50</a> -<a name="51" href="#51">51</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="52" href="#52">52</a> <em class="jxr_comment">// Public methods</em> -<a name="53" href="#53">53</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="54" href="#54">54</a> -<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() -<a name="57" href="#57">57</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException -<a name="58" href="#58">58</a> { -<a name="59" href="#59">59</a> Map m; -<a name="60" href="#60">60</a> <strong class="jxr_keyword">try</strong> -<a name="61" href="#61">61</a> { -<a name="62" href="#62">62</a> m = ExpressionDocumenter.load(); -<a name="63" href="#63">63</a> } -<a name="64" href="#64">64</a> <strong class="jxr_keyword">catch</strong> ( ExpressionDocumentationException e ) -<a name="65" href="#65">65</a> { -<a name="66" href="#66">66</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"ExpressionDocumentationException: "</span> + e.getMessage(), e ); -<a name="67" href="#67">67</a> } -<a name="68" href="#68">68</a> -<a name="69" href="#69">69</a> StringBuffer sb = <strong class="jxr_keyword">new</strong> StringBuffer(); -<a name="70" href="#70">70</a> sb.append( <span class="jxr_string">"Maven supports the following Plugin expressions:\n\n"</span> ); -<a name="71" href="#71">71</a> <strong class="jxr_keyword">for</strong> ( Iterator it = getExpressionsRoot().iterator(); it.hasNext(); ) -<a name="72" href="#72">72</a> { -<a name="73" href="#73">73</a> String expression = (String) it.next(); -<a name="74" href="#74">74</a> -<a name="75" href="#75">75</a> sb.append( <span class="jxr_string">"${"</span> ).append( expression ).append( <span class="jxr_string">"}: "</span> ); -<a name="76" href="#76">76</a> sb.append( NO_DESCRIPTION_AVAILABLE ); -<a name="77" href="#77">77</a> sb.append( <span class="jxr_string">"\n\n"</span> ); -<a name="78" href="#78">78</a> } -<a name="79" href="#79">79</a> -<a name="80" href="#80">80</a> <strong class="jxr_keyword">for</strong> ( Iterator it = m.keySet().iterator(); it.hasNext(); ) -<a name="81" href="#81">81</a> { -<a name="82" href="#82">82</a> String key = (String) it.next(); -<a name="83" href="#83">83</a> Expression expression = (Expression) m.get( key ); -<a name="84" href="#84">84</a> -<a name="85" href="#85">85</a> sb.append( <span class="jxr_string">"${"</span> ).append( key ).append( <span class="jxr_string">"}: "</span> ); -<a name="86" href="#86">86</a> sb.append( trimCDATA( expression.getDescription() ) ); -<a name="87" href="#87">87</a> sb.append( <span class="jxr_string">"\n\n"</span> ); -<a name="88" href="#88">88</a> } -<a name="89" href="#89">89</a> -<a name="90" href="#90">90</a> <strong class="jxr_keyword">if</strong> ( output != <strong class="jxr_keyword">null</strong> ) -<a name="91" href="#91">91</a> { -<a name="92" href="#92">92</a> <strong class="jxr_keyword">try</strong> -<a name="93" href="#93">93</a> { -<a name="94" href="#94">94</a> writeFile( output, sb ); -<a name="95" href="#95">95</a> } -<a name="96" href="#96">96</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a name="97" href="#97">97</a> { -<a name="98" href="#98">98</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Cannot write plugins expressions description to output: "</span> -<a name="99" href="#99">99</a> + output, e ); -<a name="100" href="#100">100</a> } -<a name="101" href="#101">101</a> -<a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() ) -<a name="103" href="#103">103</a> { -<a name="104" href="#104">104</a> getLog().info( <span class="jxr_string">"Wrote descriptions to: "</span> + output ); -<a name="105" href="#105">105</a> } -<a name="106" href="#106">106</a> } -<a name="107" href="#107">107</a> <strong class="jxr_keyword">else</strong> -<a name="108" href="#108">108</a> { -<a name="109" href="#109">109</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() ) -<a name="110" href="#110">110</a> { -<a name="111" href="#111">111</a> getLog().info( sb.toString() ); -<a name="112" href="#112">112</a> } -<a name="113" href="#113">113</a> } -<a name="114" href="#114">114</a> } -<a name="115" href="#115">115</a> -<a name="116" href="#116">116</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="117" href="#117">117</a> <em class="jxr_comment">// Private methods</em> -<a name="118" href="#118">118</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="119" href="#119">119</a> -<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em> -<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @return the value of the private static field <code>ExpressionDocumenter#EXPRESSION_ROOTS</code>.</em> -<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException if any reflection exceptions occur</em> -<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if no value exists for <code>ExpressionDocumenter#EXPRESSION_ROOTS</code></em> -<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> */</em> -<a name="125" href="#125">125</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> List getExpressionsRoot() -<a name="126" href="#126">126</a> <strong class="jxr_keyword">throws</strong> MojoFailureException, MojoExecutionException -<a name="127" href="#127">127</a> { -<a name="128" href="#128">128</a> <strong class="jxr_keyword">try</strong> -<a name="129" href="#129">129</a> { -<a name="130" href="#130">130</a> Field f = ExpressionDocumenter.<strong class="jxr_keyword">class</strong>.getDeclaredField( <span class="jxr_string">"EXPRESSION_ROOTS"</span> ); -<a name="131" href="#131">131</a> f.setAccessible( <strong class="jxr_keyword">true</strong> ); -<a name="132" href="#132">132</a> String[] value = (String[]) f.get( <strong class="jxr_keyword">new</strong> ExpressionDocumenter() ); -<a name="133" href="#133">133</a> <strong class="jxr_keyword">if</strong> ( value == <strong class="jxr_keyword">null</strong> ) -<a name="134" href="#134">134</a> { -<a name="135" href="#135">135</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"org.apache.maven.usability.plugin.ExpressionDocumenter#"</span> -<a name="136" href="#136">136</a> + <span class="jxr_string">"EXPRESSION_ROOTS has no value."</span> ); -<a name="137" href="#137">137</a> } -<a name="138" href="#138">138</a> -<a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> Arrays.asList( value ); -<a name="140" href="#140">140</a> } -<a name="141" href="#141">141</a> <strong class="jxr_keyword">catch</strong> ( SecurityException e ) -<a name="142" href="#142">142</a> { -<a name="143" href="#143">143</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"SecurityException: "</span> + e.getMessage() ); -<a name="144" href="#144">144</a> } -<a name="145" href="#145">145</a> <strong class="jxr_keyword">catch</strong> ( IllegalArgumentException e ) -<a name="146" href="#146">146</a> { -<a name="147" href="#147">147</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"IllegalArgumentException: "</span> + e.getMessage() ); -<a name="148" href="#148">148</a> } -<a name="149" href="#149">149</a> <strong class="jxr_keyword">catch</strong> ( NoSuchFieldException e ) -<a name="150" href="#150">150</a> { -<a name="151" href="#151">151</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"NoSuchFieldException: "</span> + e.getMessage() ); -<a name="152" href="#152">152</a> } -<a name="153" href="#153">153</a> <strong class="jxr_keyword">catch</strong> ( IllegalAccessException e ) -<a name="154" href="#154">154</a> { -<a name="155" href="#155">155</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"IllegalAccessException: "</span> + e.getMessage() ); -<a name="156" href="#156">156</a> } -<a name="157" href="#157">157</a> } -<a name="158" href="#158">158</a> -<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">/**</em> -<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param description could be null</em> -<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @return the given description without any new line, or <code>NO_DESCRIPTION_AVAILABLE</code> value if</em> -<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * <code>description</code> is null.</em> -<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @see #NO_DESCRIPTION_AVAILABLE</em> -<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> */</em> -<a name="165" href="#165">165</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String trimCDATA( String description ) -<a name="166" href="#166">166</a> { -<a name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( description ) ) -<a name="168" href="#168">168</a> { -<a name="169" href="#169">169</a> <strong class="jxr_keyword">return</strong> NO_DESCRIPTION_AVAILABLE; -<a name="170" href="#170">170</a> } -<a name="171" href="#171">171</a> -<a name="172" href="#172">172</a> StringBuffer sb = <strong class="jxr_keyword">new</strong> StringBuffer(); -<a name="173" href="#173">173</a> String[] lines = StringUtils.split( description, <span class="jxr_string">"\r\n"</span> ); -<a name="174" href="#174">174</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i < lines.length; i++ ) -<a name="175" href="#175">175</a> { -<a name="176" href="#176">176</a> sb.append( StringUtils.trim( lines[i] ) ).append( <span class="jxr_string">" "</span> ); -<a name="177" href="#177">177</a> } -<a name="178" href="#178">178</a> -<a name="179" href="#179">179</a> <strong class="jxr_keyword">return</strong> sb.toString(); -<a name="180" href="#180">180</a> } -<a name="181" href="#181">181</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>ExpressionsMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/ExpressionsMojo.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.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.usability.plugin.Expression; +<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.usability.plugin.ExpressionDocumentationException; +<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.usability.plugin.ExpressionDocumenter; +<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="29" href="#29">29</a> +<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Field; +<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; +<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="35" href="#35">35</a> +<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Displays the supported Plugin expressions used by Maven.</em> +<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Vincent Siveton</a></em> +<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @version $Id: ExpressionsMojo.java 1446806 2013-02-15 23:07:28Z rfscholte $</em> +<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="43" href="#43">43</a> @Mojo( name = <span class="jxr_string">"expressions"</span>, requiresProject = false ) +<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/help/ExpressionsMojo.html">ExpressionsMojo</a> +<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html">AbstractHelpMojo</a> +<a class="jxr_linenumber" name="46" href="#46">46</a> { +<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> English sentence when no description exists */</em> +<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NO_DESCRIPTION_AVAILABLE = <span class="jxr_string">"No description available."</span>; +<a class="jxr_linenumber" name="49" href="#49">49</a> +<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_comment">// Public methods</em> +<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="53" href="#53">53</a> +<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> +<a class="jxr_linenumber" name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() +<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException +<a class="jxr_linenumber" name="57" href="#57">57</a> { +<a class="jxr_linenumber" name="58" href="#58">58</a> Map<String, Expression> m; +<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="60" href="#60">60</a> { +<a class="jxr_linenumber" name="61" href="#61">61</a> m = ExpressionDocumenter.load(); +<a class="jxr_linenumber" name="62" href="#62">62</a> } +<a class="jxr_linenumber" name="63" href="#63">63</a> <strong class="jxr_keyword">catch</strong> ( ExpressionDocumentationException e ) +<a class="jxr_linenumber" name="64" href="#64">64</a> { +<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"ExpressionDocumentationException: "</span> + e.getMessage(), e ); +<a class="jxr_linenumber" name="66" href="#66">66</a> } +<a class="jxr_linenumber" name="67" href="#67">67</a> +<a class="jxr_linenumber" name="68" href="#68">68</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(); +<a class="jxr_linenumber" name="69" href="#69">69</a> sb.append( <span class="jxr_string">"Maven supports the following Plugin expressions:\n\n"</span> ); +<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">for</strong> ( String expression : getExpressionsRoot() ) +<a class="jxr_linenumber" name="71" href="#71">71</a> { +<a class="jxr_linenumber" name="72" href="#72">72</a> sb.append( <span class="jxr_string">"${"</span> ).append( expression ).append( <span class="jxr_string">"}: "</span> ); +<a class="jxr_linenumber" name="73" href="#73">73</a> sb.append( NO_DESCRIPTION_AVAILABLE ); +<a class="jxr_linenumber" name="74" href="#74">74</a> sb.append( <span class="jxr_string">"\n\n"</span> ); +<a class="jxr_linenumber" name="75" href="#75">75</a> } +<a class="jxr_linenumber" name="76" href="#76">76</a> +<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">for</strong> ( Map.Entry<String, Expression> entry : m.entrySet() ) +<a class="jxr_linenumber" name="78" href="#78">78</a> { +<a class="jxr_linenumber" name="79" href="#79">79</a> String key = entry.getKey(); +<a class="jxr_linenumber" name="80" href="#80">80</a> Expression expression = entry.getValue(); +<a class="jxr_linenumber" name="81" href="#81">81</a> +<a class="jxr_linenumber" name="82" href="#82">82</a> sb.append( <span class="jxr_string">"${"</span> ).append( key ).append( <span class="jxr_string">"}: "</span> ); +<a class="jxr_linenumber" name="83" href="#83">83</a> sb.append( trimCDATA( expression.getDescription() ) ); +<a class="jxr_linenumber" name="84" href="#84">84</a> sb.append( <span class="jxr_string">"\n\n"</span> ); +<a class="jxr_linenumber" name="85" href="#85">85</a> } +<a class="jxr_linenumber" name="86" href="#86">86</a> +<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> ( output != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="88" href="#88">88</a> { +<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="90" href="#90">90</a> { +<a class="jxr_linenumber" name="91" href="#91">91</a> writeFile( output, sb ); +<a class="jxr_linenumber" name="92" href="#92">92</a> } +<a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="94" href="#94">94</a> { +<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Cannot write plugins expressions description to output: "</span> +<a class="jxr_linenumber" name="96" href="#96">96</a> + output, e ); +<a class="jxr_linenumber" name="97" href="#97">97</a> } +<a class="jxr_linenumber" name="98" href="#98">98</a> +<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() ) +<a class="jxr_linenumber" name="100" href="#100">100</a> { +<a class="jxr_linenumber" name="101" href="#101">101</a> getLog().info( <span class="jxr_string">"Wrote descriptions to: "</span> + output ); +<a class="jxr_linenumber" name="102" href="#102">102</a> } +<a class="jxr_linenumber" name="103" href="#103">103</a> } +<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="105" href="#105">105</a> { +<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() ) +<a class="jxr_linenumber" name="107" href="#107">107</a> { +<a class="jxr_linenumber" name="108" href="#108">108</a> getLog().info( sb.toString() ); +<a class="jxr_linenumber" name="109" href="#109">109</a> } +<a class="jxr_linenumber" name="110" href="#110">110</a> } +<a class="jxr_linenumber" name="111" href="#111">111</a> } +<a class="jxr_linenumber" name="112" href="#112">112</a> +<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_comment">// Private methods</em> +<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="116" href="#116">116</a> +<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @return the value of the private static field <code>ExpressionDocumenter#EXPRESSION_ROOTS</code>.</em> +<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException if any reflection exceptions occur</em> +<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if no value exists for <code>ExpressionDocumenter#EXPRESSION_ROOTS</code></em> +<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="122" href="#122">122</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> List<String> getExpressionsRoot() +<a class="jxr_linenumber" name="123" href="#123">123</a> <strong class="jxr_keyword">throws</strong> MojoFailureException, MojoExecutionException +<a class="jxr_linenumber" name="124" href="#124">124</a> { +<a class="jxr_linenumber" name="125" href="#125">125</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="126" href="#126">126</a> { +<a class="jxr_linenumber" name="127" href="#127">127</a> Field f = ExpressionDocumenter.<strong class="jxr_keyword">class</strong>.getDeclaredField( <span class="jxr_string">"EXPRESSION_ROOTS"</span> ); +<a class="jxr_linenumber" name="128" href="#128">128</a> f.setAccessible( <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="129" href="#129">129</a> String[] value = (String[]) f.get( <strong class="jxr_keyword">new</strong> ExpressionDocumenter() ); +<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> ( value == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="131" href="#131">131</a> { +<a class="jxr_linenumber" name="132" href="#132">132</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"org.apache.maven.usability.plugin.ExpressionDocumenter#"</span> +<a class="jxr_linenumber" name="133" href="#133">133</a> + <span class="jxr_string">"EXPRESSION_ROOTS has no value."</span> ); +<a class="jxr_linenumber" name="134" href="#134">134</a> } +<a class="jxr_linenumber" name="135" href="#135">135</a> +<a class="jxr_linenumber" name="136" href="#136">136</a> <strong class="jxr_keyword">return</strong> Arrays.asList( value ); +<a class="jxr_linenumber" name="137" href="#137">137</a> } +<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">catch</strong> ( SecurityException e ) +<a class="jxr_linenumber" name="139" href="#139">139</a> { +<a class="jxr_linenumber" name="140" href="#140">140</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"SecurityException: "</span> + e.getMessage() ); +<a class="jxr_linenumber" name="141" href="#141">141</a> } +<a class="jxr_linenumber" name="142" href="#142">142</a> <strong class="jxr_keyword">catch</strong> ( IllegalArgumentException e ) +<a class="jxr_linenumber" name="143" href="#143">143</a> { +<a class="jxr_linenumber" name="144" href="#144">144</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"IllegalArgumentException: "</span> + e.getMessage() ); +<a class="jxr_linenumber" name="145" href="#145">145</a> } +<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">catch</strong> ( NoSuchFieldException e ) +<a class="jxr_linenumber" name="147" href="#147">147</a> { +<a class="jxr_linenumber" name="148" href="#148">148</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"NoSuchFieldException: "</span> + e.getMessage() ); +<a class="jxr_linenumber" name="149" href="#149">149</a> } +<a class="jxr_linenumber" name="150" href="#150">150</a> <strong class="jxr_keyword">catch</strong> ( IllegalAccessException e ) +<a class="jxr_linenumber" name="151" href="#151">151</a> { +<a class="jxr_linenumber" name="152" href="#152">152</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"IllegalAccessException: "</span> + e.getMessage() ); +<a class="jxr_linenumber" name="153" href="#153">153</a> } +<a class="jxr_linenumber" name="154" href="#154">154</a> } +<a class="jxr_linenumber" name="155" href="#155">155</a> +<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @param description could be null</em> +<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @return the given description without any new line, or <code>NO_DESCRIPTION_AVAILABLE</code> value if</em> +<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * <code>description</code> is null.</em> +<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @see #NO_DESCRIPTION_AVAILABLE</em> +<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="162" href="#162">162</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String trimCDATA( String description ) +<a class="jxr_linenumber" name="163" href="#163">163</a> { +<a class="jxr_linenumber" name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( description ) ) +<a class="jxr_linenumber" name="165" href="#165">165</a> { +<a class="jxr_linenumber" name="166" href="#166">166</a> <strong class="jxr_keyword">return</strong> NO_DESCRIPTION_AVAILABLE; +<a class="jxr_linenumber" name="167" href="#167">167</a> } +<a class="jxr_linenumber" name="168" href="#168">168</a> +<a class="jxr_linenumber" name="169" href="#169">169</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(); +<a class="jxr_linenumber" name="170" href="#170">170</a> String[] lines = StringUtils.split( description, <span class="jxr_string">"\r\n"</span> ); +<a class="jxr_linenumber" name="171" href="#171">171</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i < lines.length; i++ ) +<a class="jxr_linenumber" name="172" href="#172">172</a> { +<a class="jxr_linenumber" name="173" href="#173">173</a> sb.append( StringUtils.trim( lines[i] ) ).append( <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> +<a class="jxr_linenumber" name="176" href="#176">176</a> <strong class="jxr_keyword">return</strong> sb.toString(); +<a class="jxr_linenumber" name="177" href="#177">177</a> } +<a class="jxr_linenumber" name="178" href="#178">178</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> +</html>
