Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/EvaluateMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/EvaluateMojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/EvaluateMojo.html Sun Jun 2 15:20:18 2024 @@ -1,526 +1,526 @@ -<!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>EvaluateMojo xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/EvaluateMojo.html">View Javadoc</a></div><pre> -<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> -<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; -<a class="jxr_linenumber" name="L20" href="#L20">20</a> -<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File; -<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.InputStream; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.StringWriter; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Locale; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Map; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.Properties; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.TreeMap; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.jar.JarEntry; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.jar.JarInputStream; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> com.thoughtworks.xstream.XStream; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> com.thoughtworks.xstream.converters.MarshallingContext; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> com.thoughtworks.xstream.converters.collections.PropertiesConverter; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> com.thoughtworks.xstream.io.HierarchicalStreamWriter; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.ClassUtils; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.lifecycle.internal.MojoDescriptorCreator; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Dependency; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Model; -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.io.xpp3.MavenXpp3Writer; -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecution; -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.PluginParameterExpressionEvaluator; -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.MojoDescriptor; -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.io.xpp3.SettingsXpp3Writer; -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.components.interactivity.InputHandler; -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositoryException; -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.artifact.Artifact; -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.artifact.DefaultArtifact; -<a class="jxr_linenumber" name="L60" href="#L60">60</a> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Evaluates Maven expressions given by the user in an interactive mode.</em> -<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"> * @author <a href="<a href="mailto:vincent.sive...@gmail.com"; target="alexandria_uri">mailto:vincent.sive...@gmail.com</a>">Vincent Siveton</a></em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> @Mojo(name = <span class="jxr_string">"evaluate"</span>, requiresProject = false) -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="EvaluateMojo" href="../../../../../org/apache/maven/plugins/help/EvaluateMojo.html#EvaluateMojo">EvaluateMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractHelpMojo" href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo">AbstractHelpMojo</a> { -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_comment">// Mojo components</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Input handler, needed for command line handling.</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Component -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> InputHandler inputHandler; -<a class="jxr_linenumber" name="L78" href="#L78">78</a> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Component used to get mojo descriptors.</em> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> @Component -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> MojoDescriptorCreator mojoDescriptorCreator; -<a class="jxr_linenumber" name="L84" href="#L84">84</a> -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment">// Mojo parameters</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// we need to hide the 'output' defined in AbstractHelpMojo to have a correct "since".</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Optional parameter to write the output of this help in a given file, instead of writing to the console.</em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * This parameter will be ignored if no <code>expression</code> is specified.</em> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * <br/></em> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Could be a relative path.</em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @since 3.0.0</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> @Parameter(property = <span class="jxr_string">"output"</span>) -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">private</strong> File output; -<a class="jxr_linenumber" name="L100" href="#L100">100</a> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * This options gives the option to output information in cases where the output has been suppressed by using</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <code>-q</code> (quiet option) in Maven. This is useful if you like to use</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <code>maven-help-plugin:evaluate</code> in a script call (for example in bash) like this:</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * RESULT=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * echo $RESULT</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * </pre></em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * This will only printout the information which has been requested by <code>expression</code> to</em> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * <code>stdout</code>.</em> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @since 3.1.0</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> @Parameter(property = <span class="jxr_string">"forceStdout"</span>, defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> forceStdout; -<a class="jxr_linenumber" name="L118" href="#L118">118</a> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * An artifact for evaluating Maven expressions. <br/></em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Should respect the Maven format, i.e. <code>groupId:artifactId[:version]</code>. The latest version</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * of the artifact will be used when no version is specified.</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> @Parameter(property = <span class="jxr_string">"artifact"</span>) -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">private</strong> String artifact; -<a class="jxr_linenumber" name="L126" href="#L126">126</a> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * An expression to evaluate instead of prompting. Note that this <i>must not</i> include the surrounding ${...}.</em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> @Parameter(property = <span class="jxr_string">"expression"</span>) -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">private</strong> String expression; -<a class="jxr_linenumber" name="L132" href="#L132">132</a> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * The system settings for Maven.</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> @Parameter(defaultValue = <span class="jxr_string">"${settings}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">private</strong> Settings settings; -<a class="jxr_linenumber" name="L138" href="#L138">138</a> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// Instance variables</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/** lazy loading evaluator variable */</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">private</strong> PluginParameterExpressionEvaluator evaluator; -<a class="jxr_linenumber" name="L145" href="#L145">145</a> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/** lazy loading xstream variable */</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">private</strong> XStream xstream; -<a class="jxr_linenumber" name="L148" href="#L148">148</a> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_comment">// Public methods</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (expression == <strong class="jxr_keyword">null</strong> && !settings.isInteractiveMode()) { -<a class="jxr_linenumber" name="L156" href="#L156">156</a> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> getLog().error(<span class="jxr_string">"Maven is configured to NOT interact with the user for input. "</span> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> + <span class="jxr_string">"This Mojo requires that 'interactiveMode' in your settings file is flag to 'true'."</span>); -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L160" href="#L160">160</a> } -<a class="jxr_linenumber" name="L161" href="#L161">161</a> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> validateParameters(); -<a class="jxr_linenumber" name="L163" href="#L163">163</a> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotEmpty(artifact)) { -<a class="jxr_linenumber" name="L165" href="#L165">165</a> project = getMavenProject(artifact); -<a class="jxr_linenumber" name="L166" href="#L166">166</a> } -<a class="jxr_linenumber" name="L167" href="#L167">167</a> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">if</strong> (expression == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">if</strong> (output != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L170" href="#L170">170</a> getLog().warn(<span class="jxr_string">"When prompting for input, the result will be written to the console, "</span> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> + <span class="jxr_string">"ignoring 'output'."</span>); -<a class="jxr_linenumber" name="L172" href="#L172">172</a> } -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) { -<a class="jxr_linenumber" name="L174" href="#L174">174</a> getLog().info(<span class="jxr_string">"Enter the Maven expression i.e. ${project.groupId} or 0 to exit?:"</span>); -<a class="jxr_linenumber" name="L175" href="#L175">175</a> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L177" href="#L177">177</a> String userExpression = inputHandler.readLine(); -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">if</strong> (userExpression == <strong class="jxr_keyword">null</strong> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> || userExpression.toLowerCase(Locale.ENGLISH).equals(<span class="jxr_string">"0"</span>)) { -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L181" href="#L181">181</a> } -<a class="jxr_linenumber" name="L182" href="#L182">182</a> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> handleResponse(userExpression, <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L184" href="#L184">184</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Unable to read from standard input."</span>, e); -<a class="jxr_linenumber" name="L186" href="#L186">186</a> } -<a class="jxr_linenumber" name="L187" href="#L187">187</a> } -<a class="jxr_linenumber" name="L188" href="#L188">188</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L189" href="#L189">189</a> handleResponse(<span class="jxr_string">"${"</span> + expression + <span class="jxr_string">"}"</span>, output); -<a class="jxr_linenumber" name="L190" href="#L190">190</a> } -<a class="jxr_linenumber" name="L191" href="#L191">191</a> } -<a class="jxr_linenumber" name="L192" href="#L192">192</a> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_comment">// Private methods</em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> -<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"> * Validate Mojo parameters.</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">void</strong> validateParameters() { -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">if</strong> (artifact == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_comment">// using project if found or super-pom</em> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> getLog().info(<span class="jxr_string">"No artifact parameter specified, using '"</span> + project.getId() + <span class="jxr_string">"' as project."</span>); -<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> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * @return a lazy loading evaluator object.</em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException if any reflection exceptions occur or missing components.</em> -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">private</strong> PluginParameterExpressionEvaluator getEvaluator() <strong class="jxr_keyword">throws</strong> MojoFailureException { -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">if</strong> (evaluator == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L213" href="#L213">213</a> MojoDescriptor mojoDescriptor; -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L215" href="#L215">215</a> mojoDescriptor = mojoDescriptorCreator.getMojoDescriptor(<span class="jxr_string">"help:evaluate"</span>, session, project); -<a class="jxr_linenumber" name="L216" href="#L216">216</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(<span class="jxr_string">"Failure while evaluating."</span>, e); -<a class="jxr_linenumber" name="L218" href="#L218">218</a> } -<a class="jxr_linenumber" name="L219" href="#L219">219</a> MojoExecution mojoExecution = <strong class="jxr_keyword">new</strong> MojoExecution(mojoDescriptor); -<a class="jxr_linenumber" name="L220" href="#L220">220</a> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> MavenProject currentProject = session.getCurrentProject(); -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_comment">// Maven 3: PluginParameterExpressionEvaluator gets the current project from the session:</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_comment">// synchronize in case another thread wants to fetch the real current project in between</em> -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">synchronized</strong> (session) { -<a class="jxr_linenumber" name="L225" href="#L225">225</a> session.setCurrentProject(project); -<a class="jxr_linenumber" name="L226" href="#L226">226</a> evaluator = <strong class="jxr_keyword">new</strong> PluginParameterExpressionEvaluator(session, mojoExecution); -<a class="jxr_linenumber" name="L227" href="#L227">227</a> session.setCurrentProject(currentProject); -<a class="jxr_linenumber" name="L228" href="#L228">228</a> } -<a class="jxr_linenumber" name="L229" href="#L229">229</a> } -<a class="jxr_linenumber" name="L230" href="#L230">230</a> -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">return</strong> evaluator; -<a class="jxr_linenumber" name="L232" href="#L232">232</a> } -<a class="jxr_linenumber" name="L233" href="#L233">233</a> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @param expr the user expression asked.</em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * @param output the file where to write the result, or <code>null</code> to print in standard output.</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if any</em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException if any reflection exceptions occur or missing components.</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> handleResponse(String expr, File output) <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { -<a class="jxr_linenumber" name="L241" href="#L241">241</a> StringBuilder response = <strong class="jxr_keyword">new</strong> StringBuilder(); -<a class="jxr_linenumber" name="L242" href="#L242">242</a> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> Object obj; -<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L245" href="#L245">245</a> obj = getEvaluator().evaluate(expr); -<a class="jxr_linenumber" name="L246" href="#L246">246</a> } <strong class="jxr_keyword">catch</strong> (ExpressionEvaluationException e) { -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Error when evaluating the Maven expression"</span>, e); -<a class="jxr_linenumber" name="L248" href="#L248">248</a> } -<a class="jxr_linenumber" name="L249" href="#L249">249</a> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">if</strong> (obj != <strong class="jxr_keyword">null</strong> && expr.equals(obj.toString())) { -<a class="jxr_linenumber" name="L251" href="#L251">251</a> getLog().warn(<span class="jxr_string">"The Maven expression was invalid. Please use a valid expression."</span>); -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L253" href="#L253">253</a> } -<a class="jxr_linenumber" name="L254" href="#L254">254</a> -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_comment">// handle null</em> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">if</strong> (obj == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L257" href="#L257">257</a> response.append(<span class="jxr_string">"null object or invalid expression"</span>); -<a class="jxr_linenumber" name="L258" href="#L258">258</a> } -<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_comment">// handle primitives objects</em> -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof String) { -<a class="jxr_linenumber" name="L261" href="#L261">261</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L262" href="#L262">262</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Boolean) { -<a class="jxr_linenumber" name="L263" href="#L263">263</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L264" href="#L264">264</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Byte) { -<a class="jxr_linenumber" name="L265" href="#L265">265</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L266" href="#L266">266</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Character) { -<a class="jxr_linenumber" name="L267" href="#L267">267</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L268" href="#L268">268</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Double) { -<a class="jxr_linenumber" name="L269" href="#L269">269</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L270" href="#L270">270</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Float) { -<a class="jxr_linenumber" name="L271" href="#L271">271</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L272" href="#L272">272</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Integer) { -<a class="jxr_linenumber" name="L273" href="#L273">273</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L274" href="#L274">274</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Long) { -<a class="jxr_linenumber" name="L275" href="#L275">275</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L276" href="#L276">276</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Short) { -<a class="jxr_linenumber" name="L277" href="#L277">277</a> response.append(obj.toString()); -<a class="jxr_linenumber" name="L278" href="#L278">278</a> } -<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_comment">// handle specific objects</em> -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof File) { -<a class="jxr_linenumber" name="L281" href="#L281">281</a> File f = (File) obj; -<a class="jxr_linenumber" name="L282" href="#L282">282</a> response.append(f.getAbsolutePath()); -<a class="jxr_linenumber" name="L283" href="#L283">283</a> } -<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_comment">// handle Maven pom object</em> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof MavenProject) { -<a class="jxr_linenumber" name="L286" href="#L286">286</a> MavenProject projectAsked = (MavenProject) obj; -<a class="jxr_linenumber" name="L287" href="#L287">287</a> StringWriter sWriter = <strong class="jxr_keyword">new</strong> StringWriter(); -<a class="jxr_linenumber" name="L288" href="#L288">288</a> MavenXpp3Writer pomWriter = <strong class="jxr_keyword">new</strong> MavenXpp3Writer(); -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L290" href="#L290">290</a> pomWriter.write(sWriter, projectAsked.getModel()); -<a class="jxr_linenumber" name="L291" href="#L291">291</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Error when writing pom"</span>, e); -<a class="jxr_linenumber" name="L293" href="#L293">293</a> } -<a class="jxr_linenumber" name="L294" href="#L294">294</a> -<a class="jxr_linenumber" name="L295" href="#L295">295</a> response.append(sWriter.toString()); -<a class="jxr_linenumber" name="L296" href="#L296">296</a> } -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_comment">// handle Maven Settings object</em> -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof Settings) { -<a class="jxr_linenumber" name="L299" href="#L299">299</a> Settings settingsAsked = (Settings) obj; -<a class="jxr_linenumber" name="L300" href="#L300">300</a> StringWriter sWriter = <strong class="jxr_keyword">new</strong> StringWriter(); -<a class="jxr_linenumber" name="L301" href="#L301">301</a> SettingsXpp3Writer settingsWriter = <strong class="jxr_keyword">new</strong> SettingsXpp3Writer(); -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L303" href="#L303">303</a> settingsWriter.write(sWriter, settingsAsked); -<a class="jxr_linenumber" name="L304" href="#L304">304</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Error when writing settings"</span>, e); -<a class="jxr_linenumber" name="L306" href="#L306">306</a> } -<a class="jxr_linenumber" name="L307" href="#L307">307</a> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> response.append(sWriter.toString()); -<a class="jxr_linenumber" name="L309" href="#L309">309</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_comment">// others Maven objects</em> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> response.append(toXML(expr, obj)); -<a class="jxr_linenumber" name="L312" href="#L312">312</a> } -<a class="jxr_linenumber" name="L313" href="#L313">313</a> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">if</strong> (output != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L316" href="#L316">316</a> writeFile(output, response); -<a class="jxr_linenumber" name="L317" href="#L317">317</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot write evaluation of expression to output: "</span> + output, e); -<a class="jxr_linenumber" name="L319" href="#L319">319</a> } -<a class="jxr_linenumber" name="L320" href="#L320">320</a> getLog().info(<span class="jxr_string">"Result of evaluation written to: "</span> + output); -<a class="jxr_linenumber" name="L321" href="#L321">321</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">if</strong> (getLog().isInfoEnabled()) { -<a class="jxr_linenumber" name="L323" href="#L323">323</a> getLog().info(LS + response.toString()); -<a class="jxr_linenumber" name="L324" href="#L324">324</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">if</strong> (forceStdout) { -<a class="jxr_linenumber" name="L326" href="#L326">326</a> System.out.print(response.toString()); -<a class="jxr_linenumber" name="L327" href="#L327">327</a> System.out.flush(); -<a class="jxr_linenumber" name="L328" href="#L328">328</a> } -<a class="jxr_linenumber" name="L329" href="#L329">329</a> } -<a class="jxr_linenumber" name="L330" href="#L330">330</a> } -<a class="jxr_linenumber" name="L331" href="#L331">331</a> } -<a class="jxr_linenumber" name="L332" href="#L332">332</a> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * @param expr the user expression.</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * @param obj a not null.</em> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @return the XML for the given object.</em> -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">private</strong> String toXML(String expr, Object obj) { -<a class="jxr_linenumber" name="L339" href="#L339">339</a> XStream currentXStream = getXStream(); -<a class="jxr_linenumber" name="L340" href="#L340">340</a> -<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_comment">// beautify list</em> -<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">if</strong> (obj instanceof List) { -<a class="jxr_linenumber" name="L343" href="#L343">343</a> List<?> list = (List<?>) obj; -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">if</strong> (!list.isEmpty()) { -<a class="jxr_linenumber" name="L345" href="#L345">345</a> Object elt = list.iterator().next(); -<a class="jxr_linenumber" name="L346" href="#L346">346</a> -<a class="jxr_linenumber" name="L347" href="#L347">347</a> String name = StringUtils.lowercaseFirstLetter(elt.getClass().getSimpleName()); -<a class="jxr_linenumber" name="L348" href="#L348">348</a> currentXStream.alias(pluralize(name), List.<strong class="jxr_keyword">class</strong>); -<a class="jxr_linenumber" name="L349" href="#L349">349</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_comment">// try to detect the alias from question</em> -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">if</strong> (expr.indexOf('.') != -1) { -<a class="jxr_linenumber" name="L352" href="#L352">352</a> String name = expr.substring(expr.indexOf('.') + 1, expr.indexOf('}')); -<a class="jxr_linenumber" name="L353" href="#L353">353</a> currentXStream.alias(name, List.<strong class="jxr_keyword">class</strong>); -<a class="jxr_linenumber" name="L354" href="#L354">354</a> } -<a class="jxr_linenumber" name="L355" href="#L355">355</a> } -<a class="jxr_linenumber" name="L356" href="#L356">356</a> } -<a class="jxr_linenumber" name="L357" href="#L357">357</a> -<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">return</strong> currentXStream.toXML(obj); -<a class="jxr_linenumber" name="L359" href="#L359">359</a> } -<a class="jxr_linenumber" name="L360" href="#L360">360</a> -<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> * @return lazy loading xstream object.</em> -<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">private</strong> XStream getXStream() { -<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">if</strong> (xstream == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L366" href="#L366">366</a> xstream = <strong class="jxr_keyword">new</strong> XStream(); -<a class="jxr_linenumber" name="L367" href="#L367">367</a> addAlias(xstream); -<a class="jxr_linenumber" name="L368" href="#L368">368</a> -<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_comment">// handle Properties a la Maven</em> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> xstream.registerConverter(<strong class="jxr_keyword">new</strong> PropertiesConverter() { -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L372" href="#L372">372</a> @Override -<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canConvert(Class type) { -<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">return</strong> Properties.<strong class="jxr_keyword">class</strong> == type; -<a class="jxr_linenumber" name="L375" href="#L375">375</a> } -<a class="jxr_linenumber" name="L376" href="#L376">376</a> -<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L378" href="#L378">378</a> @Override -<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context) { -<a class="jxr_linenumber" name="L380" href="#L380">380</a> Properties properties = (Properties) source; -<a class="jxr_linenumber" name="L381" href="#L381">381</a> Map<?, ?> map = <strong class="jxr_keyword">new</strong> TreeMap<>(properties); <em class="jxr_comment">// sort</em> -<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">for</strong> (Map.Entry<?, ?> entry : map.entrySet()) { -<a class="jxr_linenumber" name="L383" href="#L383">383</a> writer.startNode(entry.getKey().toString()); -<a class="jxr_linenumber" name="L384" href="#L384">384</a> writer.setValue(entry.getValue().toString()); -<a class="jxr_linenumber" name="L385" href="#L385">385</a> writer.endNode(); -<a class="jxr_linenumber" name="L386" href="#L386">386</a> } -<a class="jxr_linenumber" name="L387" href="#L387">387</a> } -<a class="jxr_linenumber" name="L388" href="#L388">388</a> }); -<a class="jxr_linenumber" name="L389" href="#L389">389</a> } -<a class="jxr_linenumber" name="L390" href="#L390">390</a> -<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">return</strong> xstream; -<a class="jxr_linenumber" name="L392" href="#L392">392</a> } -<a class="jxr_linenumber" name="L393" href="#L393">393</a> -<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * @param xstreamObject not null</em> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addAlias(XStream xstreamObject) { -<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L399" href="#L399">399</a> addAlias(xstreamObject, getArtifactFile(<span class="jxr_string">"maven-model"</span>), <span class="jxr_string">"org.apache.maven.model"</span>); -<a class="jxr_linenumber" name="L400" href="#L400">400</a> addAlias(xstreamObject, getArtifactFile(<span class="jxr_string">"maven-settings"</span>), <span class="jxr_string">"org.apache.maven.settings"</span>); -<a class="jxr_linenumber" name="L401" href="#L401">401</a> } <strong class="jxr_keyword">catch</strong> (MojoExecutionException | RepositoryException e) { -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) { -<a class="jxr_linenumber" name="L403" href="#L403">403</a> getLog().debug(e.getMessage(), e); -<a class="jxr_linenumber" name="L404" href="#L404">404</a> } -<a class="jxr_linenumber" name="L405" href="#L405">405</a> } -<a class="jxr_linenumber" name="L406" href="#L406">406</a> -<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_comment">// TODO need to handle specific Maven objects like DefaultArtifact?</em> -<a class="jxr_linenumber" name="L408" href="#L408">408</a> } -<a class="jxr_linenumber" name="L409" href="#L409">409</a> -<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> * @param xstreamObject not null</em> -<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> * @param jarFile not null</em> -<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * @param packageFilter a package name to filter.</em> -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addAlias(XStream xstreamObject, File jarFile, String packageFilter) { -<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">try</strong> (FileInputStream fis = <strong class="jxr_keyword">new</strong> FileInputStream(jarFile); -<a class="jxr_linenumber" name="L417" href="#L417">417</a> JarInputStream jarStream = <strong class="jxr_keyword">new</strong> JarInputStream(fis)) { -<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">for</strong> (JarEntry jarEntry = jarStream.getNextJarEntry(); -<a class="jxr_linenumber" name="L419" href="#L419">419</a> jarEntry != <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L420" href="#L420">420</a> jarEntry = jarStream.getNextJarEntry()) { -<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">if</strong> (jarEntry.getName().toLowerCase(Locale.ENGLISH).endsWith(<span class="jxr_string">".class"</span>)) { -<a class="jxr_linenumber" name="L422" href="#L422">422</a> String name = -<a class="jxr_linenumber" name="L423" href="#L423">423</a> jarEntry.getName().substring(0, jarEntry.getName().indexOf(<span class="jxr_string">"."</span>)); -<a class="jxr_linenumber" name="L424" href="#L424">424</a> name = name.replace(<span class="jxr_string">"/"</span>, <span class="jxr_string">"\\."</span>); -<a class="jxr_linenumber" name="L425" href="#L425">425</a> -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">if</strong> (name.contains(packageFilter) && !name.contains(<span class="jxr_string">"$"</span>)) { -<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L428" href="#L428">428</a> Class<?> clazz = ClassUtils.getClass(name); -<a class="jxr_linenumber" name="L429" href="#L429">429</a> String alias = StringUtils.lowercaseFirstLetter(clazz.getSimpleName()); -<a class="jxr_linenumber" name="L430" href="#L430">430</a> xstreamObject.alias(alias, clazz); -<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">if</strong> (!clazz.equals(Model.<strong class="jxr_keyword">class</strong>)) { -<a class="jxr_linenumber" name="L432" href="#L432">432</a> xstreamObject.omitField(clazz, <span class="jxr_string">"modelEncoding"</span>); <em class="jxr_comment">// unnecessary field</em> -<a class="jxr_linenumber" name="L433" href="#L433">433</a> } -<a class="jxr_linenumber" name="L434" href="#L434">434</a> } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException e) { -<a class="jxr_linenumber" name="L435" href="#L435">435</a> getLog().error(e); -<a class="jxr_linenumber" name="L436" href="#L436">436</a> } -<a class="jxr_linenumber" name="L437" href="#L437">437</a> } -<a class="jxr_linenumber" name="L438" href="#L438">438</a> } -<a class="jxr_linenumber" name="L439" href="#L439">439</a> -<a class="jxr_linenumber" name="L440" href="#L440">440</a> jarStream.closeEntry(); -<a class="jxr_linenumber" name="L441" href="#L441">441</a> } -<a class="jxr_linenumber" name="L442" href="#L442">442</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) { -<a class="jxr_linenumber" name="L444" href="#L444">444</a> getLog().debug(<span class="jxr_string">"IOException: "</span> + e.getMessage(), e); -<a class="jxr_linenumber" name="L445" href="#L445">445</a> } -<a class="jxr_linenumber" name="L446" href="#L446">446</a> } -<a class="jxr_linenumber" name="L447" href="#L447">447</a> } -<a class="jxr_linenumber" name="L448" href="#L448">448</a> -<a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment"> * @return the <code>org.apache.maven: artifactId </code> artifact jar file for this current HelpPlugin pom.</em> -<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if any</em> -<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">private</strong> File getArtifactFile(String artifactId) <strong class="jxr_keyword">throws</strong> MojoExecutionException, RepositoryException { -<a class="jxr_linenumber" name="L454" href="#L454">454</a> List<Dependency> dependencies = getHelpPluginPom().getDependencies(); -<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong class="jxr_keyword">for</strong> (Dependency dependency : dependencies) { -<a class="jxr_linenumber" name="L456" href="#L456">456</a> <strong class="jxr_keyword">if</strong> ((<span class="jxr_string">"org.apache.maven"</span>.equals(dependency.getGroupId()))) { -<a class="jxr_linenumber" name="L457" href="#L457">457</a> <strong class="jxr_keyword">if</strong> ((artifactId.equals(dependency.getArtifactId()))) { -<a class="jxr_linenumber" name="L458" href="#L458">458</a> Artifact mavenArtifact = <strong class="jxr_keyword">new</strong> DefaultArtifact( -<a class="jxr_linenumber" name="L459" href="#L459">459</a> dependency.getGroupId(), dependency.getArtifactId(), <span class="jxr_string">"jar"</span>, dependency.getVersion()); -<a class="jxr_linenumber" name="L460" href="#L460">460</a> -<a class="jxr_linenumber" name="L461" href="#L461">461</a> <strong class="jxr_keyword">return</strong> resolveArtifact(mavenArtifact).getArtifact().getFile(); -<a class="jxr_linenumber" name="L462" href="#L462">462</a> } -<a class="jxr_linenumber" name="L463" href="#L463">463</a> } -<a class="jxr_linenumber" name="L464" href="#L464">464</a> } -<a class="jxr_linenumber" name="L465" href="#L465">465</a> -<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Unable to find the 'org.apache.maven:"</span> + artifactId + <span class="jxr_string">"' artifact"</span>); -<a class="jxr_linenumber" name="L467" href="#L467">467</a> } -<a class="jxr_linenumber" name="L468" href="#L468">468</a> -<a class="jxr_linenumber" name="L469" href="#L469">469</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_javadoccomment"> * @return the Maven POM for the current help plugin</em> -<a class="jxr_linenumber" name="L471" href="#L471">471</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if any</em> -<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L473" href="#L473">473</a> <strong class="jxr_keyword">private</strong> MavenProject getHelpPluginPom() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L474" href="#L474">474</a> String resource = <span class="jxr_string">"META-INF/maven/org.apache.maven.plugins/maven-help-plugin/pom.properties"</span>; -<a class="jxr_linenumber" name="L475" href="#L475">475</a> -<a class="jxr_linenumber" name="L476" href="#L476">476</a> InputStream resourceAsStream = EvaluateMojo.<strong class="jxr_keyword">class</strong>.getClassLoader().getResourceAsStream(resource); -<a class="jxr_linenumber" name="L477" href="#L477">477</a> <strong class="jxr_keyword">if</strong> (resourceAsStream == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L478" href="#L478">478</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"The help plugin artifact was not found."</span>); -<a class="jxr_linenumber" name="L479" href="#L479">479</a> } -<a class="jxr_linenumber" name="L480" href="#L480">480</a> Properties properties = <strong class="jxr_keyword">new</strong> Properties(); -<a class="jxr_linenumber" name="L481" href="#L481">481</a> <strong class="jxr_keyword">try</strong> (InputStream is = resourceAsStream) { -<a class="jxr_linenumber" name="L482" href="#L482">482</a> properties.load(is); -<a class="jxr_linenumber" name="L483" href="#L483">483</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L484" href="#L484">484</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) { -<a class="jxr_linenumber" name="L485" href="#L485">485</a> getLog().debug(<span class="jxr_string">"IOException: "</span> + e.getMessage(), e); -<a class="jxr_linenumber" name="L486" href="#L486">486</a> } -<a class="jxr_linenumber" name="L487" href="#L487">487</a> } -<a class="jxr_linenumber" name="L488" href="#L488">488</a> -<a class="jxr_linenumber" name="L489" href="#L489">489</a> String artifactString = properties.getProperty(<span class="jxr_string">"groupId"</span>, <span class="jxr_string">"unknown"</span>) + <span class="jxr_string">":"</span> -<a class="jxr_linenumber" name="L490" href="#L490">490</a> + properties.getProperty(<span class="jxr_string">"artifactId"</span>, <span class="jxr_string">"unknown"</span>) + <span class="jxr_string">":"</span> -<a class="jxr_linenumber" name="L491" href="#L491">491</a> + properties.getProperty(<span class="jxr_string">"version"</span>, <span class="jxr_string">"unknown"</span>); -<a class="jxr_linenumber" name="L492" href="#L492">492</a> -<a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">return</strong> getMavenProject(artifactString); -<a class="jxr_linenumber" name="L494" href="#L494">494</a> } -<a class="jxr_linenumber" name="L495" href="#L495">495</a> -<a class="jxr_linenumber" name="L496" href="#L496">496</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L497" href="#L497">497</a> <em class="jxr_javadoccomment"> * @param name not null</em> -<a class="jxr_linenumber" name="L498" href="#L498">498</a> <em class="jxr_javadoccomment"> * @return the plural of the name</em> -<a class="jxr_linenumber" name="L499" href="#L499">499</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L500" href="#L500">500</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String pluralize(String name) { -<a class="jxr_linenumber" name="L501" href="#L501">501</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(name)) { -<a class="jxr_linenumber" name="L502" href="#L502">502</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"name is required"</span>); -<a class="jxr_linenumber" name="L503" href="#L503">503</a> } -<a class="jxr_linenumber" name="L504" href="#L504">504</a> -<a class="jxr_linenumber" name="L505" href="#L505">505</a> <strong class="jxr_keyword">if</strong> (name.endsWith(<span class="jxr_string">"y"</span>)) { -<a class="jxr_linenumber" name="L506" href="#L506">506</a> <strong class="jxr_keyword">return</strong> name.substring(0, name.length() - 1) + <span class="jxr_string">"ies"</span>; -<a class="jxr_linenumber" name="L507" href="#L507">507</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (name.endsWith(<span class="jxr_string">"s"</span>)) { -<a class="jxr_linenumber" name="L508" href="#L508">508</a> <strong class="jxr_keyword">return</strong> name; -<a class="jxr_linenumber" name="L509" href="#L509">509</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L510" href="#L510">510</a> <strong class="jxr_keyword">return</strong> name + <span class="jxr_string">"s"</span>; -<a class="jxr_linenumber" name="L511" href="#L511">511</a> } -<a class="jxr_linenumber" name="L512" href="#L512">512</a> } -<a class="jxr_linenumber" name="L513" href="#L513">513</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>EvaluateMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/EvaluateMojo.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.InputStream; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.StringWriter; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.Properties; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.TreeMap; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.jar.JarEntry; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.jar.JarInputStream; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> com.thoughtworks.xstream.XStream; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> com.thoughtworks.xstream.converters.MarshallingContext; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> com.thoughtworks.xstream.converters.collections.PropertiesConverter; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> com.thoughtworks.xstream.io.HierarchicalStreamWriter; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.ClassUtils; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.lifecycle.internal.MojoDescriptorCreator; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Dependency; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.Model; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.io.xpp3.MavenXpp3Writer; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecution; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.PluginParameterExpressionEvaluator; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.MojoDescriptor; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.io.xpp3.SettingsXpp3Writer; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.components.interactivity.InputHandler; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositoryException; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.artifact.Artifact; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.artifact.DefaultArtifact; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Evaluates Maven expressions given by the user in an interactive mode.</em> +<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"> * @author <a href="<a href="mailto:vincent.sive...@gmail.com"; target="alexandria_uri">mailto:vincent.sive...@gmail.com</a>">Vincent Siveton</a></em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> @Mojo(name = <span class="jxr_string">"evaluate"</span>, requiresProject = false) +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="EvaluateMojo" href="../../../../../org/apache/maven/plugins/help/EvaluateMojo.html#EvaluateMojo">EvaluateMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractHelpMojo" href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo">AbstractHelpMojo</a> { +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_comment">// Mojo components</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Input handler, needed for command line handling.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Component +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> InputHandler inputHandler; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Component used to get mojo descriptors.</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> @Component +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> MojoDescriptorCreator mojoDescriptorCreator; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment">// Mojo parameters</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// we need to hide the 'output' defined in AbstractHelpMojo to have a correct "since".</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Optional parameter to write the output of this help in a given file, instead of writing to the console.</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * This parameter will be ignored if no <code>expression</code> is specified.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * <br/></em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Could be a relative path.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @since 3.0.0</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> @Parameter(property = <span class="jxr_string">"output"</span>) +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">private</strong> File output; +<a class="jxr_linenumber" name="L100" href="#L100">100</a> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * This options gives the option to output information in cases where the output has been suppressed by using</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <code>-q</code> (quiet option) in Maven. This is useful if you like to use</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <code>maven-help-plugin:evaluate</code> in a script call (for example in bash) like this:</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * RESULT=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * echo $RESULT</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * This will only printout the information which has been requested by <code>expression</code> to</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * <code>stdout</code>.</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @since 3.1.0</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> @Parameter(property = <span class="jxr_string">"forceStdout"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> forceStdout; +<a class="jxr_linenumber" name="L118" href="#L118">118</a> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * An artifact for evaluating Maven expressions. <br/></em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Should respect the Maven format, i.e. <code>groupId:artifactId[:version]</code>. The latest version</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * of the artifact will be used when no version is specified.</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> @Parameter(property = <span class="jxr_string">"artifact"</span>) +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">private</strong> String artifact; +<a class="jxr_linenumber" name="L126" href="#L126">126</a> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * An expression to evaluate instead of prompting. Note that this <i>must not</i> include the surrounding ${...}.</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> @Parameter(property = <span class="jxr_string">"expression"</span>) +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">private</strong> String expression; +<a class="jxr_linenumber" name="L132" href="#L132">132</a> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * The system settings for Maven.</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> @Parameter(defaultValue = <span class="jxr_string">"${settings}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">private</strong> Settings settings; +<a class="jxr_linenumber" name="L138" href="#L138">138</a> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// Instance variables</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/** lazy loading evaluator variable */</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">private</strong> PluginParameterExpressionEvaluator evaluator; +<a class="jxr_linenumber" name="L145" href="#L145">145</a> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/** lazy loading xstream variable */</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">private</strong> XStream xstream; +<a class="jxr_linenumber" name="L148" href="#L148">148</a> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_comment">// Public methods</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (expression == <strong class="jxr_keyword">null</strong> && !settings.isInteractiveMode()) { +<a class="jxr_linenumber" name="L156" href="#L156">156</a> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> getLog().error(<span class="jxr_string">"Maven is configured to NOT interact with the user for input. "</span> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> + <span class="jxr_string">"This Mojo requires that 'interactiveMode' in your settings file is flag to 'true'."</span>); +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L160" href="#L160">160</a> } +<a class="jxr_linenumber" name="L161" href="#L161">161</a> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> validateParameters(); +<a class="jxr_linenumber" name="L163" href="#L163">163</a> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">if</strong> (artifact != <strong class="jxr_keyword">null</strong> && !artifact.isEmpty()) {
[... 356 lines stripped ...]
