Google Git
Sign in
apache / archiva-web-content / 7c2ce1786c818e0e567e48c56f17c69702f385b0 / . / ref / 1.4-M4 / apidocs / src-html / org / apache / archiva / common / utils / VersionComparator.html
blob: 5d13cd468683c0330b5dc6615401e64f45fb700d [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> package org.apache.archiva.common.utils;<a name="line.1"></a>
<FONT color="green">002</FONT> <a name="line.2"></a>
<FONT color="green">003</FONT> /*<a name="line.3"></a>
<FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
<FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
<FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a>
<FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
<FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
<FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a>
<FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<FONT color="green">013</FONT> *<a name="line.13"></a>
<FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
<FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a>
<FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
<FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a>
<FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a>
<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.commons.lang.ArrayUtils;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.commons.lang.StringUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.commons.lang.math.NumberUtils;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.ArrayList;<a name="line.26"></a>
<FONT color="green">027</FONT> import java.util.Comparator;<a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.List;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * VersionComparator - compare the parts of two version strings.<a name="line.31"></a>
<FONT color="green">032</FONT> * &lt;p/&gt;<a name="line.32"></a>
<FONT color="green">033</FONT> * Technique.<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;p/&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * * Split the version strings into parts by splitting on &lt;code&gt;"-._"&lt;/code&gt; first, then breaking apart words from numbers.<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;p/&gt;<a name="line.36"></a>
<FONT color="green">037</FONT> * &lt;code&gt;<a name="line.37"></a>
<FONT color="green">038</FONT> * "1.0" = "1", "0"<a name="line.38"></a>
<FONT color="green">039</FONT> * "1.0-alpha-1" = "1", "0", "alpha", "1"<a name="line.39"></a>
<FONT color="green">040</FONT> * "2.0-rc2" = "2", "0", "rc", "2"<a name="line.40"></a>
<FONT color="green">041</FONT> * "1.3-m2" = "1", "3", "m", "3"<a name="line.41"></a>
<FONT color="green">042</FONT> * &lt;/code&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> * &lt;p/&gt;<a name="line.43"></a>
<FONT color="green">044</FONT> * compare each part individually, and when they do not match, perform the following test.<a name="line.44"></a>
<FONT color="green">045</FONT> * &lt;p/&gt;<a name="line.45"></a>
<FONT color="green">046</FONT> * Numbers are calculated per normal comparison rules.<a name="line.46"></a>
<FONT color="green">047</FONT> * Words that are part of the "special word list" will be treated as their index within that heirarchy.<a name="line.47"></a>
<FONT color="green">048</FONT> * Words that cannot be identified as special, are treated using normal case-insensitive comparison rules.<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> */<a name="line.51"></a>
<FONT color="green">052</FONT> public class VersionComparator<a name="line.52"></a>
<FONT color="green">053</FONT> implements Comparator&lt;String&gt;<a name="line.53"></a>
<FONT color="green">054</FONT> {<a name="line.54"></a>
<FONT color="green">055</FONT> private static Comparator&lt;String&gt; INSTANCE = new VersionComparator();<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> private List&lt;String&gt; specialWords;<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> public VersionComparator()<a name="line.59"></a>
<FONT color="green">060</FONT> {<a name="line.60"></a>
<FONT color="green">061</FONT> specialWords = new ArrayList&lt;String&gt;( 23 );<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> // ids that refer to LATEST<a name="line.63"></a>
<FONT color="green">064</FONT> specialWords.add( "final" );<a name="line.64"></a>
<FONT color="green">065</FONT> specialWords.add( "release" );<a name="line.65"></a>
<FONT color="green">066</FONT> specialWords.add( "current" );<a name="line.66"></a>
<FONT color="green">067</FONT> specialWords.add( "latest" );<a name="line.67"></a>
<FONT color="green">068</FONT> specialWords.add( "g" );<a name="line.68"></a>
<FONT color="green">069</FONT> specialWords.add( "gold" );<a name="line.69"></a>
<FONT color="green">070</FONT> specialWords.add( "fcs" );<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> // ids that are for a release cycle.<a name="line.72"></a>
<FONT color="green">073</FONT> specialWords.add( "a" );<a name="line.73"></a>
<FONT color="green">074</FONT> specialWords.add( "alpha" );<a name="line.74"></a>
<FONT color="green">075</FONT> specialWords.add( "b" );<a name="line.75"></a>
<FONT color="green">076</FONT> specialWords.add( "beta" );<a name="line.76"></a>
<FONT color="green">077</FONT> specialWords.add( "pre" );<a name="line.77"></a>
<FONT color="green">078</FONT> specialWords.add( "rc" );<a name="line.78"></a>
<FONT color="green">079</FONT> specialWords.add( "m" );<a name="line.79"></a>
<FONT color="green">080</FONT> specialWords.add( "milestone" );<a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> // ids that are for dev / debug cycles.<a name="line.82"></a>
<FONT color="green">083</FONT> specialWords.add( "dev" );<a name="line.83"></a>
<FONT color="green">084</FONT> specialWords.add( "test" );<a name="line.84"></a>
<FONT color="green">085</FONT> specialWords.add( "debug" );<a name="line.85"></a>
<FONT color="green">086</FONT> specialWords.add( "unofficial" );<a name="line.86"></a>
<FONT color="green">087</FONT> specialWords.add( "nightly" );<a name="line.87"></a>
<FONT color="green">088</FONT> specialWords.add( "incubating" );<a name="line.88"></a>
<FONT color="green">089</FONT> specialWords.add( "incubator" );<a name="line.89"></a>
<FONT color="green">090</FONT> specialWords.add( "snapshot" );<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> <a name="line.92"></a>
<FONT color="green">093</FONT> public static Comparator&lt;String&gt; getInstance()<a name="line.93"></a>
<FONT color="green">094</FONT> {<a name="line.94"></a>
<FONT color="green">095</FONT> return INSTANCE;<a name="line.95"></a>
<FONT color="green">096</FONT> }<a name="line.96"></a>
<FONT color="green">097</FONT> <a name="line.97"></a>
<FONT color="green">098</FONT> public int compare( String o1, String o2 )<a name="line.98"></a>
<FONT color="green">099</FONT> {<a name="line.99"></a>
<FONT color="green">100</FONT> if ( o1 == null &amp;&amp; o2 == null )<a name="line.100"></a>
<FONT color="green">101</FONT> {<a name="line.101"></a>
<FONT color="green">102</FONT> return 0;<a name="line.102"></a>
<FONT color="green">103</FONT> }<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> if ( o1 == null )<a name="line.105"></a>
<FONT color="green">106</FONT> {<a name="line.106"></a>
<FONT color="green">107</FONT> return 1;<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> if ( o2 == null )<a name="line.110"></a>
<FONT color="green">111</FONT> {<a name="line.111"></a>
<FONT color="green">112</FONT> return -1;<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> String[] parts1 = toParts( o1 );<a name="line.115"></a>
<FONT color="green">116</FONT> String[] parts2 = toParts( o2 );<a name="line.116"></a>
<FONT color="green">117</FONT> <a name="line.117"></a>
<FONT color="green">118</FONT> int diff;<a name="line.118"></a>
<FONT color="green">119</FONT> int partLen = Math.max( parts1.length, parts2.length );<a name="line.119"></a>
<FONT color="green">120</FONT> for ( int i = 0; i &lt; partLen; i++ )<a name="line.120"></a>
<FONT color="green">121</FONT> {<a name="line.121"></a>
<FONT color="green">122</FONT> diff = comparePart( safePart( parts1, i ), safePart( parts2, i ) );<a name="line.122"></a>
<FONT color="green">123</FONT> if ( diff != 0 )<a name="line.123"></a>
<FONT color="green">124</FONT> {<a name="line.124"></a>
<FONT color="green">125</FONT> return diff;<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> }<a name="line.127"></a>
<FONT color="green">128</FONT> <a name="line.128"></a>
<FONT color="green">129</FONT> diff = parts2.length - parts1.length;<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> if ( diff != 0 )<a name="line.131"></a>
<FONT color="green">132</FONT> {<a name="line.132"></a>
<FONT color="green">133</FONT> return diff;<a name="line.133"></a>
<FONT color="green">134</FONT> }<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> return o1.compareToIgnoreCase( o2 );<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> private String safePart( String[] parts, int idx )<a name="line.139"></a>
<FONT color="green">140</FONT> {<a name="line.140"></a>
<FONT color="green">141</FONT> if ( idx &lt; parts.length )<a name="line.141"></a>
<FONT color="green">142</FONT> {<a name="line.142"></a>
<FONT color="green">143</FONT> return parts[idx];<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> return "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> private int comparePart( String s1, String s2 )<a name="line.149"></a>
<FONT color="green">150</FONT> {<a name="line.150"></a>
<FONT color="green">151</FONT> boolean is1Num = NumberUtils.isNumber( s1 );<a name="line.151"></a>
<FONT color="green">152</FONT> boolean is2Num = NumberUtils.isNumber( s2 );<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> // (Special Case) Test for numbers both first.<a name="line.154"></a>
<FONT color="green">155</FONT> if ( is1Num &amp;&amp; is2Num )<a name="line.155"></a>
<FONT color="green">156</FONT> {<a name="line.156"></a>
<FONT color="green">157</FONT> int i1 = NumberUtils.toInt( s1 );<a name="line.157"></a>
<FONT color="green">158</FONT> int i2 = NumberUtils.toInt( s2 );<a name="line.158"></a>
<FONT color="green">159</FONT> <a name="line.159"></a>
<FONT color="green">160</FONT> return i1 - i2;<a name="line.160"></a>
<FONT color="green">161</FONT> }<a name="line.161"></a>
<FONT color="green">162</FONT> <a name="line.162"></a>
<FONT color="green">163</FONT> // Test for text both next.<a name="line.163"></a>
<FONT color="green">164</FONT> if ( !is1Num &amp;&amp; !is2Num )<a name="line.164"></a>
<FONT color="green">165</FONT> {<a name="line.165"></a>
<FONT color="green">166</FONT> int idx1 = specialWords.indexOf( s1.toLowerCase() );<a name="line.166"></a>
<FONT color="green">167</FONT> int idx2 = specialWords.indexOf( s2.toLowerCase() );<a name="line.167"></a>
<FONT color="green">168</FONT> <a name="line.168"></a>
<FONT color="green">169</FONT> // Only operate perform index based operation, if both strings<a name="line.169"></a>
<FONT color="green">170</FONT> // are found in the specialWords index.<a name="line.170"></a>
<FONT color="green">171</FONT> if ( idx1 &gt;= 0 &amp;&amp; idx2 &gt;= 0 )<a name="line.171"></a>
<FONT color="green">172</FONT> {<a name="line.172"></a>
<FONT color="green">173</FONT> return idx1 - idx2;<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> <a name="line.176"></a>
<FONT color="green">177</FONT> // Comparing text to num<a name="line.177"></a>
<FONT color="green">178</FONT> if ( !is1Num &amp;&amp; is2Num )<a name="line.178"></a>
<FONT color="green">179</FONT> {<a name="line.179"></a>
<FONT color="green">180</FONT> return -1;<a name="line.180"></a>
<FONT color="green">181</FONT> }<a name="line.181"></a>
<FONT color="green">182</FONT> <a name="line.182"></a>
<FONT color="green">183</FONT> // Comparing num to text<a name="line.183"></a>
<FONT color="green">184</FONT> if ( is1Num &amp;&amp; !is2Num )<a name="line.184"></a>
<FONT color="green">185</FONT> {<a name="line.185"></a>
<FONT color="green">186</FONT> return 1;<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> <a name="line.188"></a>
<FONT color="green">189</FONT> // Return comparison of strings themselves.<a name="line.189"></a>
<FONT color="green">190</FONT> return s1.compareToIgnoreCase( s2 );<a name="line.190"></a>
<FONT color="green">191</FONT> }<a name="line.191"></a>
<FONT color="green">192</FONT> <a name="line.192"></a>
<FONT color="green">193</FONT> public static String[] toParts( String version )<a name="line.193"></a>
<FONT color="green">194</FONT> {<a name="line.194"></a>
<FONT color="green">195</FONT> if ( StringUtils.isBlank( version ) )<a name="line.195"></a>
<FONT color="green">196</FONT> {<a name="line.196"></a>
<FONT color="green">197</FONT> return ArrayUtils.EMPTY_STRING_ARRAY;<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> int modeOther = 0;<a name="line.200"></a>
<FONT color="green">201</FONT> int modeDigit = 1;<a name="line.201"></a>
<FONT color="green">202</FONT> int modeText = 2;<a name="line.202"></a>
<FONT color="green">203</FONT> <a name="line.203"></a>
<FONT color="green">204</FONT> List&lt;String&gt; parts = new ArrayList&lt;String&gt;();<a name="line.204"></a>
<FONT color="green">205</FONT> int len = version.length();<a name="line.205"></a>
<FONT color="green">206</FONT> int i = 0;<a name="line.206"></a>
<FONT color="green">207</FONT> int start = 0;<a name="line.207"></a>
<FONT color="green">208</FONT> int mode = modeOther;<a name="line.208"></a>
<FONT color="green">209</FONT> <a name="line.209"></a>
<FONT color="green">210</FONT> while ( i &lt; len )<a name="line.210"></a>
<FONT color="green">211</FONT> {<a name="line.211"></a>
<FONT color="green">212</FONT> char c = version.charAt( i );<a name="line.212"></a>
<FONT color="green">213</FONT> <a name="line.213"></a>
<FONT color="green">214</FONT> if ( Character.isDigit( c ) )<a name="line.214"></a>
<FONT color="green">215</FONT> {<a name="line.215"></a>
<FONT color="green">216</FONT> if ( mode != modeDigit )<a name="line.216"></a>
<FONT color="green">217</FONT> {<a name="line.217"></a>
<FONT color="green">218</FONT> if ( mode != modeOther )<a name="line.218"></a>
<FONT color="green">219</FONT> {<a name="line.219"></a>
<FONT color="green">220</FONT> parts.add( version.substring( start, i ) );<a name="line.220"></a>
<FONT color="green">221</FONT> }<a name="line.221"></a>
<FONT color="green">222</FONT> mode = modeDigit;<a name="line.222"></a>
<FONT color="green">223</FONT> start = i;<a name="line.223"></a>
<FONT color="green">224</FONT> }<a name="line.224"></a>
<FONT color="green">225</FONT> }<a name="line.225"></a>
<FONT color="green">226</FONT> else if ( Character.isLetter( c ) )<a name="line.226"></a>
<FONT color="green">227</FONT> {<a name="line.227"></a>
<FONT color="green">228</FONT> if ( mode != modeText )<a name="line.228"></a>
<FONT color="green">229</FONT> {<a name="line.229"></a>
<FONT color="green">230</FONT> if ( mode != modeOther )<a name="line.230"></a>
<FONT color="green">231</FONT> {<a name="line.231"></a>
<FONT color="green">232</FONT> parts.add( version.substring( start, i ) );<a name="line.232"></a>
<FONT color="green">233</FONT> }<a name="line.233"></a>
<FONT color="green">234</FONT> mode = modeText;<a name="line.234"></a>
<FONT color="green">235</FONT> start = i;<a name="line.235"></a>
<FONT color="green">236</FONT> }<a name="line.236"></a>
<FONT color="green">237</FONT> }<a name="line.237"></a>
<FONT color="green">238</FONT> else<a name="line.238"></a>
<FONT color="green">239</FONT> {<a name="line.239"></a>
<FONT color="green">240</FONT> // Other.<a name="line.240"></a>
<FONT color="green">241</FONT> if ( mode != modeOther )<a name="line.241"></a>
<FONT color="green">242</FONT> {<a name="line.242"></a>
<FONT color="green">243</FONT> parts.add( version.substring( start, i ) );<a name="line.243"></a>
<FONT color="green">244</FONT> mode = modeOther;<a name="line.244"></a>
<FONT color="green">245</FONT> }<a name="line.245"></a>
<FONT color="green">246</FONT> }<a name="line.246"></a>
<FONT color="green">247</FONT> <a name="line.247"></a>
<FONT color="green">248</FONT> i++;<a name="line.248"></a>
<FONT color="green">249</FONT> }<a name="line.249"></a>
<FONT color="green">250</FONT> <a name="line.250"></a>
<FONT color="green">251</FONT> // Add remainder<a name="line.251"></a>
<FONT color="green">252</FONT> if ( mode != modeOther )<a name="line.252"></a>
<FONT color="green">253</FONT> {<a name="line.253"></a>
<FONT color="green">254</FONT> parts.add( version.substring( start, i ) );<a name="line.254"></a>
<FONT color="green">255</FONT> }<a name="line.255"></a>
<FONT color="green">256</FONT> <a name="line.256"></a>
<FONT color="green">257</FONT> return parts.toArray( new String[parts.size()] );<a name="line.257"></a>
<FONT color="green">258</FONT> }<a name="line.258"></a>
<FONT color="green">259</FONT> }<a name="line.259"></a>
</PRE>
</BODY>
</HTML>