You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2013/06/25 22:07:47 UTC
svn commit: r867426 [27/34] - in
/websites/production/maven/content/enforcer-archives/enforcer-LATEST: ./
apidocs/ apidocs/org/apache/maven/plugins/enforcer/
apidocs/src-html/org/apache/maven/plugins/enforcer/ enforcer-api/
enforcer-rules/ enforcer-rul...
Modified: websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html
==============================================================================
--- websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html (original)
+++ websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html Tue Jun 25 20:07:43 2013
@@ -37,7 +37,7 @@
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * @author Paul Gier</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * @author <a href='<a href="mailto:marvin" target="alexandria_uri">mailto:marvin</a>[at]marvinformatics[dot]com'>Marvin Froeder</a></em>
-<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractPropertyEnforcerRule.java 1493569 2013-06-16 18:53:12Z rfscholte $</em>
+<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractPropertyEnforcerRule.java 1496229 2013-06-24 21:43:56Z rfscholte $</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html">AbstractPropertyEnforcerRule</a>
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.html">AbstractNonCacheableEnforcerRule</a>
@@ -45,82 +45,121 @@
<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"> * Match the property value to a given regular expression. Defaults to <code>null</code> (any value is ok).</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> <strong class="jxr_keyword">private</strong> String regex;
-<a class="jxr_linenumber" name="40" href="#40">40</a>
-<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Specify a warning message if the regular expression is not matched.</em>
-<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> String regexMessage;
-<a class="jxr_linenumber" name="45" href="#45">45</a>
-<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html">AbstractPropertyEnforcerRule</a>()
-<a class="jxr_linenumber" name="47" href="#47">47</a> {
-<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">super</strong>();
-<a class="jxr_linenumber" name="49" href="#49">49</a> }
-<a class="jxr_linenumber" name="50" href="#50">50</a>
-<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRegex( String regex )
-<a class="jxr_linenumber" name="52" href="#52">52</a> {
-<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">this</strong>.regex = regex;
-<a class="jxr_linenumber" name="54" href="#54">54</a> }
-<a class="jxr_linenumber" name="55" href="#55">55</a>
-<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRegexMessage( String regexMessage )
-<a class="jxr_linenumber" name="57" href="#57">57</a> {
-<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">this</strong>.regexMessage = regexMessage;
-<a class="jxr_linenumber" name="59" href="#59">59</a> }
-<a class="jxr_linenumber" name="60" href="#60">60</a>
-<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Execute the rule.</em>
-<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param helper the helper</em>
-<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException the enforcer rule exception</em>
-<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute( EnforcerRuleHelper helper )
-<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">throws</strong> EnforcerRuleException
-<a class="jxr_linenumber" name="69" href="#69">69</a> {
-<a class="jxr_linenumber" name="70" href="#70">70</a> Object propValue = resolveValue( helper );
-<a class="jxr_linenumber" name="71" href="#71">71</a>
-<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_comment">// Check that the property is not null or empty string</em>
-<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">if</strong> ( propValue == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="74" href="#74">74</a> {
-<a class="jxr_linenumber" name="75" href="#75">75</a> String message = getMessage();
-<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">if</strong> ( message == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="77" href="#77">77</a> {
-<a class="jxr_linenumber" name="78" href="#78">78</a> message = getName() + <span class="jxr_string">" \""</span> + getPropertyName() + <span class="jxr_string">"\" is required for this build."</span>;
-<a class="jxr_linenumber" name="79" href="#79">79</a> }
-<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( message );
-<a class="jxr_linenumber" name="81" href="#81">81</a> }
-<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_comment">// If there is a regex, check that the property matches it</em>
-<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">if</strong> ( regex != <strong class="jxr_keyword">null</strong> && !propValue.toString().matches( regex ) )
-<a class="jxr_linenumber" name="84" href="#84">84</a> {
-<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> ( regexMessage == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="86" href="#86">86</a> {
-<a class="jxr_linenumber" name="87" href="#87">87</a> regexMessage = getName() + <span class="jxr_string">" \""</span> + getPropertyName() + <span class="jxr_string">"\" evaluates to \""</span> + propValue + <span class="jxr_string">"\". "</span>
-<a class="jxr_linenumber" name="88" href="#88">88</a> + <span class="jxr_string">"This does not match the regular expression \""</span> + regex + <span class="jxr_string">"\""</span>;
-<a class="jxr_linenumber" name="89" href="#89">89</a> }
-<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( regexMessage );
-<a class="jxr_linenumber" name="91" href="#91">91</a> }
-<a class="jxr_linenumber" name="92" href="#92">92</a> }
-<a class="jxr_linenumber" name="93" href="#93">93</a>
-<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * How the property that is being evaluated is called</em>
-<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getName();
-<a class="jxr_linenumber" name="98" href="#98">98</a>
-<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * The name of the property currently being evaluated, this is used for default message pourpouses only</em>
-<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getPropertyName();
-<a class="jxr_linenumber" name="103" href="#103">103</a>
-<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * Resolves the property value</em>
-<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * @param helper</em>
-<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException</em>
-<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> Object resolveValue( EnforcerRuleHelper helper )
-<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">throws</strong> EnforcerRuleException;
-<a class="jxr_linenumber" name="112" href="#112">112</a>
-<a class="jxr_linenumber" name="113" href="#113">113</a> }
+<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"> * @deprecated the visibility will be reduced to private with the next major version</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @see {@link #setRegex(String)}</em>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @see {@link #getRegex()}</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> <strong class="jxr_keyword">public</strong> String regex = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="44" href="#44">44</a>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Specify a warning message if the regular expression is not matched.</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @deprecated the visibility will be reduced to private with the next major version</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @see {@link #setRegexMessage(String)}</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @see {@link #getRegexMessage()}</em>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> String regexMessage = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="53" href="#53">53</a>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html">AbstractPropertyEnforcerRule</a>()
+<a class="jxr_linenumber" name="55" href="#55">55</a> {
+<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">super</strong>();
+<a class="jxr_linenumber" name="57" href="#57">57</a> }
+<a class="jxr_linenumber" name="58" href="#58">58</a>
+<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Set the property value to a given regular expression. Defaults to <code>null</code> (any value is ok).</em>
+<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param the regular expression</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setRegex( String regex )
+<a class="jxr_linenumber" name="65" href="#65">65</a> {
+<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">this</strong>.regex = regex;
+<a class="jxr_linenumber" name="67" href="#67">67</a> }
+<a class="jxr_linenumber" name="68" href="#68">68</a>
+<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Get the property value to a given regular expression. Defaults to <code>null</code> (any value is ok).</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return the regular expression</em>
+<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> String getRegex()
+<a class="jxr_linenumber" name="75" href="#75">75</a> {
+<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">return</strong> regex;
+<a class="jxr_linenumber" name="77" href="#77">77</a> }
+<a class="jxr_linenumber" name="78" href="#78">78</a>
+<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Set a warning message if the regular expression is not matched.</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param regexMessage the regex message</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setRegexMessage( String regexMessage )
+<a class="jxr_linenumber" name="85" href="#85">85</a> {
+<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">this</strong>.regexMessage = regexMessage;
+<a class="jxr_linenumber" name="87" href="#87">87</a> }
+<a class="jxr_linenumber" name="88" href="#88">88</a>
+<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Get a warning message if the regular expression is not matched.</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @return the regex message</em>
+<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> String getRegexMessage()
+<a class="jxr_linenumber" name="95" href="#95">95</a> {
+<a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">return</strong> regexMessage;
+<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>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Execute the rule.</em>
+<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @param helper the helper</em>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException the enforcer rule exception</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute( EnforcerRuleHelper helper )
+<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">throws</strong> EnforcerRuleException
+<a class="jxr_linenumber" name="108" href="#108">108</a> {
+<a class="jxr_linenumber" name="109" href="#109">109</a> Object propValue = resolveValue( helper );
+<a class="jxr_linenumber" name="110" href="#110">110</a>
+<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_comment">// Check that the property is not null or empty string</em>
+<a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">if</strong> ( propValue == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="113" href="#113">113</a> {
+<a class="jxr_linenumber" name="114" href="#114">114</a> String message = getMessage();
+<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">if</strong> ( message == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="116" href="#116">116</a> {
+<a class="jxr_linenumber" name="117" href="#117">117</a> message = getName() + <span class="jxr_string">" \""</span> + getPropertyName() + <span class="jxr_string">"\" is required for this build."</span>;
+<a class="jxr_linenumber" name="118" href="#118">118</a> }
+<a class="jxr_linenumber" name="119" href="#119">119</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( message );
+<a class="jxr_linenumber" name="120" href="#120">120</a> }
+<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_comment">// If there is a regex, check that the property matches it</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <strong class="jxr_keyword">if</strong> ( regex != <strong class="jxr_keyword">null</strong> && !propValue.toString().matches( regex ) )
+<a class="jxr_linenumber" name="123" href="#123">123</a> {
+<a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> ( regexMessage == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="125" href="#125">125</a> {
+<a class="jxr_linenumber" name="126" href="#126">126</a> regexMessage = getName() + <span class="jxr_string">" \""</span> + getPropertyName() + <span class="jxr_string">"\" evaluates to \""</span> + propValue + <span class="jxr_string">"\". "</span>
+<a class="jxr_linenumber" name="127" href="#127">127</a> + <span class="jxr_string">"This does not match the regular expression \""</span> + regex + <span class="jxr_string">"\""</span>;
+<a class="jxr_linenumber" name="128" href="#128">128</a> }
+<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( regexMessage );
+<a class="jxr_linenumber" name="130" href="#130">130</a> }
+<a class="jxr_linenumber" name="131" href="#131">131</a> }
+<a class="jxr_linenumber" name="132" href="#132">132</a>
+<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * How the property that is being evaluated is called</em>
+<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getName();
+<a class="jxr_linenumber" name="137" href="#137">137</a>
+<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * The name of the property currently being evaluated, this is used for default message pourpouses only</em>
+<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getPropertyName();
+<a class="jxr_linenumber" name="142" href="#142">142</a>
+<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Resolves the property value</em>
+<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @param helper</em>
+<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException</em>
+<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="149" href="#149">149</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> Object resolveValue( EnforcerRuleHelper helper )
+<a class="jxr_linenumber" name="150" href="#150">150</a> <strong class="jxr_keyword">throws</strong> EnforcerRuleException;
+<a class="jxr_linenumber" name="151" href="#151">151</a>
+<a class="jxr_linenumber" name="152" href="#152">152</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
Modified: websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.html
==============================================================================
--- websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.html (original)
+++ websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.html Tue Jun 25 20:07:43 2013
@@ -38,20 +38,26 @@
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">implements</strong> EnforcerRule
<a class="jxr_linenumber" name="29" href="#29">29</a> {
<a class="jxr_linenumber" name="30" href="#30">30</a>
-<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Specify a friendly message if the rule fails. */</em>
-<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">private</strong> String message;
-<a class="jxr_linenumber" name="33" href="#33">33</a>
-<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setMessage( String message )
-<a class="jxr_linenumber" name="35" href="#35">35</a> {
-<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">this</strong>.message = message;
-<a class="jxr_linenumber" name="37" href="#37">37</a> }
-<a class="jxr_linenumber" name="38" href="#38">38</a>
-<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> String getMessage()
-<a class="jxr_linenumber" name="40" href="#40">40</a> {
-<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">return</strong> message;
-<a class="jxr_linenumber" name="42" href="#42">42</a> }
-<a class="jxr_linenumber" name="43" href="#43">43</a>
-<a class="jxr_linenumber" name="44" href="#44">44</a> }
+<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Specify a friendly message if the rule fails.</em>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @deprecated the visibility will be reduced to private with the next major version</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @see {@link #setMessage(String)}</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @see {@link #getMessage()}</em>
+<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"> */</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">public</strong> String message = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="39" href="#39">39</a>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setMessage( String message )
+<a class="jxr_linenumber" name="41" href="#41">41</a> {
+<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">this</strong>.message = message;
+<a class="jxr_linenumber" name="43" href="#43">43</a> }
+<a class="jxr_linenumber" name="44" href="#44">44</a>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> String getMessage()
+<a class="jxr_linenumber" name="46" href="#46">46</a> {
+<a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">return</strong> message;
+<a class="jxr_linenumber" name="48" href="#48">48</a> }
+<a class="jxr_linenumber" name="49" href="#49">49</a>
+<a class="jxr_linenumber" name="50" href="#50">50</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
Modified: websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.html
==============================================================================
--- websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.html (original)
+++ websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.html Tue Jun 25 20:07:43 2013
@@ -44,7 +44,7 @@
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Contains the common code to compare a version against a version range.</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brianf@apache.org" target="alexandria_uri">mailto:brianf@apache.org</a>">Brian Fox</a></em>
-<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractVersionEnforcer.java 1493575 2013-06-16 19:23:51Z rfscholte $</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractVersionEnforcer.java 1496229 2013-06-24 21:43:56Z rfscholte $</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.html">AbstractVersionEnforcer</a>
<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.html">AbstractStandardEnforcerRule</a>
@@ -59,166 +59,171 @@
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <li><code>[2.0.5,)</code> Versions 2.0.5 and higher</li></em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <li><code>(,2.0.5],[2.1.1,)</code> Versions up to 2.0.5 (included) and 2.1.1 or higher</li></em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * </ul></em>
-<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> String version;
-<a class="jxr_linenumber" name="54" href="#54">54</a>
-<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * Compares the specified version to see if it is allowed by the defined version range.</em>
-<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @param log the log</em>
-<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @param variableName name of variable to use in messages (Example: "Maven" or "Java" etc).</em>
-<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @param requiredVersionRange range of allowed versions.</em>
-<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param actualVersion the version to be checked.</em>
-<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException the enforcer rule exception</em>
-<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="64" href="#64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> enforceVersion( Log log, String variableName, String requiredVersionRange, ArtifactVersion actualVersion )
-<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">throws</strong> EnforcerRuleException
-<a class="jxr_linenumber" name="66" href="#66">66</a> {
-<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( requiredVersionRange ) )
-<a class="jxr_linenumber" name="68" href="#68">68</a> {
-<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( variableName + <span class="jxr_string">" version can't be empty."</span> );
-<a class="jxr_linenumber" name="70" href="#70">70</a> }
-<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">else</strong>
-<a class="jxr_linenumber" name="72" href="#72">72</a> {
-<a class="jxr_linenumber" name="73" href="#73">73</a>
-<a class="jxr_linenumber" name="74" href="#74">74</a> VersionRange vr;
-<a class="jxr_linenumber" name="75" href="#75">75</a> String msg = <span class="jxr_string">"Detected "</span> + variableName + <span class="jxr_string">" Version: "</span> + actualVersion;
-<a class="jxr_linenumber" name="76" href="#76">76</a>
-<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_comment">// short circuit check if the strings are exactly equal</em>
-<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">if</strong> ( actualVersion.toString().equals( requiredVersionRange ) )
-<a class="jxr_linenumber" name="79" href="#79">79</a> {
-<a class="jxr_linenumber" name="80" href="#80">80</a> log.debug( msg + <span class="jxr_string">" is allowed in the range "</span> + requiredVersionRange + <span class="jxr_string">"."</span> );
-<a class="jxr_linenumber" name="81" href="#81">81</a> }
-<a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">else</strong>
-<a class="jxr_linenumber" name="83" href="#83">83</a> {
-<a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">try</strong>
-<a class="jxr_linenumber" name="85" href="#85">85</a> {
-<a class="jxr_linenumber" name="86" href="#86">86</a> vr = VersionRange.createFromVersionSpec( requiredVersionRange );
-<a class="jxr_linenumber" name="87" href="#87">87</a>
-<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">if</strong> ( containsVersion( vr, actualVersion ) )
-<a class="jxr_linenumber" name="89" href="#89">89</a> {
-<a class="jxr_linenumber" name="90" href="#90">90</a> log.debug( msg + <span class="jxr_string">" is allowed in the range "</span> + requiredVersionRange + <span class="jxr_string">"."</span> );
-<a class="jxr_linenumber" name="91" href="#91">91</a> }
-<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">else</strong>
-<a class="jxr_linenumber" name="93" href="#93">93</a> {
-<a class="jxr_linenumber" name="94" href="#94">94</a> String message = getMessage();
-<a class="jxr_linenumber" name="95" href="#95">95</a>
-<a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( message ) )
-<a class="jxr_linenumber" name="97" href="#97">97</a> {
-<a class="jxr_linenumber" name="98" href="#98">98</a> message = msg + <span class="jxr_string">" is not in the allowed range "</span> + vr + <span class="jxr_string">"."</span>;
-<a class="jxr_linenumber" name="99" href="#99">99</a> }
-<a class="jxr_linenumber" name="100" href="#100">100</a>
-<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( message );
-<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">catch</strong> ( InvalidVersionSpecificationException e )
-<a class="jxr_linenumber" name="105" href="#105">105</a> {
-<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( <span class="jxr_string">"The requested "</span> + variableName + <span class="jxr_string">" version "</span>
-<a class="jxr_linenumber" name="107" href="#107">107</a> + requiredVersionRange + <span class="jxr_string">" is invalid."</span>, e );
+<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @deprecated the visibility will be reduced to private with the next major version</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @see {@link #setVersion(String)}</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @see {@link #getVersion()}</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">public</strong> String version = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="59" href="#59">59</a>
+<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Compares the specified version to see if it is allowed by the defined version range.</em>
+<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @param log the log</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param variableName name of variable to use in messages (Example: "Maven" or "Java" etc).</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @param requiredVersionRange range of allowed versions.</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @param actualVersion the version to be checked.</em>
+<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException the enforcer rule exception</em>
+<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> enforceVersion( Log log, String variableName, String requiredVersionRange, ArtifactVersion actualVersion )
+<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">throws</strong> EnforcerRuleException
+<a class="jxr_linenumber" name="71" href="#71">71</a> {
+<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( requiredVersionRange ) )
+<a class="jxr_linenumber" name="73" href="#73">73</a> {
+<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( variableName + <span class="jxr_string">" version can't be empty."</span> );
+<a class="jxr_linenumber" name="75" href="#75">75</a> }
+<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="77" href="#77">77</a> {
+<a class="jxr_linenumber" name="78" href="#78">78</a>
+<a class="jxr_linenumber" name="79" href="#79">79</a> VersionRange vr;
+<a class="jxr_linenumber" name="80" href="#80">80</a> String msg = <span class="jxr_string">"Detected "</span> + variableName + <span class="jxr_string">" Version: "</span> + actualVersion;
+<a class="jxr_linenumber" name="81" href="#81">81</a>
+<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_comment">// short circuit check if the strings are exactly equal</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">if</strong> ( actualVersion.toString().equals( requiredVersionRange ) )
+<a class="jxr_linenumber" name="84" href="#84">84</a> {
+<a class="jxr_linenumber" name="85" href="#85">85</a> log.debug( msg + <span class="jxr_string">" is allowed in the range "</span> + requiredVersionRange + <span class="jxr_string">"."</span> );
+<a class="jxr_linenumber" name="86" href="#86">86</a> }
+<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">else</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> vr = VersionRange.createFromVersionSpec( requiredVersionRange );
+<a class="jxr_linenumber" name="92" href="#92">92</a>
+<a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">if</strong> ( containsVersion( vr, actualVersion ) )
+<a class="jxr_linenumber" name="94" href="#94">94</a> {
+<a class="jxr_linenumber" name="95" href="#95">95</a> log.debug( msg + <span class="jxr_string">" is allowed in the range "</span> + requiredVersionRange + <span class="jxr_string">"."</span> );
+<a class="jxr_linenumber" name="96" href="#96">96</a> }
+<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="98" href="#98">98</a> {
+<a class="jxr_linenumber" name="99" href="#99">99</a> String message = getMessage();
+<a class="jxr_linenumber" name="100" href="#100">100</a>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( message ) )
+<a class="jxr_linenumber" name="102" href="#102">102</a> {
+<a class="jxr_linenumber" name="103" href="#103">103</a> message = msg + <span class="jxr_string">" is not in the allowed range "</span> + vr + <span class="jxr_string">"."</span>;
+<a class="jxr_linenumber" name="104" href="#104">104</a> }
+<a class="jxr_linenumber" name="105" href="#105">105</a>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( message );
+<a class="jxr_linenumber" name="107" href="#107">107</a> }
<a class="jxr_linenumber" name="108" href="#108">108</a> }
-<a class="jxr_linenumber" name="109" href="#109">109</a> }
-<a class="jxr_linenumber" name="110" href="#110">110</a> }
-<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_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. Currently the default</em>
-<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * containsVersion method assumes a singular version means allow everything. This method assumes that "2.0.4" ==</em>
-<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * "[2.0.4,)"</em>
-<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"> * @param allowedRange range of allowed versions.</em>
-<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param theVersion the version to be checked.</em>
-<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @return true if the version is contained by the range.</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">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> containsVersion( VersionRange allowedRange, ArtifactVersion theVersion )
-<a class="jxr_linenumber" name="123" href="#123">123</a> {
-<a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">boolean</strong> matched = false;
-<a class="jxr_linenumber" name="125" href="#125">125</a> ArtifactVersion recommendedVersion = allowedRange.getRecommendedVersion();
-<a class="jxr_linenumber" name="126" href="#126">126</a> <strong class="jxr_keyword">if</strong> ( recommendedVersion == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="127" href="#127">127</a> {
-<a class="jxr_linenumber" name="128" href="#128">128</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
-<a class="jxr_linenumber" name="129" href="#129">129</a> List<Restriction> restrictions = allowedRange.getRestrictions();
-<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">for</strong> ( Restriction restriction : restrictions )
-<a class="jxr_linenumber" name="131" href="#131">131</a> {
-<a class="jxr_linenumber" name="132" href="#132">132</a> <strong class="jxr_keyword">if</strong> ( restriction.containsVersion( theVersion ) )
-<a class="jxr_linenumber" name="133" href="#133">133</a> {
-<a class="jxr_linenumber" name="134" href="#134">134</a> matched = <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="135" href="#135">135</a> <strong class="jxr_keyword">break</strong>;
-<a class="jxr_linenumber" name="136" href="#136">136</a> }
-<a class="jxr_linenumber" name="137" href="#137">137</a> }
-<a class="jxr_linenumber" name="138" href="#138">138</a> }
-<a class="jxr_linenumber" name="139" href="#139">139</a> <strong class="jxr_keyword">else</strong>
-<a class="jxr_linenumber" name="140" href="#140">140</a> {
-<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_comment">// only singular versions ever have a recommendedVersion</em>
-<a class="jxr_linenumber" name="142" href="#142">142</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
-<a class="jxr_linenumber" name="143" href="#143">143</a> <strong class="jxr_keyword">int</strong> compareTo = recommendedVersion.compareTo( theVersion );
-<a class="jxr_linenumber" name="144" href="#144">144</a> matched = ( compareTo <= 0 );
-<a class="jxr_linenumber" name="145" href="#145">145</a> }
-<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">return</strong> matched;
-<a class="jxr_linenumber" name="147" href="#147">147</a> }
-<a class="jxr_linenumber" name="148" href="#148">148</a>
-<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_comment">/*</em>
-<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_comment"> * (non-Javadoc)</em>
-<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_comment"> *</em>
-<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#getCacheId()</em>
-<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_comment"> */</em>
-<a class="jxr_linenumber" name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> String getCacheId()
-<a class="jxr_linenumber" name="155" href="#155">155</a> {
-<a class="jxr_linenumber" name="156" href="#156">156</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( version ) )
-<a class="jxr_linenumber" name="157" href="#157">157</a> {
-<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_comment">// return the hashcodes of the parameter that matters</em>
-<a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span> + version.hashCode();
-<a class="jxr_linenumber" name="160" href="#160">160</a> }
-<a class="jxr_linenumber" name="161" href="#161">161</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">catch</strong> ( InvalidVersionSpecificationException e )
+<a class="jxr_linenumber" name="110" href="#110">110</a> {
+<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> EnforcerRuleException( <span class="jxr_string">"The requested "</span> + variableName + <span class="jxr_string">" version "</span>
+<a class="jxr_linenumber" name="112" href="#112">112</a> + requiredVersionRange + <span class="jxr_string">" is invalid."</span>, e );
+<a class="jxr_linenumber" name="113" href="#113">113</a> }
+<a class="jxr_linenumber" name="114" href="#114">114</a> }
+<a class="jxr_linenumber" name="115" href="#115">115</a> }
+<a class="jxr_linenumber" name="116" href="#116">116</a> }
+<a class="jxr_linenumber" name="117" href="#117">117</a>
+<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. Currently the default</em>
+<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * containsVersion method assumes a singular version means allow everything. This method assumes that "2.0.4" ==</em>
+<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * "[2.0.4,)"</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @param allowedRange range of allowed versions.</em>
+<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @param theVersion the version to be checked.</em>
+<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @return true if the version is contained by the range.</em>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="127" href="#127">127</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> containsVersion( VersionRange allowedRange, ArtifactVersion theVersion )
+<a class="jxr_linenumber" name="128" href="#128">128</a> {
+<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">boolean</strong> matched = false;
+<a class="jxr_linenumber" name="130" href="#130">130</a> ArtifactVersion recommendedVersion = allowedRange.getRecommendedVersion();
+<a class="jxr_linenumber" name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> ( recommendedVersion == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="132" href="#132">132</a> {
+<a class="jxr_linenumber" name="133" href="#133">133</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="134" href="#134">134</a> List<Restriction> restrictions = allowedRange.getRestrictions();
+<a class="jxr_linenumber" name="135" href="#135">135</a> <strong class="jxr_keyword">for</strong> ( Restriction restriction : restrictions )
+<a class="jxr_linenumber" name="136" href="#136">136</a> {
+<a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> ( restriction.containsVersion( theVersion ) )
+<a class="jxr_linenumber" name="138" href="#138">138</a> {
+<a class="jxr_linenumber" name="139" href="#139">139</a> matched = <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="140" href="#140">140</a> <strong class="jxr_keyword">break</strong>;
+<a class="jxr_linenumber" name="141" href="#141">141</a> }
+<a class="jxr_linenumber" name="142" href="#142">142</a> }
+<a class="jxr_linenumber" name="143" href="#143">143</a> }
+<a class="jxr_linenumber" name="144" href="#144">144</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="145" href="#145">145</a> {
+<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_comment">// only singular versions ever have a recommendedVersion</em>
+<a class="jxr_linenumber" name="147" href="#147">147</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="148" href="#148">148</a> <strong class="jxr_keyword">int</strong> compareTo = recommendedVersion.compareTo( theVersion );
+<a class="jxr_linenumber" name="149" href="#149">149</a> matched = ( compareTo <= 0 );
+<a class="jxr_linenumber" name="150" href="#150">150</a> }
+<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">return</strong> matched;
+<a class="jxr_linenumber" name="152" href="#152">152</a> }
+<a class="jxr_linenumber" name="153" href="#153">153</a>
+<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_comment"> * (non-Javadoc)</em>
+<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#getCacheId()</em>
+<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">public</strong> String getCacheId()
+<a class="jxr_linenumber" name="160" href="#160">160</a> {
+<a class="jxr_linenumber" name="161" href="#161">161</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( version ) )
<a class="jxr_linenumber" name="162" href="#162">162</a> {
-<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"0"</span>;
-<a class="jxr_linenumber" name="164" href="#164">164</a> }
-<a class="jxr_linenumber" name="165" href="#165">165</a>
-<a class="jxr_linenumber" name="166" href="#166">166</a> }
-<a class="jxr_linenumber" name="167" href="#167">167</a>
-<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_comment">/*</em>
-<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_comment"> * (non-Javadoc)</em>
-<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_comment"> *</em>
-<a class="jxr_linenumber" name="171" href="#171">171</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isCacheable()</em>
-<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_comment"> */</em>
-<a class="jxr_linenumber" name="173" href="#173">173</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCacheable()
-<a class="jxr_linenumber" name="174" href="#174">174</a> {
-<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_comment">// the maven version is not going to change between projects in the same build.</em>
-<a class="jxr_linenumber" name="176" href="#176">176</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="177" href="#177">177</a> }
-<a class="jxr_linenumber" name="178" href="#178">178</a>
-<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_comment">/*</em>
-<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_comment"> * (non-Javadoc)</em>
-<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_comment"> *</em>
-<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule)</em>
-<a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_comment"> */</em>
-<a class="jxr_linenumber" name="184" href="#184">184</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isResultValid( EnforcerRule theCachedRule )
-<a class="jxr_linenumber" name="185" href="#185">185</a> {
-<a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_comment">// i will always return the hash of the parameters as my id. If my parameters are the same, this</em>
-<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_comment">// rule must always have the same result.</em>
-<a class="jxr_linenumber" name="188" href="#188">188</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="189" href="#189">189</a> }
-<a class="jxr_linenumber" name="190" href="#190">190</a>
-<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * Gets the required version.</em>
-<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @return the required version</em>
-<a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="196" href="#196">196</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> String getVersion()
-<a class="jxr_linenumber" name="197" href="#197">197</a> {
-<a class="jxr_linenumber" name="198" href="#198">198</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.version;
-<a class="jxr_linenumber" name="199" href="#199">199</a> }
-<a class="jxr_linenumber" name="200" href="#200">200</a>
-<a class="jxr_linenumber" name="201" href="#201">201</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * Sets the required version.</em>
-<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * @param theVersion the required version to set</em>
-<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="206" href="#206">206</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setVersion( String theVersion )
-<a class="jxr_linenumber" name="207" href="#207">207</a> {
-<a class="jxr_linenumber" name="208" href="#208">208</a> <strong class="jxr_keyword">this</strong>.version = theVersion;
-<a class="jxr_linenumber" name="209" href="#209">209</a> }
-<a class="jxr_linenumber" name="210" href="#210">210</a>
-<a class="jxr_linenumber" name="211" href="#211">211</a> }
+<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_comment">// return the hashcodes of the parameter that matters</em>
+<a class="jxr_linenumber" name="164" href="#164">164</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span> + version.hashCode();
+<a class="jxr_linenumber" name="165" href="#165">165</a> }
+<a class="jxr_linenumber" name="166" href="#166">166</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="167" href="#167">167</a> {
+<a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"0"</span>;
+<a class="jxr_linenumber" name="169" href="#169">169</a> }
+<a class="jxr_linenumber" name="170" href="#170">170</a>
+<a class="jxr_linenumber" name="171" href="#171">171</a> }
+<a class="jxr_linenumber" name="172" href="#172">172</a>
+<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_comment"> * (non-Javadoc)</em>
+<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isCacheable()</em>
+<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="178" href="#178">178</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCacheable()
+<a class="jxr_linenumber" name="179" href="#179">179</a> {
+<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_comment">// the maven version is not going to change between projects in the same build.</em>
+<a class="jxr_linenumber" name="181" href="#181">181</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="182" href="#182">182</a> }
+<a class="jxr_linenumber" name="183" href="#183">183</a>
+<a class="jxr_linenumber" name="184" href="#184">184</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="185" href="#185">185</a> <em class="jxr_comment"> * (non-Javadoc)</em>
+<a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule)</em>
+<a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="189" href="#189">189</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isResultValid( EnforcerRule theCachedRule )
+<a class="jxr_linenumber" name="190" href="#190">190</a> {
+<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_comment">// i will always return the hash of the parameters as my id. If my parameters are the same, this</em>
+<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_comment">// rule must always have the same result.</em>
+<a class="jxr_linenumber" name="193" href="#193">193</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="194" href="#194">194</a> }
+<a class="jxr_linenumber" name="195" href="#195">195</a>
+<a class="jxr_linenumber" name="196" href="#196">196</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * Gets the required version.</em>
+<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * @return the required version</em>
+<a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="201" href="#201">201</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> String getVersion()
+<a class="jxr_linenumber" name="202" href="#202">202</a> {
+<a class="jxr_linenumber" name="203" href="#203">203</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.version;
+<a class="jxr_linenumber" name="204" href="#204">204</a> }
+<a class="jxr_linenumber" name="205" href="#205">205</a>
+<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * Sets the required version.</em>
+<a class="jxr_linenumber" name="208" href="#208">208</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * @param theVersion the required version to set</em>
+<a class="jxr_linenumber" name="210" href="#210">210</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="211" href="#211">211</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setVersion( String theVersion )
+<a class="jxr_linenumber" name="212" href="#212">212</a> {
+<a class="jxr_linenumber" name="213" href="#213">213</a> <strong class="jxr_keyword">this</strong>.version = theVersion;
+<a class="jxr_linenumber" name="214" href="#214">214</a> }
+<a class="jxr_linenumber" name="215" href="#215">215</a>
+<a class="jxr_linenumber" name="216" href="#216">216</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>