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 [18/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/apidocs/src-html/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.html
==============================================================================
--- websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/apidocs/src-html/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.html (original)
+++ websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/apidocs/src-html/org/apache/maven/plugins/enforcer/AbstractVersionEnforcer.html Tue Jun 25 20:07:43 2013
@@ -37,7 +37,7 @@
<FONT color="green">034</FONT> * Contains the common code to compare a version against a version range.<a name="line.34"></a>
<FONT color="green">035</FONT> *<a name="line.35"></a>
<FONT color="green">036</FONT> * @author <a href="mailto:brianf@apache.org">Brian Fox</a><a name="line.36"></a>
-<FONT color="green">037</FONT> * @version $Id: AbstractVersionEnforcer.java 1493575 2013-06-16 19:23:51Z rfscholte $<a name="line.37"></a>
+<FONT color="green">037</FONT> * @version $Id: AbstractVersionEnforcer.java 1496229 2013-06-24 21:43:56Z rfscholte $<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> public abstract class AbstractVersionEnforcer<a name="line.39"></a>
<FONT color="green">040</FONT> extends AbstractStandardEnforcerRule<a name="line.40"></a>
@@ -52,166 +52,171 @@
<FONT color="green">049</FONT> * <li><code>[2.0.5,)</code> Versions 2.0.5 and higher</li><a name="line.49"></a>
<FONT color="green">050</FONT> * <li><code>(,2.0.5],[2.1.1,)</code> Versions up to 2.0.5 (included) and 2.1.1 or higher</li><a name="line.50"></a>
<FONT color="green">051</FONT> * </ul><a name="line.51"></a>
-<FONT color="green">052</FONT> */<a name="line.52"></a>
-<FONT color="green">053</FONT> private String version;<a name="line.53"></a>
-<FONT color="green">054</FONT> <a name="line.54"></a>
-<FONT color="green">055</FONT> /**<a name="line.55"></a>
-<FONT color="green">056</FONT> * Compares the specified version to see if it is allowed by the defined version range.<a name="line.56"></a>
-<FONT color="green">057</FONT> *<a name="line.57"></a>
-<FONT color="green">058</FONT> * @param log the log<a name="line.58"></a>
-<FONT color="green">059</FONT> * @param variableName name of variable to use in messages (Example: "Maven" or "Java" etc).<a name="line.59"></a>
-<FONT color="green">060</FONT> * @param requiredVersionRange range of allowed versions.<a name="line.60"></a>
-<FONT color="green">061</FONT> * @param actualVersion the version to be checked.<a name="line.61"></a>
-<FONT color="green">062</FONT> * @throws EnforcerRuleException the enforcer rule exception<a name="line.62"></a>
-<FONT color="green">063</FONT> */<a name="line.63"></a>
-<FONT color="green">064</FONT> public void enforceVersion( Log log, String variableName, String requiredVersionRange, ArtifactVersion actualVersion )<a name="line.64"></a>
-<FONT color="green">065</FONT> throws EnforcerRuleException<a name="line.65"></a>
-<FONT color="green">066</FONT> {<a name="line.66"></a>
-<FONT color="green">067</FONT> if ( StringUtils.isEmpty( requiredVersionRange ) )<a name="line.67"></a>
-<FONT color="green">068</FONT> {<a name="line.68"></a>
-<FONT color="green">069</FONT> throw new EnforcerRuleException( variableName + " version can't be empty." );<a name="line.69"></a>
-<FONT color="green">070</FONT> }<a name="line.70"></a>
-<FONT color="green">071</FONT> else<a name="line.71"></a>
-<FONT color="green">072</FONT> {<a name="line.72"></a>
-<FONT color="green">073</FONT> <a name="line.73"></a>
-<FONT color="green">074</FONT> VersionRange vr;<a name="line.74"></a>
-<FONT color="green">075</FONT> String msg = "Detected " + variableName + " Version: " + actualVersion;<a name="line.75"></a>
-<FONT color="green">076</FONT> <a name="line.76"></a>
-<FONT color="green">077</FONT> // short circuit check if the strings are exactly equal<a name="line.77"></a>
-<FONT color="green">078</FONT> if ( actualVersion.toString().equals( requiredVersionRange ) )<a name="line.78"></a>
-<FONT color="green">079</FONT> {<a name="line.79"></a>
-<FONT color="green">080</FONT> log.debug( msg + " is allowed in the range " + requiredVersionRange + "." );<a name="line.80"></a>
-<FONT color="green">081</FONT> }<a name="line.81"></a>
-<FONT color="green">082</FONT> else<a name="line.82"></a>
-<FONT color="green">083</FONT> {<a name="line.83"></a>
-<FONT color="green">084</FONT> try<a name="line.84"></a>
-<FONT color="green">085</FONT> {<a name="line.85"></a>
-<FONT color="green">086</FONT> vr = VersionRange.createFromVersionSpec( requiredVersionRange );<a name="line.86"></a>
-<FONT color="green">087</FONT> <a name="line.87"></a>
-<FONT color="green">088</FONT> if ( containsVersion( vr, actualVersion ) )<a name="line.88"></a>
-<FONT color="green">089</FONT> {<a name="line.89"></a>
-<FONT color="green">090</FONT> log.debug( msg + " is allowed in the range " + requiredVersionRange + "." );<a name="line.90"></a>
-<FONT color="green">091</FONT> }<a name="line.91"></a>
-<FONT color="green">092</FONT> else<a name="line.92"></a>
-<FONT color="green">093</FONT> {<a name="line.93"></a>
-<FONT color="green">094</FONT> String message = getMessage();<a name="line.94"></a>
-<FONT color="green">095</FONT> <a name="line.95"></a>
-<FONT color="green">096</FONT> if ( StringUtils.isEmpty( message ) )<a name="line.96"></a>
-<FONT color="green">097</FONT> {<a name="line.97"></a>
-<FONT color="green">098</FONT> message = msg + " is not in the allowed range " + vr + ".";<a name="line.98"></a>
-<FONT color="green">099</FONT> }<a name="line.99"></a>
-<FONT color="green">100</FONT> <a name="line.100"></a>
-<FONT color="green">101</FONT> throw new EnforcerRuleException( message );<a name="line.101"></a>
-<FONT color="green">102</FONT> }<a name="line.102"></a>
-<FONT color="green">103</FONT> }<a name="line.103"></a>
-<FONT color="green">104</FONT> catch ( InvalidVersionSpecificationException e )<a name="line.104"></a>
-<FONT color="green">105</FONT> {<a name="line.105"></a>
-<FONT color="green">106</FONT> throw new EnforcerRuleException( "The requested " + variableName + " version "<a name="line.106"></a>
-<FONT color="green">107</FONT> + requiredVersionRange + " is invalid.", e );<a name="line.107"></a>
+<FONT color="green">052</FONT> * <a name="line.52"></a>
+<FONT color="green">053</FONT> * @deprecated the visibility will be reduced to private with the next major version<a name="line.53"></a>
+<FONT color="green">054</FONT> * @see {@link #setVersion(String)}<a name="line.54"></a>
+<FONT color="green">055</FONT> * @see {@link #getVersion()}<a name="line.55"></a>
+<FONT color="green">056</FONT> <a name="line.56"></a>
+<FONT color="green">057</FONT> */<a name="line.57"></a>
+<FONT color="green">058</FONT> public String version = null;<a name="line.58"></a>
+<FONT color="green">059</FONT> <a name="line.59"></a>
+<FONT color="green">060</FONT> /**<a name="line.60"></a>
+<FONT color="green">061</FONT> * Compares the specified version to see if it is allowed by the defined version range.<a name="line.61"></a>
+<FONT color="green">062</FONT> *<a name="line.62"></a>
+<FONT color="green">063</FONT> * @param log the log<a name="line.63"></a>
+<FONT color="green">064</FONT> * @param variableName name of variable to use in messages (Example: "Maven" or "Java" etc).<a name="line.64"></a>
+<FONT color="green">065</FONT> * @param requiredVersionRange range of allowed versions.<a name="line.65"></a>
+<FONT color="green">066</FONT> * @param actualVersion the version to be checked.<a name="line.66"></a>
+<FONT color="green">067</FONT> * @throws EnforcerRuleException the enforcer rule exception<a name="line.67"></a>
+<FONT color="green">068</FONT> */<a name="line.68"></a>
+<FONT color="green">069</FONT> public void enforceVersion( Log log, String variableName, String requiredVersionRange, ArtifactVersion actualVersion )<a name="line.69"></a>
+<FONT color="green">070</FONT> throws EnforcerRuleException<a name="line.70"></a>
+<FONT color="green">071</FONT> {<a name="line.71"></a>
+<FONT color="green">072</FONT> if ( StringUtils.isEmpty( requiredVersionRange ) )<a name="line.72"></a>
+<FONT color="green">073</FONT> {<a name="line.73"></a>
+<FONT color="green">074</FONT> throw new EnforcerRuleException( variableName + " version can't be empty." );<a name="line.74"></a>
+<FONT color="green">075</FONT> }<a name="line.75"></a>
+<FONT color="green">076</FONT> else<a name="line.76"></a>
+<FONT color="green">077</FONT> {<a name="line.77"></a>
+<FONT color="green">078</FONT> <a name="line.78"></a>
+<FONT color="green">079</FONT> VersionRange vr;<a name="line.79"></a>
+<FONT color="green">080</FONT> String msg = "Detected " + variableName + " Version: " + actualVersion;<a name="line.80"></a>
+<FONT color="green">081</FONT> <a name="line.81"></a>
+<FONT color="green">082</FONT> // short circuit check if the strings are exactly equal<a name="line.82"></a>
+<FONT color="green">083</FONT> if ( actualVersion.toString().equals( requiredVersionRange ) )<a name="line.83"></a>
+<FONT color="green">084</FONT> {<a name="line.84"></a>
+<FONT color="green">085</FONT> log.debug( msg + " is allowed in the range " + requiredVersionRange + "." );<a name="line.85"></a>
+<FONT color="green">086</FONT> }<a name="line.86"></a>
+<FONT color="green">087</FONT> else<a name="line.87"></a>
+<FONT color="green">088</FONT> {<a name="line.88"></a>
+<FONT color="green">089</FONT> try<a name="line.89"></a>
+<FONT color="green">090</FONT> {<a name="line.90"></a>
+<FONT color="green">091</FONT> vr = VersionRange.createFromVersionSpec( requiredVersionRange );<a name="line.91"></a>
+<FONT color="green">092</FONT> <a name="line.92"></a>
+<FONT color="green">093</FONT> if ( containsVersion( vr, actualVersion ) )<a name="line.93"></a>
+<FONT color="green">094</FONT> {<a name="line.94"></a>
+<FONT color="green">095</FONT> log.debug( msg + " is allowed in the range " + requiredVersionRange + "." );<a name="line.95"></a>
+<FONT color="green">096</FONT> }<a name="line.96"></a>
+<FONT color="green">097</FONT> else<a name="line.97"></a>
+<FONT color="green">098</FONT> {<a name="line.98"></a>
+<FONT color="green">099</FONT> String message = getMessage();<a name="line.99"></a>
+<FONT color="green">100</FONT> <a name="line.100"></a>
+<FONT color="green">101</FONT> if ( StringUtils.isEmpty( message ) )<a name="line.101"></a>
+<FONT color="green">102</FONT> {<a name="line.102"></a>
+<FONT color="green">103</FONT> message = msg + " is not in the allowed range " + vr + ".";<a name="line.103"></a>
+<FONT color="green">104</FONT> }<a name="line.104"></a>
+<FONT color="green">105</FONT> <a name="line.105"></a>
+<FONT color="green">106</FONT> throw new EnforcerRuleException( message );<a name="line.106"></a>
+<FONT color="green">107</FONT> }<a name="line.107"></a>
<FONT color="green">108</FONT> }<a name="line.108"></a>
-<FONT color="green">109</FONT> }<a name="line.109"></a>
-<FONT color="green">110</FONT> }<a name="line.110"></a>
-<FONT color="green">111</FONT> }<a name="line.111"></a>
-<FONT color="green">112</FONT> <a name="line.112"></a>
-<FONT color="green">113</FONT> /**<a name="line.113"></a>
-<FONT color="green">114</FONT> * Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. Currently the default<a name="line.114"></a>
-<FONT color="green">115</FONT> * containsVersion method assumes a singular version means allow everything. This method assumes that "2.0.4" ==<a name="line.115"></a>
-<FONT color="green">116</FONT> * "[2.0.4,)"<a name="line.116"></a>
-<FONT color="green">117</FONT> *<a name="line.117"></a>
-<FONT color="green">118</FONT> * @param allowedRange range of allowed versions.<a name="line.118"></a>
-<FONT color="green">119</FONT> * @param theVersion the version to be checked.<a name="line.119"></a>
-<FONT color="green">120</FONT> * @return true if the version is contained by the range.<a name="line.120"></a>
-<FONT color="green">121</FONT> */<a name="line.121"></a>
-<FONT color="green">122</FONT> public static boolean containsVersion( VersionRange allowedRange, ArtifactVersion theVersion )<a name="line.122"></a>
-<FONT color="green">123</FONT> {<a name="line.123"></a>
-<FONT color="green">124</FONT> boolean matched = false;<a name="line.124"></a>
-<FONT color="green">125</FONT> ArtifactVersion recommendedVersion = allowedRange.getRecommendedVersion();<a name="line.125"></a>
-<FONT color="green">126</FONT> if ( recommendedVersion == null )<a name="line.126"></a>
-<FONT color="green">127</FONT> {<a name="line.127"></a>
-<FONT color="green">128</FONT> @SuppressWarnings( "unchecked" )<a name="line.128"></a>
-<FONT color="green">129</FONT> List<Restriction> restrictions = allowedRange.getRestrictions();<a name="line.129"></a>
-<FONT color="green">130</FONT> for ( Restriction restriction : restrictions )<a name="line.130"></a>
-<FONT color="green">131</FONT> {<a name="line.131"></a>
-<FONT color="green">132</FONT> if ( restriction.containsVersion( theVersion ) )<a name="line.132"></a>
-<FONT color="green">133</FONT> {<a name="line.133"></a>
-<FONT color="green">134</FONT> matched = true;<a name="line.134"></a>
-<FONT color="green">135</FONT> break;<a name="line.135"></a>
-<FONT color="green">136</FONT> }<a name="line.136"></a>
-<FONT color="green">137</FONT> }<a name="line.137"></a>
-<FONT color="green">138</FONT> }<a name="line.138"></a>
-<FONT color="green">139</FONT> else<a name="line.139"></a>
-<FONT color="green">140</FONT> {<a name="line.140"></a>
-<FONT color="green">141</FONT> // only singular versions ever have a recommendedVersion<a name="line.141"></a>
-<FONT color="green">142</FONT> @SuppressWarnings( "unchecked" )<a name="line.142"></a>
-<FONT color="green">143</FONT> int compareTo = recommendedVersion.compareTo( theVersion );<a name="line.143"></a>
-<FONT color="green">144</FONT> matched = ( compareTo <= 0 );<a name="line.144"></a>
-<FONT color="green">145</FONT> }<a name="line.145"></a>
-<FONT color="green">146</FONT> return matched;<a name="line.146"></a>
-<FONT color="green">147</FONT> }<a name="line.147"></a>
-<FONT color="green">148</FONT> <a name="line.148"></a>
-<FONT color="green">149</FONT> /*<a name="line.149"></a>
-<FONT color="green">150</FONT> * (non-Javadoc)<a name="line.150"></a>
-<FONT color="green">151</FONT> *<a name="line.151"></a>
-<FONT color="green">152</FONT> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#getCacheId()<a name="line.152"></a>
-<FONT color="green">153</FONT> */<a name="line.153"></a>
-<FONT color="green">154</FONT> public String getCacheId()<a name="line.154"></a>
-<FONT color="green">155</FONT> {<a name="line.155"></a>
-<FONT color="green">156</FONT> if ( StringUtils.isNotEmpty( version ) )<a name="line.156"></a>
-<FONT color="green">157</FONT> {<a name="line.157"></a>
-<FONT color="green">158</FONT> // return the hashcodes of the parameter that matters<a name="line.158"></a>
-<FONT color="green">159</FONT> return "" + version.hashCode();<a name="line.159"></a>
-<FONT color="green">160</FONT> }<a name="line.160"></a>
-<FONT color="green">161</FONT> else<a name="line.161"></a>
+<FONT color="green">109</FONT> catch ( InvalidVersionSpecificationException e )<a name="line.109"></a>
+<FONT color="green">110</FONT> {<a name="line.110"></a>
+<FONT color="green">111</FONT> throw new EnforcerRuleException( "The requested " + variableName + " version "<a name="line.111"></a>
+<FONT color="green">112</FONT> + requiredVersionRange + " is invalid.", e );<a name="line.112"></a>
+<FONT color="green">113</FONT> }<a name="line.113"></a>
+<FONT color="green">114</FONT> }<a name="line.114"></a>
+<FONT color="green">115</FONT> }<a name="line.115"></a>
+<FONT color="green">116</FONT> }<a name="line.116"></a>
+<FONT color="green">117</FONT> <a name="line.117"></a>
+<FONT color="green">118</FONT> /**<a name="line.118"></a>
+<FONT color="green">119</FONT> * Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. Currently the default<a name="line.119"></a>
+<FONT color="green">120</FONT> * containsVersion method assumes a singular version means allow everything. This method assumes that "2.0.4" ==<a name="line.120"></a>
+<FONT color="green">121</FONT> * "[2.0.4,)"<a name="line.121"></a>
+<FONT color="green">122</FONT> *<a name="line.122"></a>
+<FONT color="green">123</FONT> * @param allowedRange range of allowed versions.<a name="line.123"></a>
+<FONT color="green">124</FONT> * @param theVersion the version to be checked.<a name="line.124"></a>
+<FONT color="green">125</FONT> * @return true if the version is contained by the range.<a name="line.125"></a>
+<FONT color="green">126</FONT> */<a name="line.126"></a>
+<FONT color="green">127</FONT> public static boolean containsVersion( VersionRange allowedRange, ArtifactVersion theVersion )<a name="line.127"></a>
+<FONT color="green">128</FONT> {<a name="line.128"></a>
+<FONT color="green">129</FONT> boolean matched = false;<a name="line.129"></a>
+<FONT color="green">130</FONT> ArtifactVersion recommendedVersion = allowedRange.getRecommendedVersion();<a name="line.130"></a>
+<FONT color="green">131</FONT> if ( recommendedVersion == null )<a name="line.131"></a>
+<FONT color="green">132</FONT> {<a name="line.132"></a>
+<FONT color="green">133</FONT> @SuppressWarnings( "unchecked" )<a name="line.133"></a>
+<FONT color="green">134</FONT> List<Restriction> restrictions = allowedRange.getRestrictions();<a name="line.134"></a>
+<FONT color="green">135</FONT> for ( Restriction restriction : restrictions )<a name="line.135"></a>
+<FONT color="green">136</FONT> {<a name="line.136"></a>
+<FONT color="green">137</FONT> if ( restriction.containsVersion( theVersion ) )<a name="line.137"></a>
+<FONT color="green">138</FONT> {<a name="line.138"></a>
+<FONT color="green">139</FONT> matched = true;<a name="line.139"></a>
+<FONT color="green">140</FONT> break;<a name="line.140"></a>
+<FONT color="green">141</FONT> }<a name="line.141"></a>
+<FONT color="green">142</FONT> }<a name="line.142"></a>
+<FONT color="green">143</FONT> }<a name="line.143"></a>
+<FONT color="green">144</FONT> else<a name="line.144"></a>
+<FONT color="green">145</FONT> {<a name="line.145"></a>
+<FONT color="green">146</FONT> // only singular versions ever have a recommendedVersion<a name="line.146"></a>
+<FONT color="green">147</FONT> @SuppressWarnings( "unchecked" )<a name="line.147"></a>
+<FONT color="green">148</FONT> int compareTo = recommendedVersion.compareTo( theVersion );<a name="line.148"></a>
+<FONT color="green">149</FONT> matched = ( compareTo <= 0 );<a name="line.149"></a>
+<FONT color="green">150</FONT> }<a name="line.150"></a>
+<FONT color="green">151</FONT> return matched;<a name="line.151"></a>
+<FONT color="green">152</FONT> }<a name="line.152"></a>
+<FONT color="green">153</FONT> <a name="line.153"></a>
+<FONT color="green">154</FONT> /*<a name="line.154"></a>
+<FONT color="green">155</FONT> * (non-Javadoc)<a name="line.155"></a>
+<FONT color="green">156</FONT> *<a name="line.156"></a>
+<FONT color="green">157</FONT> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#getCacheId()<a name="line.157"></a>
+<FONT color="green">158</FONT> */<a name="line.158"></a>
+<FONT color="green">159</FONT> public String getCacheId()<a name="line.159"></a>
+<FONT color="green">160</FONT> {<a name="line.160"></a>
+<FONT color="green">161</FONT> if ( StringUtils.isNotEmpty( version ) )<a name="line.161"></a>
<FONT color="green">162</FONT> {<a name="line.162"></a>
-<FONT color="green">163</FONT> return "0";<a name="line.163"></a>
-<FONT color="green">164</FONT> }<a name="line.164"></a>
-<FONT color="green">165</FONT> <a name="line.165"></a>
-<FONT color="green">166</FONT> }<a name="line.166"></a>
-<FONT color="green">167</FONT> <a name="line.167"></a>
-<FONT color="green">168</FONT> /*<a name="line.168"></a>
-<FONT color="green">169</FONT> * (non-Javadoc)<a name="line.169"></a>
-<FONT color="green">170</FONT> *<a name="line.170"></a>
-<FONT color="green">171</FONT> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isCacheable()<a name="line.171"></a>
-<FONT color="green">172</FONT> */<a name="line.172"></a>
-<FONT color="green">173</FONT> public boolean isCacheable()<a name="line.173"></a>
-<FONT color="green">174</FONT> {<a name="line.174"></a>
-<FONT color="green">175</FONT> // the maven version is not going to change between projects in the same build.<a name="line.175"></a>
-<FONT color="green">176</FONT> return true;<a name="line.176"></a>
-<FONT color="green">177</FONT> }<a name="line.177"></a>
-<FONT color="green">178</FONT> <a name="line.178"></a>
-<FONT color="green">179</FONT> /*<a name="line.179"></a>
-<FONT color="green">180</FONT> * (non-Javadoc)<a name="line.180"></a>
-<FONT color="green">181</FONT> *<a name="line.181"></a>
-<FONT color="green">182</FONT> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule)<a name="line.182"></a>
-<FONT color="green">183</FONT> */<a name="line.183"></a>
-<FONT color="green">184</FONT> public boolean isResultValid( EnforcerRule theCachedRule )<a name="line.184"></a>
-<FONT color="green">185</FONT> {<a name="line.185"></a>
-<FONT color="green">186</FONT> // i will always return the hash of the parameters as my id. If my parameters are the same, this<a name="line.186"></a>
-<FONT color="green">187</FONT> // rule must always have the same result.<a name="line.187"></a>
-<FONT color="green">188</FONT> return true;<a name="line.188"></a>
-<FONT color="green">189</FONT> }<a name="line.189"></a>
-<FONT color="green">190</FONT> <a name="line.190"></a>
-<FONT color="green">191</FONT> /**<a name="line.191"></a>
-<FONT color="green">192</FONT> * Gets the required version.<a name="line.192"></a>
-<FONT color="green">193</FONT> *<a name="line.193"></a>
-<FONT color="green">194</FONT> * @return the required version<a name="line.194"></a>
-<FONT color="green">195</FONT> */<a name="line.195"></a>
-<FONT color="green">196</FONT> public final String getVersion()<a name="line.196"></a>
-<FONT color="green">197</FONT> {<a name="line.197"></a>
-<FONT color="green">198</FONT> return this.version;<a name="line.198"></a>
-<FONT color="green">199</FONT> }<a name="line.199"></a>
-<FONT color="green">200</FONT> <a name="line.200"></a>
-<FONT color="green">201</FONT> /**<a name="line.201"></a>
-<FONT color="green">202</FONT> * Sets the required version.<a name="line.202"></a>
-<FONT color="green">203</FONT> *<a name="line.203"></a>
-<FONT color="green">204</FONT> * @param theVersion the required version to set<a name="line.204"></a>
-<FONT color="green">205</FONT> */<a name="line.205"></a>
-<FONT color="green">206</FONT> public final void setVersion( String theVersion )<a name="line.206"></a>
-<FONT color="green">207</FONT> {<a name="line.207"></a>
-<FONT color="green">208</FONT> this.version = theVersion;<a name="line.208"></a>
-<FONT color="green">209</FONT> }<a name="line.209"></a>
-<FONT color="green">210</FONT> <a name="line.210"></a>
-<FONT color="green">211</FONT> }<a name="line.211"></a>
+<FONT color="green">163</FONT> // return the hashcodes of the parameter that matters<a name="line.163"></a>
+<FONT color="green">164</FONT> return "" + version.hashCode();<a name="line.164"></a>
+<FONT color="green">165</FONT> }<a name="line.165"></a>
+<FONT color="green">166</FONT> else<a name="line.166"></a>
+<FONT color="green">167</FONT> {<a name="line.167"></a>
+<FONT color="green">168</FONT> return "0";<a name="line.168"></a>
+<FONT color="green">169</FONT> }<a name="line.169"></a>
+<FONT color="green">170</FONT> <a name="line.170"></a>
+<FONT color="green">171</FONT> }<a name="line.171"></a>
+<FONT color="green">172</FONT> <a name="line.172"></a>
+<FONT color="green">173</FONT> /*<a name="line.173"></a>
+<FONT color="green">174</FONT> * (non-Javadoc)<a name="line.174"></a>
+<FONT color="green">175</FONT> *<a name="line.175"></a>
+<FONT color="green">176</FONT> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isCacheable()<a name="line.176"></a>
+<FONT color="green">177</FONT> */<a name="line.177"></a>
+<FONT color="green">178</FONT> public boolean isCacheable()<a name="line.178"></a>
+<FONT color="green">179</FONT> {<a name="line.179"></a>
+<FONT color="green">180</FONT> // the maven version is not going to change between projects in the same build.<a name="line.180"></a>
+<FONT color="green">181</FONT> return true;<a name="line.181"></a>
+<FONT color="green">182</FONT> }<a name="line.182"></a>
+<FONT color="green">183</FONT> <a name="line.183"></a>
+<FONT color="green">184</FONT> /*<a name="line.184"></a>
+<FONT color="green">185</FONT> * (non-Javadoc)<a name="line.185"></a>
+<FONT color="green">186</FONT> *<a name="line.186"></a>
+<FONT color="green">187</FONT> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule)<a name="line.187"></a>
+<FONT color="green">188</FONT> */<a name="line.188"></a>
+<FONT color="green">189</FONT> public boolean isResultValid( EnforcerRule theCachedRule )<a name="line.189"></a>
+<FONT color="green">190</FONT> {<a name="line.190"></a>
+<FONT color="green">191</FONT> // i will always return the hash of the parameters as my id. If my parameters are the same, this<a name="line.191"></a>
+<FONT color="green">192</FONT> // rule must always have the same result.<a name="line.192"></a>
+<FONT color="green">193</FONT> return true;<a name="line.193"></a>
+<FONT color="green">194</FONT> }<a name="line.194"></a>
+<FONT color="green">195</FONT> <a name="line.195"></a>
+<FONT color="green">196</FONT> /**<a name="line.196"></a>
+<FONT color="green">197</FONT> * Gets the required version.<a name="line.197"></a>
+<FONT color="green">198</FONT> *<a name="line.198"></a>
+<FONT color="green">199</FONT> * @return the required version<a name="line.199"></a>
+<FONT color="green">200</FONT> */<a name="line.200"></a>
+<FONT color="green">201</FONT> public final String getVersion()<a name="line.201"></a>
+<FONT color="green">202</FONT> {<a name="line.202"></a>
+<FONT color="green">203</FONT> return this.version;<a name="line.203"></a>
+<FONT color="green">204</FONT> }<a name="line.204"></a>
+<FONT color="green">205</FONT> <a name="line.205"></a>
+<FONT color="green">206</FONT> /**<a name="line.206"></a>
+<FONT color="green">207</FONT> * Sets the required version.<a name="line.207"></a>
+<FONT color="green">208</FONT> *<a name="line.208"></a>
+<FONT color="green">209</FONT> * @param theVersion the required version to set<a name="line.209"></a>
+<FONT color="green">210</FONT> */<a name="line.210"></a>
+<FONT color="green">211</FONT> public final void setVersion( String theVersion )<a name="line.211"></a>
+<FONT color="green">212</FONT> {<a name="line.212"></a>
+<FONT color="green">213</FONT> this.version = theVersion;<a name="line.213"></a>
+<FONT color="green">214</FONT> }<a name="line.214"></a>
+<FONT color="green">215</FONT> <a name="line.215"></a>
+<FONT color="green">216</FONT> }<a name="line.216"></a>
Modified: websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/apidocs/src-html/org/apache/maven/plugins/enforcer/BannedDependencies.html
==============================================================================
--- websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/apidocs/src-html/org/apache/maven/plugins/enforcer/BannedDependencies.html (original)
+++ websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/apidocs/src-html/org/apache/maven/plugins/enforcer/BannedDependencies.html Tue Jun 25 20:07:43 2013
@@ -38,7 +38,7 @@
<FONT color="green">035</FONT> * This rule checks that lists of dependencies are not included.<a name="line.35"></a>
<FONT color="green">036</FONT> *<a name="line.36"></a>
<FONT color="green">037</FONT> * @author <a href="mailto:brianf@apache.org">Brian Fox</a><a name="line.37"></a>
-<FONT color="green">038</FONT> * @version $Id: BannedDependencies.java 1493575 2013-06-16 19:23:51Z rfscholte $<a name="line.38"></a>
+<FONT color="green">038</FONT> * @version $Id: BannedDependencies.java 1496229 2013-06-24 21:43:56Z rfscholte $<a name="line.38"></a>
<FONT color="green">039</FONT> */<a name="line.39"></a>
<FONT color="green">040</FONT> public class BannedDependencies<a name="line.40"></a>
<FONT color="green">041</FONT> extends AbstractBanDependencies<a name="line.41"></a>
@@ -48,190 +48,198 @@
<FONT color="green">045</FONT> * Specify the banned dependencies. This can be a list of artifacts in the format <code>groupId[:artifactId][:version]</code>.<a name="line.45"></a>
<FONT color="green">046</FONT> * Any of the sections can be a wildcard by using '*' (ie group:*:1.0) <br><a name="line.46"></a>
<FONT color="green">047</FONT> * The rule will fail if any dependency matches any exclude, unless it also matches an include rule.<a name="line.47"></a>
-<FONT color="green">048</FONT> */<a name="line.48"></a>
-<FONT color="green">049</FONT> private List<String> excludes = null;<a name="line.49"></a>
-<FONT color="green">050</FONT> <a name="line.50"></a>
-<FONT color="green">051</FONT> /**<a name="line.51"></a>
-<FONT color="green">052</FONT> * Specify the allowed dependencies. This can be a list of artifacts in the format <code>groupId[:artifactId][:version]</code>.<a name="line.52"></a>
-<FONT color="green">053</FONT> * Any of the sections can be a wildcard by using '*' (ie group:*:1.0) <br><a name="line.53"></a>
-<FONT color="green">054</FONT> * Includes override the exclude rules. It is meant to allow wide exclusion rules with wildcards and still allow a<a name="line.54"></a>
-<FONT color="green">055</FONT> * smaller set of includes. <br><a name="line.55"></a>
-<FONT color="green">056</FONT> * For example, to ban all xerces except xerces-api -> exclude "xerces", include "xerces:xerces-api"<a name="line.56"></a>
-<FONT color="green">057</FONT> */<a name="line.57"></a>
-<FONT color="green">058</FONT> private List<String> includes = null;<a name="line.58"></a>
-<FONT color="green">059</FONT> <a name="line.59"></a>
-<FONT color="green">060</FONT> <a name="line.60"></a>
-<FONT color="green">061</FONT> /**<a name="line.61"></a>
-<FONT color="green">062</FONT> * {@inheritDoc}<a name="line.62"></a>
-<FONT color="green">063</FONT> */<a name="line.63"></a>
-<FONT color="green">064</FONT> protected Set<Artifact> checkDependencies( Set<Artifact> theDependencies, Log log )<a name="line.64"></a>
-<FONT color="green">065</FONT> throws EnforcerRuleException<a name="line.65"></a>
-<FONT color="green">066</FONT> {<a name="line.66"></a>
-<FONT color="green">067</FONT> Set<Artifact> excluded = checkDependencies( theDependencies, excludes );<a name="line.67"></a>
+<FONT color="green">048</FONT> * <a name="line.48"></a>
+<FONT color="green">049</FONT> * @deprecated the visibility will be reduced to private with the next major version<a name="line.49"></a>
+<FONT color="green">050</FONT> * @see {@link #setExcludes(List)}<a name="line.50"></a>
+<FONT color="green">051</FONT> * @see {@link #getExcludes()}<a name="line.51"></a>
+<FONT color="green">052</FONT> */<a name="line.52"></a>
+<FONT color="green">053</FONT> public List<String> excludes = null;<a name="line.53"></a>
+<FONT color="green">054</FONT> <a name="line.54"></a>
+<FONT color="green">055</FONT> /**<a name="line.55"></a>
+<FONT color="green">056</FONT> * Specify the allowed dependencies. This can be a list of artifacts in the format <code>groupId[:artifactId][:version]</code>.<a name="line.56"></a>
+<FONT color="green">057</FONT> * Any of the sections can be a wildcard by using '*' (ie group:*:1.0) <br><a name="line.57"></a>
+<FONT color="green">058</FONT> * Includes override the exclude rules. It is meant to allow wide exclusion rules with wildcards and still allow a<a name="line.58"></a>
+<FONT color="green">059</FONT> * smaller set of includes. <br><a name="line.59"></a>
+<FONT color="green">060</FONT> * For example, to ban all xerces except xerces-api -> exclude "xerces", include "xerces:xerces-api"<a name="line.60"></a>
+<FONT color="green">061</FONT> * <a name="line.61"></a>
+<FONT color="green">062</FONT> * @deprecated the visibility will be reduced to private with the next major version<a name="line.62"></a>
+<FONT color="green">063</FONT> * @see {@link #setIncludes(List)}<a name="line.63"></a>
+<FONT color="green">064</FONT> * @see {@link #getIncludes()}<a name="line.64"></a>
+<FONT color="green">065</FONT> */<a name="line.65"></a>
+<FONT color="green">066</FONT> public List<String> includes = null;<a name="line.66"></a>
+<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
-<FONT color="green">069</FONT> // anything specifically included should be removed<a name="line.69"></a>
-<FONT color="green">070</FONT> // from the ban list.<a name="line.70"></a>
-<FONT color="green">071</FONT> if ( excluded != null )<a name="line.71"></a>
-<FONT color="green">072</FONT> {<a name="line.72"></a>
-<FONT color="green">073</FONT> Set<Artifact> included = checkDependencies( theDependencies, includes );<a name="line.73"></a>
-<FONT color="green">074</FONT> if ( included != null )<a name="line.74"></a>
-<FONT color="green">075</FONT> {<a name="line.75"></a>
-<FONT color="green">076</FONT> excluded.removeAll( included );<a name="line.76"></a>
-<FONT color="green">077</FONT> }<a name="line.77"></a>
-<FONT color="green">078</FONT> }<a name="line.78"></a>
-<FONT color="green">079</FONT> return excluded;<a name="line.79"></a>
-<FONT color="green">080</FONT> <a name="line.80"></a>
-<FONT color="green">081</FONT> }<a name="line.81"></a>
-<FONT color="green">082</FONT> <a name="line.82"></a>
-<FONT color="green">083</FONT> /**<a name="line.83"></a>
-<FONT color="green">084</FONT> * Checks the set of dependencies against the list of patterns.<a name="line.84"></a>
-<FONT color="green">085</FONT> *<a name="line.85"></a>
-<FONT color="green">086</FONT> * @param thePatterns the patterns<a name="line.86"></a>
-<FONT color="green">087</FONT> * @param dependencies the dependencies<a name="line.87"></a>
-<FONT color="green">088</FONT> * @return a set containing artifacts matching one of the patterns or <code>null</code><a name="line.88"></a>
-<FONT color="green">089</FONT> * @throws EnforcerRuleException the enforcer rule exception<a name="line.89"></a>
-<FONT color="green">090</FONT> */<a name="line.90"></a>
-<FONT color="green">091</FONT> private Set<Artifact> checkDependencies( Set<Artifact> dependencies, List<String> thePatterns )<a name="line.91"></a>
-<FONT color="green">092</FONT> throws EnforcerRuleException<a name="line.92"></a>
-<FONT color="green">093</FONT> {<a name="line.93"></a>
-<FONT color="green">094</FONT> Set<Artifact> foundMatches = null;<a name="line.94"></a>
-<FONT color="green">095</FONT> <a name="line.95"></a>
-<FONT color="green">096</FONT> if ( thePatterns != null && thePatterns.size() > 0 )<a name="line.96"></a>
-<FONT color="green">097</FONT> {<a name="line.97"></a>
-<FONT color="green">098</FONT> <a name="line.98"></a>
-<FONT color="green">099</FONT> for ( String pattern : thePatterns )<a name="line.99"></a>
-<FONT color="green">100</FONT> {<a name="line.100"></a>
-<FONT color="green">101</FONT> <a name="line.101"></a>
-<FONT color="green">102</FONT> String[] subStrings = pattern.split( ":" );<a name="line.102"></a>
-<FONT color="green">103</FONT> subStrings = StringUtils.stripAll( subStrings );<a name="line.103"></a>
-<FONT color="green">104</FONT> <a name="line.104"></a>
-<FONT color="green">105</FONT> for ( Artifact artifact : dependencies )<a name="line.105"></a>
-<FONT color="green">106</FONT> {<a name="line.106"></a>
-<FONT color="green">107</FONT> if ( compareDependency( subStrings, artifact ) )<a name="line.107"></a>
-<FONT color="green">108</FONT> {<a name="line.108"></a>
-<FONT color="green">109</FONT> // only create if needed<a name="line.109"></a>
-<FONT color="green">110</FONT> if ( foundMatches == null )<a name="line.110"></a>
-<FONT color="green">111</FONT> {<a name="line.111"></a>
-<FONT color="green">112</FONT> foundMatches = new HashSet<Artifact>();<a name="line.112"></a>
-<FONT color="green">113</FONT> }<a name="line.113"></a>
-<FONT color="green">114</FONT> foundMatches.add( artifact );<a name="line.114"></a>
-<FONT color="green">115</FONT> }<a name="line.115"></a>
-<FONT color="green">116</FONT> }<a name="line.116"></a>
-<FONT color="green">117</FONT> }<a name="line.117"></a>
-<FONT color="green">118</FONT> }<a name="line.118"></a>
-<FONT color="green">119</FONT> return foundMatches;<a name="line.119"></a>
-<FONT color="green">120</FONT> }<a name="line.120"></a>
-<FONT color="green">121</FONT> <a name="line.121"></a>
-<FONT color="green">122</FONT> /**<a name="line.122"></a>
-<FONT color="green">123</FONT> * Compares the parsed array of substrings against the artifact.<a name="line.123"></a>
-<FONT color="green">124</FONT> * The pattern should follow the format "groupId:artifactId:version:type:scope"<a name="line.124"></a>
-<FONT color="green">125</FONT> *<a name="line.125"></a>
-<FONT color="green">126</FONT> * @param pattern the array of patterns<a name="line.126"></a>
-<FONT color="green">127</FONT> * @param artifact the artifact<a name="line.127"></a>
-<FONT color="green">128</FONT> * @return <code>true</code> if the artifact matches one of the patterns<a name="line.128"></a>
-<FONT color="green">129</FONT> * @throws EnforcerRuleException the enforcer rule exception<a name="line.129"></a>
-<FONT color="green">130</FONT> */<a name="line.130"></a>
-<FONT color="green">131</FONT> protected boolean compareDependency( String[] pattern, Artifact artifact )<a name="line.131"></a>
-<FONT color="green">132</FONT> throws EnforcerRuleException<a name="line.132"></a>
-<FONT color="green">133</FONT> {<a name="line.133"></a>
-<FONT color="green">134</FONT> <a name="line.134"></a>
-<FONT color="green">135</FONT> boolean result = false;<a name="line.135"></a>
-<FONT color="green">136</FONT> if ( pattern.length > 0 )<a name="line.136"></a>
-<FONT color="green">137</FONT> {<a name="line.137"></a>
-<FONT color="green">138</FONT> result = pattern[0].equals( "*" ) || artifact.getGroupId().equals( pattern[0] );<a name="line.138"></a>
-<FONT color="green">139</FONT> }<a name="line.139"></a>
-<FONT color="green">140</FONT> <a name="line.140"></a>
-<FONT color="green">141</FONT> if ( result && pattern.length > 1 )<a name="line.141"></a>
-<FONT color="green">142</FONT> {<a name="line.142"></a>
-<FONT color="green">143</FONT> result = pattern[1].equals( "*" ) || artifact.getArtifactId().equals( pattern[1] );<a name="line.143"></a>
-<FONT color="green">144</FONT> }<a name="line.144"></a>
-<FONT color="green">145</FONT> <a name="line.145"></a>
-<FONT color="green">146</FONT> if ( result && pattern.length > 2 )<a name="line.146"></a>
-<FONT color="green">147</FONT> {<a name="line.147"></a>
-<FONT color="green">148</FONT> // short circuit if the versions are exactly the same<a name="line.148"></a>
-<FONT color="green">149</FONT> if ( pattern[2].equals( "*" ) || artifact.getVersion().equals( pattern[2] ) )<a name="line.149"></a>
-<FONT color="green">150</FONT> {<a name="line.150"></a>
-<FONT color="green">151</FONT> result = true;<a name="line.151"></a>
-<FONT color="green">152</FONT> }<a name="line.152"></a>
-<FONT color="green">153</FONT> else<a name="line.153"></a>
-<FONT color="green">154</FONT> {<a name="line.154"></a>
-<FONT color="green">155</FONT> try<a name="line.155"></a>
-<FONT color="green">156</FONT> {<a name="line.156"></a>
-<FONT color="green">157</FONT> result =<a name="line.157"></a>
-<FONT color="green">158</FONT> AbstractVersionEnforcer.containsVersion( VersionRange.createFromVersionSpec( pattern[2] ),<a name="line.158"></a>
-<FONT color="green">159</FONT> new DefaultArtifactVersion( artifact.getBaseVersion() ) );<a name="line.159"></a>
-<FONT color="green">160</FONT> }<a name="line.160"></a>
-<FONT color="green">161</FONT> catch ( InvalidVersionSpecificationException e )<a name="line.161"></a>
-<FONT color="green">162</FONT> {<a name="line.162"></a>
-<FONT color="green">163</FONT> throw new EnforcerRuleException( "Invalid Version Range: ", e );<a name="line.163"></a>
-<FONT color="green">164</FONT> }<a name="line.164"></a>
-<FONT color="green">165</FONT> }<a name="line.165"></a>
-<FONT color="green">166</FONT> }<a name="line.166"></a>
-<FONT color="green">167</FONT> <a name="line.167"></a>
-<FONT color="green">168</FONT> if ( result && pattern.length > 3 )<a name="line.168"></a>
-<FONT color="green">169</FONT> {<a name="line.169"></a>
-<FONT color="green">170</FONT> String type = artifact.getType();<a name="line.170"></a>
-<FONT color="green">171</FONT> if ( type == null || type.equals( "" ) )<a name="line.171"></a>
-<FONT color="green">172</FONT> {<a name="line.172"></a>
-<FONT color="green">173</FONT> type = "jar";<a name="line.173"></a>
-<FONT color="green">174</FONT> }<a name="line.174"></a>
-<FONT color="green">175</FONT> result = pattern[3].equals( "*" ) || type.equals( pattern[3] );<a name="line.175"></a>
-<FONT color="green">176</FONT> }<a name="line.176"></a>
-<FONT color="green">177</FONT> <a name="line.177"></a>
-<FONT color="green">178</FONT> if ( result && pattern.length > 4 )<a name="line.178"></a>
-<FONT color="green">179</FONT> {<a name="line.179"></a>
-<FONT color="green">180</FONT> String scope = artifact.getScope();<a name="line.180"></a>
-<FONT color="green">181</FONT> if ( scope == null || scope.equals( "" ) )<a name="line.181"></a>
-<FONT color="green">182</FONT> {<a name="line.182"></a>
-<FONT color="green">183</FONT> scope = "compile";<a name="line.183"></a>
-<FONT color="green">184</FONT> }<a name="line.184"></a>
-<FONT color="green">185</FONT> result = pattern[4].equals( "*" ) || scope.equals( pattern[4] );<a name="line.185"></a>
-<FONT color="green">186</FONT> }<a name="line.186"></a>
-<FONT color="green">187</FONT> <a name="line.187"></a>
-<FONT color="green">188</FONT> return result;<a name="line.188"></a>
-<FONT color="green">189</FONT> }<a name="line.189"></a>
-<FONT color="green">190</FONT> <a name="line.190"></a>
-<FONT color="green">191</FONT> /**<a name="line.191"></a>
-<FONT color="green">192</FONT> * Gets the excludes.<a name="line.192"></a>
-<FONT color="green">193</FONT> *<a name="line.193"></a>
-<FONT color="green">194</FONT> * @return the excludes<a name="line.194"></a>
-<FONT color="green">195</FONT> */<a name="line.195"></a>
-<FONT color="green">196</FONT> public List<String> getExcludes()<a name="line.196"></a>
-<FONT color="green">197</FONT> {<a name="line.197"></a>
-<FONT color="green">198</FONT> return this.excludes;<a name="line.198"></a>
-<FONT color="green">199</FONT> }<a name="line.199"></a>
-<FONT color="green">200</FONT> <a name="line.200"></a>
-<FONT color="green">201</FONT> /**<a name="line.201"></a>
-<FONT color="green">202</FONT> * Sets the excludes.<a name="line.202"></a>
-<FONT color="green">203</FONT> *<a name="line.203"></a>
-<FONT color="green">204</FONT> * @param theExcludes the excludes to set<a name="line.204"></a>
-<FONT color="green">205</FONT> */<a name="line.205"></a>
-<FONT color="green">206</FONT> public void setExcludes( List<String> theExcludes )<a name="line.206"></a>
-<FONT color="green">207</FONT> {<a name="line.207"></a>
-<FONT color="green">208</FONT> this.excludes = theExcludes;<a name="line.208"></a>
-<FONT color="green">209</FONT> }<a name="line.209"></a>
-<FONT color="green">210</FONT> <a name="line.210"></a>
-<FONT color="green">211</FONT> /**<a name="line.211"></a>
-<FONT color="green">212</FONT> * Gets the includes.<a name="line.212"></a>
-<FONT color="green">213</FONT> *<a name="line.213"></a>
-<FONT color="green">214</FONT> * @return the includes<a name="line.214"></a>
-<FONT color="green">215</FONT> */<a name="line.215"></a>
-<FONT color="green">216</FONT> public List<String> getIncludes()<a name="line.216"></a>
-<FONT color="green">217</FONT> {<a name="line.217"></a>
-<FONT color="green">218</FONT> return this.includes;<a name="line.218"></a>
-<FONT color="green">219</FONT> }<a name="line.219"></a>
-<FONT color="green">220</FONT> <a name="line.220"></a>
-<FONT color="green">221</FONT> /**<a name="line.221"></a>
-<FONT color="green">222</FONT> * Sets the includes.<a name="line.222"></a>
-<FONT color="green">223</FONT> *<a name="line.223"></a>
-<FONT color="green">224</FONT> * @param theIncludes the includes to set<a name="line.224"></a>
-<FONT color="green">225</FONT> */<a name="line.225"></a>
-<FONT color="green">226</FONT> public void setIncludes( List<String> theIncludes )<a name="line.226"></a>
-<FONT color="green">227</FONT> {<a name="line.227"></a>
-<FONT color="green">228</FONT> this.includes = theIncludes;<a name="line.228"></a>
-<FONT color="green">229</FONT> }<a name="line.229"></a>
-<FONT color="green">230</FONT> <a name="line.230"></a>
-<FONT color="green">231</FONT> }<a name="line.231"></a>
+<FONT color="green">069</FONT> /**<a name="line.69"></a>
+<FONT color="green">070</FONT> * {@inheritDoc}<a name="line.70"></a>
+<FONT color="green">071</FONT> */<a name="line.71"></a>
+<FONT color="green">072</FONT> protected Set<Artifact> checkDependencies( Set<Artifact> theDependencies, Log log )<a name="line.72"></a>
+<FONT color="green">073</FONT> throws EnforcerRuleException<a name="line.73"></a>
+<FONT color="green">074</FONT> {<a name="line.74"></a>
+<FONT color="green">075</FONT> Set<Artifact> excluded = checkDependencies( theDependencies, excludes );<a name="line.75"></a>
+<FONT color="green">076</FONT> <a name="line.76"></a>
+<FONT color="green">077</FONT> // anything specifically included should be removed<a name="line.77"></a>
+<FONT color="green">078</FONT> // from the ban list.<a name="line.78"></a>
+<FONT color="green">079</FONT> if ( excluded != null )<a name="line.79"></a>
+<FONT color="green">080</FONT> {<a name="line.80"></a>
+<FONT color="green">081</FONT> Set<Artifact> included = checkDependencies( theDependencies, includes );<a name="line.81"></a>
+<FONT color="green">082</FONT> if ( included != null )<a name="line.82"></a>
+<FONT color="green">083</FONT> {<a name="line.83"></a>
+<FONT color="green">084</FONT> excluded.removeAll( included );<a name="line.84"></a>
+<FONT color="green">085</FONT> }<a name="line.85"></a>
+<FONT color="green">086</FONT> }<a name="line.86"></a>
+<FONT color="green">087</FONT> return excluded;<a name="line.87"></a>
+<FONT color="green">088</FONT> <a name="line.88"></a>
+<FONT color="green">089</FONT> }<a name="line.89"></a>
+<FONT color="green">090</FONT> <a name="line.90"></a>
+<FONT color="green">091</FONT> /**<a name="line.91"></a>
+<FONT color="green">092</FONT> * Checks the set of dependencies against the list of patterns.<a name="line.92"></a>
+<FONT color="green">093</FONT> *<a name="line.93"></a>
+<FONT color="green">094</FONT> * @param thePatterns the patterns<a name="line.94"></a>
+<FONT color="green">095</FONT> * @param dependencies the dependencies<a name="line.95"></a>
+<FONT color="green">096</FONT> * @return a set containing artifacts matching one of the patterns or <code>null</code><a name="line.96"></a>
+<FONT color="green">097</FONT> * @throws EnforcerRuleException the enforcer rule exception<a name="line.97"></a>
+<FONT color="green">098</FONT> */<a name="line.98"></a>
+<FONT color="green">099</FONT> private Set<Artifact> checkDependencies( Set<Artifact> dependencies, List<String> thePatterns )<a name="line.99"></a>
+<FONT color="green">100</FONT> throws EnforcerRuleException<a name="line.100"></a>
+<FONT color="green">101</FONT> {<a name="line.101"></a>
+<FONT color="green">102</FONT> Set<Artifact> foundMatches = null;<a name="line.102"></a>
+<FONT color="green">103</FONT> <a name="line.103"></a>
+<FONT color="green">104</FONT> if ( thePatterns != null && thePatterns.size() > 0 )<a name="line.104"></a>
+<FONT color="green">105</FONT> {<a name="line.105"></a>
+<FONT color="green">106</FONT> <a name="line.106"></a>
+<FONT color="green">107</FONT> for ( String pattern : thePatterns )<a name="line.107"></a>
+<FONT color="green">108</FONT> {<a name="line.108"></a>
+<FONT color="green">109</FONT> <a name="line.109"></a>
+<FONT color="green">110</FONT> String[] subStrings = pattern.split( ":" );<a name="line.110"></a>
+<FONT color="green">111</FONT> subStrings = StringUtils.stripAll( subStrings );<a name="line.111"></a>
+<FONT color="green">112</FONT> <a name="line.112"></a>
+<FONT color="green">113</FONT> for ( Artifact artifact : dependencies )<a name="line.113"></a>
+<FONT color="green">114</FONT> {<a name="line.114"></a>
+<FONT color="green">115</FONT> if ( compareDependency( subStrings, artifact ) )<a name="line.115"></a>
+<FONT color="green">116</FONT> {<a name="line.116"></a>
+<FONT color="green">117</FONT> // only create if needed<a name="line.117"></a>
+<FONT color="green">118</FONT> if ( foundMatches == null )<a name="line.118"></a>
+<FONT color="green">119</FONT> {<a name="line.119"></a>
+<FONT color="green">120</FONT> foundMatches = new HashSet<Artifact>();<a name="line.120"></a>
+<FONT color="green">121</FONT> }<a name="line.121"></a>
+<FONT color="green">122</FONT> foundMatches.add( artifact );<a name="line.122"></a>
+<FONT color="green">123</FONT> }<a name="line.123"></a>
+<FONT color="green">124</FONT> }<a name="line.124"></a>
+<FONT color="green">125</FONT> }<a name="line.125"></a>
+<FONT color="green">126</FONT> }<a name="line.126"></a>
+<FONT color="green">127</FONT> return foundMatches;<a name="line.127"></a>
+<FONT color="green">128</FONT> }<a name="line.128"></a>
+<FONT color="green">129</FONT> <a name="line.129"></a>
+<FONT color="green">130</FONT> /**<a name="line.130"></a>
+<FONT color="green">131</FONT> * Compares the parsed array of substrings against the artifact.<a name="line.131"></a>
+<FONT color="green">132</FONT> * The pattern should follow the format "groupId:artifactId:version:type:scope"<a name="line.132"></a>
+<FONT color="green">133</FONT> *<a name="line.133"></a>
+<FONT color="green">134</FONT> * @param pattern the array of patterns<a name="line.134"></a>
+<FONT color="green">135</FONT> * @param artifact the artifact<a name="line.135"></a>
+<FONT color="green">136</FONT> * @return <code>true</code> if the artifact matches one of the patterns<a name="line.136"></a>
+<FONT color="green">137</FONT> * @throws EnforcerRuleException the enforcer rule exception<a name="line.137"></a>
+<FONT color="green">138</FONT> */<a name="line.138"></a>
+<FONT color="green">139</FONT> protected boolean compareDependency( String[] pattern, Artifact artifact )<a name="line.139"></a>
+<FONT color="green">140</FONT> throws EnforcerRuleException<a name="line.140"></a>
+<FONT color="green">141</FONT> {<a name="line.141"></a>
+<FONT color="green">142</FONT> <a name="line.142"></a>
+<FONT color="green">143</FONT> boolean result = false;<a name="line.143"></a>
+<FONT color="green">144</FONT> if ( pattern.length > 0 )<a name="line.144"></a>
+<FONT color="green">145</FONT> {<a name="line.145"></a>
+<FONT color="green">146</FONT> result = pattern[0].equals( "*" ) || artifact.getGroupId().equals( pattern[0] );<a name="line.146"></a>
+<FONT color="green">147</FONT> }<a name="line.147"></a>
+<FONT color="green">148</FONT> <a name="line.148"></a>
+<FONT color="green">149</FONT> if ( result && pattern.length > 1 )<a name="line.149"></a>
+<FONT color="green">150</FONT> {<a name="line.150"></a>
+<FONT color="green">151</FONT> result = pattern[1].equals( "*" ) || artifact.getArtifactId().equals( pattern[1] );<a name="line.151"></a>
+<FONT color="green">152</FONT> }<a name="line.152"></a>
+<FONT color="green">153</FONT> <a name="line.153"></a>
+<FONT color="green">154</FONT> if ( result && pattern.length > 2 )<a name="line.154"></a>
+<FONT color="green">155</FONT> {<a name="line.155"></a>
+<FONT color="green">156</FONT> // short circuit if the versions are exactly the same<a name="line.156"></a>
+<FONT color="green">157</FONT> if ( pattern[2].equals( "*" ) || artifact.getVersion().equals( pattern[2] ) )<a name="line.157"></a>
+<FONT color="green">158</FONT> {<a name="line.158"></a>
+<FONT color="green">159</FONT> result = true;<a name="line.159"></a>
+<FONT color="green">160</FONT> }<a name="line.160"></a>
+<FONT color="green">161</FONT> else<a name="line.161"></a>
+<FONT color="green">162</FONT> {<a name="line.162"></a>
+<FONT color="green">163</FONT> try<a name="line.163"></a>
+<FONT color="green">164</FONT> {<a name="line.164"></a>
+<FONT color="green">165</FONT> result =<a name="line.165"></a>
+<FONT color="green">166</FONT> AbstractVersionEnforcer.containsVersion( VersionRange.createFromVersionSpec( pattern[2] ),<a name="line.166"></a>
+<FONT color="green">167</FONT> new DefaultArtifactVersion( artifact.getBaseVersion() ) );<a name="line.167"></a>
+<FONT color="green">168</FONT> }<a name="line.168"></a>
+<FONT color="green">169</FONT> catch ( InvalidVersionSpecificationException e )<a name="line.169"></a>
+<FONT color="green">170</FONT> {<a name="line.170"></a>
+<FONT color="green">171</FONT> throw new EnforcerRuleException( "Invalid Version Range: ", e );<a name="line.171"></a>
+<FONT color="green">172</FONT> }<a name="line.172"></a>
+<FONT color="green">173</FONT> }<a name="line.173"></a>
+<FONT color="green">174</FONT> }<a name="line.174"></a>
+<FONT color="green">175</FONT> <a name="line.175"></a>
+<FONT color="green">176</FONT> if ( result && pattern.length > 3 )<a name="line.176"></a>
+<FONT color="green">177</FONT> {<a name="line.177"></a>
+<FONT color="green">178</FONT> String type = artifact.getType();<a name="line.178"></a>
+<FONT color="green">179</FONT> if ( type == null || type.equals( "" ) )<a name="line.179"></a>
+<FONT color="green">180</FONT> {<a name="line.180"></a>
+<FONT color="green">181</FONT> type = "jar";<a name="line.181"></a>
+<FONT color="green">182</FONT> }<a name="line.182"></a>
+<FONT color="green">183</FONT> result = pattern[3].equals( "*" ) || type.equals( pattern[3] );<a name="line.183"></a>
+<FONT color="green">184</FONT> }<a name="line.184"></a>
+<FONT color="green">185</FONT> <a name="line.185"></a>
+<FONT color="green">186</FONT> if ( result && pattern.length > 4 )<a name="line.186"></a>
+<FONT color="green">187</FONT> {<a name="line.187"></a>
+<FONT color="green">188</FONT> String scope = artifact.getScope();<a name="line.188"></a>
+<FONT color="green">189</FONT> if ( scope == null || scope.equals( "" ) )<a name="line.189"></a>
+<FONT color="green">190</FONT> {<a name="line.190"></a>
+<FONT color="green">191</FONT> scope = "compile";<a name="line.191"></a>
+<FONT color="green">192</FONT> }<a name="line.192"></a>
+<FONT color="green">193</FONT> result = pattern[4].equals( "*" ) || scope.equals( pattern[4] );<a name="line.193"></a>
+<FONT color="green">194</FONT> }<a name="line.194"></a>
+<FONT color="green">195</FONT> <a name="line.195"></a>
+<FONT color="green">196</FONT> return result;<a name="line.196"></a>
+<FONT color="green">197</FONT> }<a name="line.197"></a>
+<FONT color="green">198</FONT> <a name="line.198"></a>
+<FONT color="green">199</FONT> /**<a name="line.199"></a>
+<FONT color="green">200</FONT> * Gets the excludes.<a name="line.200"></a>
+<FONT color="green">201</FONT> *<a name="line.201"></a>
+<FONT color="green">202</FONT> * @return the excludes<a name="line.202"></a>
+<FONT color="green">203</FONT> */<a name="line.203"></a>
+<FONT color="green">204</FONT> public List<String> getExcludes()<a name="line.204"></a>
+<FONT color="green">205</FONT> {<a name="line.205"></a>
+<FONT color="green">206</FONT> return this.excludes;<a name="line.206"></a>
+<FONT color="green">207</FONT> }<a name="line.207"></a>
+<FONT color="green">208</FONT> <a name="line.208"></a>
+<FONT color="green">209</FONT> /**<a name="line.209"></a>
+<FONT color="green">210</FONT> * Sets the excludes.<a name="line.210"></a>
+<FONT color="green">211</FONT> *<a name="line.211"></a>
+<FONT color="green">212</FONT> * @param theExcludes the excludes to set<a name="line.212"></a>
+<FONT color="green">213</FONT> */<a name="line.213"></a>
+<FONT color="green">214</FONT> public void setExcludes( List<String> theExcludes )<a name="line.214"></a>
+<FONT color="green">215</FONT> {<a name="line.215"></a>
+<FONT color="green">216</FONT> this.excludes = theExcludes;<a name="line.216"></a>
+<FONT color="green">217</FONT> }<a name="line.217"></a>
+<FONT color="green">218</FONT> <a name="line.218"></a>
+<FONT color="green">219</FONT> /**<a name="line.219"></a>
+<FONT color="green">220</FONT> * Gets the includes.<a name="line.220"></a>
+<FONT color="green">221</FONT> *<a name="line.221"></a>
+<FONT color="green">222</FONT> * @return the includes<a name="line.222"></a>
+<FONT color="green">223</FONT> */<a name="line.223"></a>
+<FONT color="green">224</FONT> public List<String> getIncludes()<a name="line.224"></a>
+<FONT color="green">225</FONT> {<a name="line.225"></a>
+<FONT color="green">226</FONT> return this.includes;<a name="line.226"></a>
+<FONT color="green">227</FONT> }<a name="line.227"></a>
+<FONT color="green">228</FONT> <a name="line.228"></a>
+<FONT color="green">229</FONT> /**<a name="line.229"></a>
+<FONT color="green">230</FONT> * Sets the includes.<a name="line.230"></a>
+<FONT color="green">231</FONT> *<a name="line.231"></a>
+<FONT color="green">232</FONT> * @param theIncludes the includes to set<a name="line.232"></a>
+<FONT color="green">233</FONT> */<a name="line.233"></a>
+<FONT color="green">234</FONT> public void setIncludes( List<String> theIncludes )<a name="line.234"></a>
+<FONT color="green">235</FONT> {<a name="line.235"></a>
+<FONT color="green">236</FONT> this.includes = theIncludes;<a name="line.236"></a>
+<FONT color="green">237</FONT> }<a name="line.237"></a>
+<FONT color="green">238</FONT> <a name="line.238"></a>
+<FONT color="green">239</FONT> }<a name="line.239"></a>
Modified: websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/apidocs/src-html/org/apache/maven/plugins/enforcer/EvaluateBeanshell.html
==============================================================================
--- websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/apidocs/src-html/org/apache/maven/plugins/enforcer/EvaluateBeanshell.html (original)
+++ websites/production/maven/content/enforcer-archives/enforcer-LATEST/enforcer-rules/apidocs/src-html/org/apache/maven/plugins/enforcer/EvaluateBeanshell.html Tue Jun 25 20:07:43 2013
@@ -22,96 +22,103 @@
<FONT color="green">019</FONT> * under the License.<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
-<FONT color="green">022</FONT> import org.apache.maven.enforcer.rule.api.EnforcerRuleException;<a name="line.22"></a>
-<FONT color="green">023</FONT> import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;<a name="line.23"></a>
-<FONT color="green">024</FONT> import org.apache.maven.plugin.logging.Log;<a name="line.24"></a>
-<FONT color="green">025</FONT> import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;<a name="line.25"></a>
-<FONT color="green">026</FONT> import org.codehaus.plexus.util.StringUtils;<a name="line.26"></a>
-<FONT color="green">027</FONT> <a name="line.27"></a>
-<FONT color="green">028</FONT> import bsh.EvalError;<a name="line.28"></a>
-<FONT color="green">029</FONT> import bsh.Interpreter;<a name="line.29"></a>
-<FONT color="green">030</FONT> <a name="line.30"></a>
-<FONT color="green">031</FONT> /**<a name="line.31"></a>
-<FONT color="green">032</FONT> * Rule for Maven Enforcer using Beanshell to evaluate a conditional expression.<a name="line.32"></a>
-<FONT color="green">033</FONT> *<a name="line.33"></a>
-<FONT color="green">034</FONT> * @author hugonnem<a name="line.34"></a>
-<FONT color="green">035</FONT> */<a name="line.35"></a>
-<FONT color="green">036</FONT> public class EvaluateBeanshell<a name="line.36"></a>
-<FONT color="green">037</FONT> extends AbstractNonCacheableEnforcerRule<a name="line.37"></a>
-<FONT color="green">038</FONT> {<a name="line.38"></a>
-<FONT color="green">039</FONT> <a name="line.39"></a>
-<FONT color="green">040</FONT> /** Beanshell interpreter. */<a name="line.40"></a>
-<FONT color="green">041</FONT> private static final Interpreter bsh = new Interpreter();<a name="line.41"></a>
-<FONT color="green">042</FONT> <a name="line.42"></a>
-<FONT color="green">043</FONT> /** The condition to be evaluated. */<a name="line.43"></a>
-<FONT color="green">044</FONT> private String condition;<a name="line.44"></a>
-<FONT color="green">045</FONT> <a name="line.45"></a>
-<FONT color="green">046</FONT> public final void setCondition( String condition )<a name="line.46"></a>
-<FONT color="green">047</FONT> {<a name="line.47"></a>
-<FONT color="green">048</FONT> this.condition = condition;<a name="line.48"></a>
-<FONT color="green">049</FONT> }<a name="line.49"></a>
-<FONT color="green">050</FONT> <a name="line.50"></a>
-<FONT color="green">051</FONT> public final String getCondition()<a name="line.51"></a>
-<FONT color="green">052</FONT> {<a name="line.52"></a>
-<FONT color="green">053</FONT> return condition;<a name="line.53"></a>
-<FONT color="green">054</FONT> }<a name="line.54"></a>
-<FONT color="green">055</FONT> <a name="line.55"></a>
-<FONT color="green">056</FONT> /*<a name="line.56"></a>
-<FONT color="green">057</FONT> * (non-Javadoc)<a name="line.57"></a>
-<FONT color="green">058</FONT> *<a name="line.58"></a>
-<FONT color="green">059</FONT> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)<a name="line.59"></a>
-<FONT color="green">060</FONT> */<a name="line.60"></a>
-<FONT color="green">061</FONT> public void execute( EnforcerRuleHelper helper )<a name="line.61"></a>
-<FONT color="green">062</FONT> throws EnforcerRuleException<a name="line.62"></a>
-<FONT color="green">063</FONT> {<a name="line.63"></a>
-<FONT color="green">064</FONT> Log log = helper.getLog();<a name="line.64"></a>
-<FONT color="green">065</FONT> <a name="line.65"></a>
-<FONT color="green">066</FONT> try<a name="line.66"></a>
-<FONT color="green">067</FONT> {<a name="line.67"></a>
-<FONT color="green">068</FONT> log.debug( "Echo condition : " + this.condition );<a name="line.68"></a>
-<FONT color="green">069</FONT> // Evaluate condition within Plexus Container<a name="line.69"></a>
-<FONT color="green">070</FONT> String script = (String) helper.evaluate( this.condition );<a name="line.70"></a>
-<FONT color="green">071</FONT> log.debug( "Echo script : " + script );<a name="line.71"></a>
-<FONT color="green">072</FONT> if ( !evaluateCondition( script, log ) )<a name="line.72"></a>
-<FONT color="green">073</FONT> {<a name="line.73"></a>
-<FONT color="green">074</FONT> String message = getMessage();<a name="line.74"></a>
-<FONT color="green">075</FONT> if ( StringUtils.isEmpty( message ) )<a name="line.75"></a>
-<FONT color="green">076</FONT> {<a name="line.76"></a>
-<FONT color="green">077</FONT> message = "The expression \"" + condition + "\" is not true.";<a name="line.77"></a>
-<FONT color="green">078</FONT> }<a name="line.78"></a>
-<FONT color="green">079</FONT> throw new EnforcerRuleException( message );<a name="line.79"></a>
-<FONT color="green">080</FONT> }<a name="line.80"></a>
-<FONT color="green">081</FONT> }<a name="line.81"></a>
-<FONT color="green">082</FONT> catch ( ExpressionEvaluationException e )<a name="line.82"></a>
-<FONT color="green">083</FONT> {<a name="line.83"></a>
-<FONT color="green">084</FONT> throw new EnforcerRuleException( "Unable to evaluate an expression '" + condition + "'", e );<a name="line.84"></a>
-<FONT color="green">085</FONT> }<a name="line.85"></a>
-<FONT color="green">086</FONT> }<a name="line.86"></a>
-<FONT color="green">087</FONT> <a name="line.87"></a>
-<FONT color="green">088</FONT> /**<a name="line.88"></a>
-<FONT color="green">089</FONT> * Evaluate expression using Beanshell.<a name="line.89"></a>
-<FONT color="green">090</FONT> *<a name="line.90"></a>
-<FONT color="green">091</FONT> * @param script the expression to be evaluated<a name="line.91"></a>
-<FONT color="green">092</FONT> * @param log the logger<a name="line.92"></a>
-<FONT color="green">093</FONT> * @return boolean the evaluation of the expression<a name="line.93"></a>
-<FONT color="green">094</FONT> * @throws EnforcerRuleException if the script could not be evaluated<a name="line.94"></a>
-<FONT color="green">095</FONT> */<a name="line.95"></a>
-<FONT color="green">096</FONT> protected boolean evaluateCondition( String script, Log log )<a name="line.96"></a>
-<FONT color="green">097</FONT> throws EnforcerRuleException<a name="line.97"></a>
-<FONT color="green">098</FONT> {<a name="line.98"></a>
-<FONT color="green">099</FONT> Boolean evaluation = Boolean.FALSE;<a name="line.99"></a>
-<FONT color="green">100</FONT> try<a name="line.100"></a>
-<FONT color="green">101</FONT> {<a name="line.101"></a>
-<FONT color="green">102</FONT> evaluation = (Boolean) bsh.eval( script );<a name="line.102"></a>
-<FONT color="green">103</FONT> log.debug( "Echo evaluating : " + evaluation );<a name="line.103"></a>
-<FONT color="green">104</FONT> }<a name="line.104"></a>
-<FONT color="green">105</FONT> catch ( EvalError ex )<a name="line.105"></a>
-<FONT color="green">106</FONT> {<a name="line.106"></a>
-<FONT color="green">107</FONT> throw new EnforcerRuleException( "Couldn't evaluate condition: " + script, ex );<a name="line.107"></a>
-<FONT color="green">108</FONT> }<a name="line.108"></a>
-<FONT color="green">109</FONT> return evaluation.booleanValue();<a name="line.109"></a>
-<FONT color="green">110</FONT> }<a name="line.110"></a>
-<FONT color="green">111</FONT> }<a name="line.111"></a>
+<FONT color="green">022</FONT> import java.util.List;<a name="line.22"></a>
+<FONT color="green">023</FONT> <a name="line.23"></a>
+<FONT color="green">024</FONT> import org.apache.maven.enforcer.rule.api.EnforcerRuleException;<a name="line.24"></a>
+<FONT color="green">025</FONT> import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;<a name="line.25"></a>
+<FONT color="green">026</FONT> import org.apache.maven.plugin.logging.Log;<a name="line.26"></a>
+<FONT color="green">027</FONT> import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;<a name="line.27"></a>
+<FONT color="green">028</FONT> import org.codehaus.plexus.util.StringUtils;<a name="line.28"></a>
+<FONT color="green">029</FONT> <a name="line.29"></a>
+<FONT color="green">030</FONT> import bsh.EvalError;<a name="line.30"></a>
+<FONT color="green">031</FONT> import bsh.Interpreter;<a name="line.31"></a>
+<FONT color="green">032</FONT> <a name="line.32"></a>
+<FONT color="green">033</FONT> /**<a name="line.33"></a>
+<FONT color="green">034</FONT> * Rule for Maven Enforcer using Beanshell to evaluate a conditional expression.<a name="line.34"></a>
+<FONT color="green">035</FONT> *<a name="line.35"></a>
+<FONT color="green">036</FONT> * @author hugonnem<a name="line.36"></a>
+<FONT color="green">037</FONT> */<a name="line.37"></a>
+<FONT color="green">038</FONT> public class EvaluateBeanshell<a name="line.38"></a>
+<FONT color="green">039</FONT> extends AbstractNonCacheableEnforcerRule<a name="line.39"></a>
+<FONT color="green">040</FONT> {<a name="line.40"></a>
+<FONT color="green">041</FONT> <a name="line.41"></a>
+<FONT color="green">042</FONT> /** Beanshell interpreter. */<a name="line.42"></a>
+<FONT color="green">043</FONT> private static final Interpreter bsh = new Interpreter();<a name="line.43"></a>
+<FONT color="green">044</FONT> <a name="line.44"></a>
+<FONT color="green">045</FONT> /** The condition to be evaluated.<a name="line.45"></a>
+<FONT color="green">046</FONT> * <a name="line.46"></a>
+<FONT color="green">047</FONT> * @deprecated the visibility will be reduced to private with the next major version<a name="line.47"></a>
+<FONT color="green">048</FONT> * @see {@link #setCondition(String)}<a name="line.48"></a>
+<FONT color="green">049</FONT> * @see {@link #getCondition()}<a name="line.49"></a>
+<FONT color="green">050</FONT> * */<a name="line.50"></a>
+<FONT color="green">051</FONT> public String condition;<a name="line.51"></a>
+<FONT color="green">052</FONT> <a name="line.52"></a>
+<FONT color="green">053</FONT> public final void setCondition( String condition )<a name="line.53"></a>
+<FONT color="green">054</FONT> {<a name="line.54"></a>
+<FONT color="green">055</FONT> this.condition = condition;<a name="line.55"></a>
+<FONT color="green">056</FONT> }<a name="line.56"></a>
+<FONT color="green">057</FONT> <a name="line.57"></a>
+<FONT color="green">058</FONT> public final String getCondition()<a name="line.58"></a>
+<FONT color="green">059</FONT> {<a name="line.59"></a>
+<FONT color="green">060</FONT> return condition;<a name="line.60"></a>
+<FONT color="green">061</FONT> }<a name="line.61"></a>
+<FONT color="green">062</FONT> <a name="line.62"></a>
+<FONT color="green">063</FONT> /*<a name="line.63"></a>
+<FONT color="green">064</FONT> * (non-Javadoc)<a name="line.64"></a>
+<FONT color="green">065</FONT> *<a name="line.65"></a>
+<FONT color="green">066</FONT> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)<a name="line.66"></a>
+<FONT color="green">067</FONT> */<a name="line.67"></a>
+<FONT color="green">068</FONT> public void execute( EnforcerRuleHelper helper )<a name="line.68"></a>
+<FONT color="green">069</FONT> throws EnforcerRuleException<a name="line.69"></a>
+<FONT color="green">070</FONT> {<a name="line.70"></a>
+<FONT color="green">071</FONT> Log log = helper.getLog();<a name="line.71"></a>
+<FONT color="green">072</FONT> <a name="line.72"></a>
+<FONT color="green">073</FONT> try<a name="line.73"></a>
+<FONT color="green">074</FONT> {<a name="line.74"></a>
+<FONT color="green">075</FONT> log.debug( "Echo condition : " + this.condition );<a name="line.75"></a>
+<FONT color="green">076</FONT> // Evaluate condition within Plexus Container<a name="line.76"></a>
+<FONT color="green">077</FONT> String script = (String) helper.evaluate( this.condition );<a name="line.77"></a>
+<FONT color="green">078</FONT> log.debug( "Echo script : " + script );<a name="line.78"></a>
+<FONT color="green">079</FONT> if ( !evaluateCondition( script, log ) )<a name="line.79"></a>
+<FONT color="green">080</FONT> {<a name="line.80"></a>
+<FONT color="green">081</FONT> String message = getMessage();<a name="line.81"></a>
+<FONT color="green">082</FONT> if ( StringUtils.isEmpty( message ) )<a name="line.82"></a>
+<FONT color="green">083</FONT> {<a name="line.83"></a>
+<FONT color="green">084</FONT> message = "The expression \"" + condition + "\" is not true.";<a name="line.84"></a>
+<FONT color="green">085</FONT> }<a name="line.85"></a>
+<FONT color="green">086</FONT> throw new EnforcerRuleException( message );<a name="line.86"></a>
+<FONT color="green">087</FONT> }<a name="line.87"></a>
+<FONT color="green">088</FONT> }<a name="line.88"></a>
+<FONT color="green">089</FONT> catch ( ExpressionEvaluationException e )<a name="line.89"></a>
+<FONT color="green">090</FONT> {<a name="line.90"></a>
+<FONT color="green">091</FONT> throw new EnforcerRuleException( "Unable to evaluate an expression '" + condition + "'", e );<a name="line.91"></a>
+<FONT color="green">092</FONT> }<a name="line.92"></a>
+<FONT color="green">093</FONT> }<a name="line.93"></a>
+<FONT color="green">094</FONT> <a name="line.94"></a>
+<FONT color="green">095</FONT> /**<a name="line.95"></a>
+<FONT color="green">096</FONT> * Evaluate expression using Beanshell.<a name="line.96"></a>
+<FONT color="green">097</FONT> *<a name="line.97"></a>
+<FONT color="green">098</FONT> * @param script the expression to be evaluated<a name="line.98"></a>
+<FONT color="green">099</FONT> * @param log the logger<a name="line.99"></a>
+<FONT color="green">100</FONT> * @return boolean the evaluation of the expression<a name="line.100"></a>
+<FONT color="green">101</FONT> * @throws EnforcerRuleException if the script could not be evaluated<a name="line.101"></a>
+<FONT color="green">102</FONT> */<a name="line.102"></a>
+<FONT color="green">103</FONT> protected boolean evaluateCondition( String script, Log log )<a name="line.103"></a>
+<FONT color="green">104</FONT> throws EnforcerRuleException<a name="line.104"></a>
+<FONT color="green">105</FONT> {<a name="line.105"></a>
+<FONT color="green">106</FONT> Boolean evaluation = Boolean.FALSE;<a name="line.106"></a>
+<FONT color="green">107</FONT> try<a name="line.107"></a>
+<FONT color="green">108</FONT> {<a name="line.108"></a>
+<FONT color="green">109</FONT> evaluation = (Boolean) bsh.eval( script );<a name="line.109"></a>
+<FONT color="green">110</FONT> log.debug( "Echo evaluating : " + evaluation );<a name="line.110"></a>
+<FONT color="green">111</FONT> }<a name="line.111"></a>
+<FONT color="green">112</FONT> catch ( EvalError ex )<a name="line.112"></a>
+<FONT color="green">113</FONT> {<a name="line.113"></a>
+<FONT color="green">114</FONT> throw new EnforcerRuleException( "Couldn't evaluate condition: " + script, ex );<a name="line.114"></a>
+<FONT color="green">115</FONT> }<a name="line.115"></a>
+<FONT color="green">116</FONT> return evaluation.booleanValue();<a name="line.116"></a>
+<FONT color="green">117</FONT> }<a name="line.117"></a>
+<FONT color="green">118</FONT> }<a name="line.118"></a>