blob: 47e2c3fabf898de5fb3bfa45b3b2be3903c659a7 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.util;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import java.text.ParseException;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.util.*;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> /**<a name="line.24"></a>
<FONT color="green">025</FONT> * &lt;p&gt;Simple utility class for String operations useful across the framework.<a name="line.25"></a>
<FONT color="green">026</FONT> * &lt;p/&gt;<a name="line.26"></a>
<FONT color="green">027</FONT> * &lt;p&gt;Some methods in this class were copied from the Spring Framework so we didn't have to re-invent the wheel,<a name="line.27"></a>
<FONT color="green">028</FONT> * and in these cases, we have retained all license, copyright and author information.<a name="line.28"></a>
<FONT color="green">029</FONT> *<a name="line.29"></a>
<FONT color="green">030</FONT> * @since 0.9<a name="line.30"></a>
<FONT color="green">031</FONT> */<a name="line.31"></a>
<FONT color="green">032</FONT> public class StringUtils {<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> //TODO - complete JavaDoc<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * Constant representing the empty string, equal to &amp;quot;&amp;quot;<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> public static final String EMPTY_STRING = "";<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> * Constant representing the default delimiter character (comma), equal to &lt;code&gt;','&lt;/code&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> */<a name="line.43"></a>
<FONT color="green">044</FONT> public static final char DEFAULT_DELIMITER_CHAR = ',';<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> /**<a name="line.46"></a>
<FONT color="green">047</FONT> * Constant representing the default quote character (double quote), equal to '&amp;quot;'&lt;/code&gt;<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> public static final char DEFAULT_QUOTE_CHAR = '"';<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> * Check whether the given String has actual text.<a name="line.52"></a>
<FONT color="green">053</FONT> * More specifically, returns &lt;code&gt;true&lt;/code&gt; if the string not &lt;code&gt;null&lt;/code&gt;,<a name="line.53"></a>
<FONT color="green">054</FONT> * its length is greater than 0, and it contains at least one non-whitespace character.<a name="line.54"></a>
<FONT color="green">055</FONT> * &lt;p/&gt;<a name="line.55"></a>
<FONT color="green">056</FONT> * &lt;code&gt;StringUtils.hasText(null) == false&lt;br/&gt;<a name="line.56"></a>
<FONT color="green">057</FONT> * StringUtils.hasText("") == false&lt;br/&gt;<a name="line.57"></a>
<FONT color="green">058</FONT> * StringUtils.hasText(" ") == false&lt;br/&gt;<a name="line.58"></a>
<FONT color="green">059</FONT> * StringUtils.hasText("12345") == true&lt;br/&gt;<a name="line.59"></a>
<FONT color="green">060</FONT> * StringUtils.hasText(" 12345 ") == true&lt;/code&gt;<a name="line.60"></a>
<FONT color="green">061</FONT> * &lt;p/&gt;<a name="line.61"></a>
<FONT color="green">062</FONT> * &lt;p&gt;Copied from the Spring Framework while retaining all license, copyright and author information.<a name="line.62"></a>
<FONT color="green">063</FONT> *<a name="line.63"></a>
<FONT color="green">064</FONT> * @param str the String to check (may be &lt;code&gt;null&lt;/code&gt;)<a name="line.64"></a>
<FONT color="green">065</FONT> * @return &lt;code&gt;true&lt;/code&gt; if the String is not &lt;code&gt;null&lt;/code&gt;, its length is<a name="line.65"></a>
<FONT color="green">066</FONT> * greater than 0, and it does not contain whitespace only<a name="line.66"></a>
<FONT color="green">067</FONT> * @see java.lang.Character#isWhitespace<a name="line.67"></a>
<FONT color="green">068</FONT> */<a name="line.68"></a>
<FONT color="green">069</FONT> public static boolean hasText(String str) {<a name="line.69"></a>
<FONT color="green">070</FONT> if (!hasLength(str)) {<a name="line.70"></a>
<FONT color="green">071</FONT> return false;<a name="line.71"></a>
<FONT color="green">072</FONT> }<a name="line.72"></a>
<FONT color="green">073</FONT> int strLen = str.length();<a name="line.73"></a>
<FONT color="green">074</FONT> for (int i = 0; i &lt; strLen; i++) {<a name="line.74"></a>
<FONT color="green">075</FONT> if (!Character.isWhitespace(str.charAt(i))) {<a name="line.75"></a>
<FONT color="green">076</FONT> return true;<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 false;<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> * Check that the given String is neither &lt;code&gt;null&lt;/code&gt; nor of length 0.<a name="line.83"></a>
<FONT color="green">084</FONT> * Note: Will return &lt;code&gt;true&lt;/code&gt; for a String that purely consists of whitespace.<a name="line.84"></a>
<FONT color="green">085</FONT> * &lt;p/&gt;<a name="line.85"></a>
<FONT color="green">086</FONT> * &lt;code&gt;StringUtils.hasLength(null) == false&lt;br/&gt;<a name="line.86"></a>
<FONT color="green">087</FONT> * StringUtils.hasLength("") == false&lt;br/&gt;<a name="line.87"></a>
<FONT color="green">088</FONT> * StringUtils.hasLength(" ") == true&lt;br/&gt;<a name="line.88"></a>
<FONT color="green">089</FONT> * StringUtils.hasLength("Hello") == true&lt;/code&gt;<a name="line.89"></a>
<FONT color="green">090</FONT> * &lt;p/&gt;<a name="line.90"></a>
<FONT color="green">091</FONT> * Copied from the Spring Framework while retaining all license, copyright and author information.<a name="line.91"></a>
<FONT color="green">092</FONT> *<a name="line.92"></a>
<FONT color="green">093</FONT> * @param str the String to check (may be &lt;code&gt;null&lt;/code&gt;)<a name="line.93"></a>
<FONT color="green">094</FONT> * @return &lt;code&gt;true&lt;/code&gt; if the String is not null and has length<a name="line.94"></a>
<FONT color="green">095</FONT> * @see #hasText(String)<a name="line.95"></a>
<FONT color="green">096</FONT> */<a name="line.96"></a>
<FONT color="green">097</FONT> public static boolean hasLength(String str) {<a name="line.97"></a>
<FONT color="green">098</FONT> return (str != null &amp;&amp; str.length() &gt; 0);<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> <a name="line.101"></a>
<FONT color="green">102</FONT> /**<a name="line.102"></a>
<FONT color="green">103</FONT> * Test if the given String starts with the specified prefix,<a name="line.103"></a>
<FONT color="green">104</FONT> * ignoring upper/lower case.<a name="line.104"></a>
<FONT color="green">105</FONT> * &lt;p/&gt;<a name="line.105"></a>
<FONT color="green">106</FONT> * &lt;p&gt;Copied from the Spring Framework while retaining all license, copyright and author information.<a name="line.106"></a>
<FONT color="green">107</FONT> *<a name="line.107"></a>
<FONT color="green">108</FONT> * @param str the String to check<a name="line.108"></a>
<FONT color="green">109</FONT> * @param prefix the prefix to look for<a name="line.109"></a>
<FONT color="green">110</FONT> * @return &lt;code&gt;true&lt;/code&gt; starts with the specified prefix (ignoring case), &lt;code&gt;false&lt;/code&gt; if it does not.<a name="line.110"></a>
<FONT color="green">111</FONT> * @see java.lang.String#startsWith<a name="line.111"></a>
<FONT color="green">112</FONT> */<a name="line.112"></a>
<FONT color="green">113</FONT> public static boolean startsWithIgnoreCase(String str, String prefix) {<a name="line.113"></a>
<FONT color="green">114</FONT> if (str == null || prefix == null) {<a name="line.114"></a>
<FONT color="green">115</FONT> return false;<a name="line.115"></a>
<FONT color="green">116</FONT> }<a name="line.116"></a>
<FONT color="green">117</FONT> if (str.startsWith(prefix)) {<a name="line.117"></a>
<FONT color="green">118</FONT> return true;<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> if (str.length() &lt; prefix.length()) {<a name="line.120"></a>
<FONT color="green">121</FONT> return false;<a name="line.121"></a>
<FONT color="green">122</FONT> }<a name="line.122"></a>
<FONT color="green">123</FONT> String lcStr = str.substring(0, prefix.length()).toLowerCase();<a name="line.123"></a>
<FONT color="green">124</FONT> String lcPrefix = prefix.toLowerCase();<a name="line.124"></a>
<FONT color="green">125</FONT> return lcStr.equals(lcPrefix);<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> * Returns a 'cleaned' representation of the specified argument. 'Cleaned' is defined as the following:<a name="line.129"></a>
<FONT color="green">130</FONT> * &lt;p/&gt;<a name="line.130"></a>
<FONT color="green">131</FONT> * &lt;ol&gt;<a name="line.131"></a>
<FONT color="green">132</FONT> * &lt;li&gt;If the specified &lt;code&gt;String&lt;/code&gt; is &lt;code&gt;null&lt;/code&gt;, return &lt;code&gt;null&lt;/code&gt;&lt;/li&gt;<a name="line.132"></a>
<FONT color="green">133</FONT> * &lt;li&gt;If not &lt;code&gt;null&lt;/code&gt;, {@link String#trim() trim()} it.&lt;/li&gt;<a name="line.133"></a>
<FONT color="green">134</FONT> * &lt;li&gt;If the trimmed string is equal to the empty String (i.e. &amp;quot;&amp;quot;), return &lt;code&gt;null&lt;/code&gt;&lt;/li&gt;<a name="line.134"></a>
<FONT color="green">135</FONT> * &lt;li&gt;If the trimmed string is not the empty string, return the trimmed version&lt;/li&gt;.<a name="line.135"></a>
<FONT color="green">136</FONT> * &lt;/ol&gt;<a name="line.136"></a>
<FONT color="green">137</FONT> * &lt;p/&gt;<a name="line.137"></a>
<FONT color="green">138</FONT> * Therefore this method always ensures that any given string has trimmed text, and if it doesn't, &lt;code&gt;null&lt;/code&gt;<a name="line.138"></a>
<FONT color="green">139</FONT> * is returned.<a name="line.139"></a>
<FONT color="green">140</FONT> *<a name="line.140"></a>
<FONT color="green">141</FONT> * @param in the input String to clean.<a name="line.141"></a>
<FONT color="green">142</FONT> * @return a populated-but-trimmed String or &lt;code&gt;null&lt;/code&gt; otherwise<a name="line.142"></a>
<FONT color="green">143</FONT> */<a name="line.143"></a>
<FONT color="green">144</FONT> public static String clean(String in) {<a name="line.144"></a>
<FONT color="green">145</FONT> String out = in;<a name="line.145"></a>
<FONT color="green">146</FONT> <a name="line.146"></a>
<FONT color="green">147</FONT> if (in != null) {<a name="line.147"></a>
<FONT color="green">148</FONT> out = in.trim();<a name="line.148"></a>
<FONT color="green">149</FONT> if (out.equals(EMPTY_STRING)) {<a name="line.149"></a>
<FONT color="green">150</FONT> out = null;<a name="line.150"></a>
<FONT color="green">151</FONT> }<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> return out;<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> <a name="line.156"></a>
<FONT color="green">157</FONT> /**<a name="line.157"></a>
<FONT color="green">158</FONT> * Returns the specified array as a comma-delimited (',') string.<a name="line.158"></a>
<FONT color="green">159</FONT> *<a name="line.159"></a>
<FONT color="green">160</FONT> * @param array the array whose contents will be converted to a string.<a name="line.160"></a>
<FONT color="green">161</FONT> * @return the array's contents as a comma-delimited (',') string.<a name="line.161"></a>
<FONT color="green">162</FONT> * @since 1.0<a name="line.162"></a>
<FONT color="green">163</FONT> */<a name="line.163"></a>
<FONT color="green">164</FONT> public static String toString(Object[] array) {<a name="line.164"></a>
<FONT color="green">165</FONT> return toDelimitedString(array, ",");<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> * Returns the array's contents as a string, with each element delimited by the specified<a name="line.169"></a>
<FONT color="green">170</FONT> * {@code delimiter} argument. Useful for {@code toString()} implementations and log messages.<a name="line.170"></a>
<FONT color="green">171</FONT> *<a name="line.171"></a>
<FONT color="green">172</FONT> * @param array the array whose contents will be converted to a string<a name="line.172"></a>
<FONT color="green">173</FONT> * @param delimiter the delimiter to use between each element<a name="line.173"></a>
<FONT color="green">174</FONT> * @return a single string, delimited by the specified {@code delimiter}.<a name="line.174"></a>
<FONT color="green">175</FONT> * @since 1.0<a name="line.175"></a>
<FONT color="green">176</FONT> */<a name="line.176"></a>
<FONT color="green">177</FONT> public static String toDelimitedString(Object[] array, String delimiter) {<a name="line.177"></a>
<FONT color="green">178</FONT> if (array == null || array.length == 0) {<a name="line.178"></a>
<FONT color="green">179</FONT> return EMPTY_STRING;<a name="line.179"></a>
<FONT color="green">180</FONT> }<a name="line.180"></a>
<FONT color="green">181</FONT> StringBuilder sb = new StringBuilder();<a name="line.181"></a>
<FONT color="green">182</FONT> for (int i = 0; i &lt; array.length; i++) {<a name="line.182"></a>
<FONT color="green">183</FONT> if (i &gt; 0) {<a name="line.183"></a>
<FONT color="green">184</FONT> sb.append(delimiter);<a name="line.184"></a>
<FONT color="green">185</FONT> }<a name="line.185"></a>
<FONT color="green">186</FONT> sb.append(array[i]);<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> return sb.toString();<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> * Returns the collection's contents as a string, with each element delimited by the specified<a name="line.192"></a>
<FONT color="green">193</FONT> * {@code delimiter} argument. Useful for {@code toString()} implementations and log messages.<a name="line.193"></a>
<FONT color="green">194</FONT> *<a name="line.194"></a>
<FONT color="green">195</FONT> * @param c the collection whose contents will be converted to a string<a name="line.195"></a>
<FONT color="green">196</FONT> * @param delimiter the delimiter to use between each element<a name="line.196"></a>
<FONT color="green">197</FONT> * @return a single string, delimited by the specified {@code delimiter}.<a name="line.197"></a>
<FONT color="green">198</FONT> * @since 1.2<a name="line.198"></a>
<FONT color="green">199</FONT> */<a name="line.199"></a>
<FONT color="green">200</FONT> public static String toDelimitedString(Collection c, String delimiter) {<a name="line.200"></a>
<FONT color="green">201</FONT> if (c == null || c.isEmpty()) {<a name="line.201"></a>
<FONT color="green">202</FONT> return EMPTY_STRING;<a name="line.202"></a>
<FONT color="green">203</FONT> }<a name="line.203"></a>
<FONT color="green">204</FONT> return join(c.iterator(), delimiter);<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> /**<a name="line.207"></a>
<FONT color="green">208</FONT> * Tokenize the given String into a String array via a StringTokenizer.<a name="line.208"></a>
<FONT color="green">209</FONT> * Trims tokens and omits empty tokens.<a name="line.209"></a>
<FONT color="green">210</FONT> * &lt;p&gt;The given delimiters string is supposed to consist of any number of<a name="line.210"></a>
<FONT color="green">211</FONT> * delimiter characters. Each of those characters can be used to separate<a name="line.211"></a>
<FONT color="green">212</FONT> * tokens. A delimiter is always a single character; for multi-character<a name="line.212"></a>
<FONT color="green">213</FONT> * delimiters, consider using &lt;code&gt;delimitedListToStringArray&lt;/code&gt;<a name="line.213"></a>
<FONT color="green">214</FONT> * &lt;p/&gt;<a name="line.214"></a>
<FONT color="green">215</FONT> * &lt;p&gt;Copied from the Spring Framework while retaining all license, copyright and author information.<a name="line.215"></a>
<FONT color="green">216</FONT> *<a name="line.216"></a>
<FONT color="green">217</FONT> * @param str the String to tokenize<a name="line.217"></a>
<FONT color="green">218</FONT> * @param delimiters the delimiter characters, assembled as String<a name="line.218"></a>
<FONT color="green">219</FONT> * (each of those characters is individually considered as delimiter).<a name="line.219"></a>
<FONT color="green">220</FONT> * @return an array of the tokens<a name="line.220"></a>
<FONT color="green">221</FONT> * @see java.util.StringTokenizer<a name="line.221"></a>
<FONT color="green">222</FONT> * @see java.lang.String#trim()<a name="line.222"></a>
<FONT color="green">223</FONT> */<a name="line.223"></a>
<FONT color="green">224</FONT> public static String[] tokenizeToStringArray(String str, String delimiters) {<a name="line.224"></a>
<FONT color="green">225</FONT> return tokenizeToStringArray(str, delimiters, true, true);<a name="line.225"></a>
<FONT color="green">226</FONT> }<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> * Tokenize the given String into a String array via a StringTokenizer.<a name="line.229"></a>
<FONT color="green">230</FONT> * &lt;p&gt;The given delimiters string is supposed to consist of any number of<a name="line.230"></a>
<FONT color="green">231</FONT> * delimiter characters. Each of those characters can be used to separate<a name="line.231"></a>
<FONT color="green">232</FONT> * tokens. A delimiter is always a single character; for multi-character<a name="line.232"></a>
<FONT color="green">233</FONT> * delimiters, consider using &lt;code&gt;delimitedListToStringArray&lt;/code&gt;<a name="line.233"></a>
<FONT color="green">234</FONT> * &lt;p/&gt;<a name="line.234"></a>
<FONT color="green">235</FONT> * &lt;p&gt;Copied from the Spring Framework while retaining all license, copyright and author information.<a name="line.235"></a>
<FONT color="green">236</FONT> *<a name="line.236"></a>
<FONT color="green">237</FONT> * @param str the String to tokenize<a name="line.237"></a>
<FONT color="green">238</FONT> * @param delimiters the delimiter characters, assembled as String<a name="line.238"></a>
<FONT color="green">239</FONT> * (each of those characters is individually considered as delimiter)<a name="line.239"></a>
<FONT color="green">240</FONT> * @param trimTokens trim the tokens via String's &lt;code&gt;trim&lt;/code&gt;<a name="line.240"></a>
<FONT color="green">241</FONT> * @param ignoreEmptyTokens omit empty tokens from the result array<a name="line.241"></a>
<FONT color="green">242</FONT> * (only applies to tokens that are empty after trimming; StringTokenizer<a name="line.242"></a>
<FONT color="green">243</FONT> * will not consider subsequent delimiters as token in the first place).<a name="line.243"></a>
<FONT color="green">244</FONT> * @return an array of the tokens (&lt;code&gt;null&lt;/code&gt; if the input String<a name="line.244"></a>
<FONT color="green">245</FONT> * was &lt;code&gt;null&lt;/code&gt;)<a name="line.245"></a>
<FONT color="green">246</FONT> * @see java.util.StringTokenizer<a name="line.246"></a>
<FONT color="green">247</FONT> * @see java.lang.String#trim()<a name="line.247"></a>
<FONT color="green">248</FONT> */<a name="line.248"></a>
<FONT color="green">249</FONT> @SuppressWarnings({"unchecked"})<a name="line.249"></a>
<FONT color="green">250</FONT> public static String[] tokenizeToStringArray(<a name="line.250"></a>
<FONT color="green">251</FONT> String str, String delimiters, boolean trimTokens, boolean ignoreEmptyTokens) {<a name="line.251"></a>
<FONT color="green">252</FONT> <a name="line.252"></a>
<FONT color="green">253</FONT> if (str == null) {<a name="line.253"></a>
<FONT color="green">254</FONT> return null;<a name="line.254"></a>
<FONT color="green">255</FONT> }<a name="line.255"></a>
<FONT color="green">256</FONT> StringTokenizer st = new StringTokenizer(str, delimiters);<a name="line.256"></a>
<FONT color="green">257</FONT> List tokens = new ArrayList();<a name="line.257"></a>
<FONT color="green">258</FONT> while (st.hasMoreTokens()) {<a name="line.258"></a>
<FONT color="green">259</FONT> String token = st.nextToken();<a name="line.259"></a>
<FONT color="green">260</FONT> if (trimTokens) {<a name="line.260"></a>
<FONT color="green">261</FONT> token = token.trim();<a name="line.261"></a>
<FONT color="green">262</FONT> }<a name="line.262"></a>
<FONT color="green">263</FONT> if (!ignoreEmptyTokens || token.length() &gt; 0) {<a name="line.263"></a>
<FONT color="green">264</FONT> tokens.add(token);<a name="line.264"></a>
<FONT color="green">265</FONT> }<a name="line.265"></a>
<FONT color="green">266</FONT> }<a name="line.266"></a>
<FONT color="green">267</FONT> return toStringArray(tokens);<a name="line.267"></a>
<FONT color="green">268</FONT> }<a name="line.268"></a>
<FONT color="green">269</FONT> <a name="line.269"></a>
<FONT color="green">270</FONT> /**<a name="line.270"></a>
<FONT color="green">271</FONT> * Copy the given Collection into a String array.<a name="line.271"></a>
<FONT color="green">272</FONT> * The Collection must contain String elements only.<a name="line.272"></a>
<FONT color="green">273</FONT> * &lt;p/&gt;<a name="line.273"></a>
<FONT color="green">274</FONT> * &lt;p&gt;Copied from the Spring Framework while retaining all license, copyright and author information.<a name="line.274"></a>
<FONT color="green">275</FONT> *<a name="line.275"></a>
<FONT color="green">276</FONT> * @param collection the Collection to copy<a name="line.276"></a>
<FONT color="green">277</FONT> * @return the String array (&lt;code&gt;null&lt;/code&gt; if the passed-in<a name="line.277"></a>
<FONT color="green">278</FONT> * Collection was &lt;code&gt;null&lt;/code&gt;)<a name="line.278"></a>
<FONT color="green">279</FONT> */<a name="line.279"></a>
<FONT color="green">280</FONT> @SuppressWarnings({"unchecked"})<a name="line.280"></a>
<FONT color="green">281</FONT> public static String[] toStringArray(Collection collection) {<a name="line.281"></a>
<FONT color="green">282</FONT> if (collection == null) {<a name="line.282"></a>
<FONT color="green">283</FONT> return null;<a name="line.283"></a>
<FONT color="green">284</FONT> }<a name="line.284"></a>
<FONT color="green">285</FONT> return (String[]) collection.toArray(new String[collection.size()]);<a name="line.285"></a>
<FONT color="green">286</FONT> }<a name="line.286"></a>
<FONT color="green">287</FONT> <a name="line.287"></a>
<FONT color="green">288</FONT> public static String[] splitKeyValue(String aLine) throws ParseException {<a name="line.288"></a>
<FONT color="green">289</FONT> String line = clean(aLine);<a name="line.289"></a>
<FONT color="green">290</FONT> if (line == null) {<a name="line.290"></a>
<FONT color="green">291</FONT> return null;<a name="line.291"></a>
<FONT color="green">292</FONT> }<a name="line.292"></a>
<FONT color="green">293</FONT> String[] split = line.split(" ", 2);<a name="line.293"></a>
<FONT color="green">294</FONT> if (split.length != 2) {<a name="line.294"></a>
<FONT color="green">295</FONT> //fallback to checking for an equals sign<a name="line.295"></a>
<FONT color="green">296</FONT> split = line.split("=", 2);<a name="line.296"></a>
<FONT color="green">297</FONT> if (split.length != 2) {<a name="line.297"></a>
<FONT color="green">298</FONT> String msg = "Unable to determine Key/Value pair from line [" + line + "]. There is no space from " +<a name="line.298"></a>
<FONT color="green">299</FONT> "which the split location could be determined.";<a name="line.299"></a>
<FONT color="green">300</FONT> throw new ParseException(msg, 0);<a name="line.300"></a>
<FONT color="green">301</FONT> }<a name="line.301"></a>
<FONT color="green">302</FONT> <a name="line.302"></a>
<FONT color="green">303</FONT> }<a name="line.303"></a>
<FONT color="green">304</FONT> <a name="line.304"></a>
<FONT color="green">305</FONT> split[0] = clean(split[0]);<a name="line.305"></a>
<FONT color="green">306</FONT> split[1] = clean(split[1]);<a name="line.306"></a>
<FONT color="green">307</FONT> if (split[1].startsWith("=")) {<a name="line.307"></a>
<FONT color="green">308</FONT> //they used spaces followed by an equals followed by zero or more spaces to split the key/value pair, so<a name="line.308"></a>
<FONT color="green">309</FONT> //remove the equals sign to result in only the key and values in the<a name="line.309"></a>
<FONT color="green">310</FONT> split[1] = clean(split[1].substring(1));<a name="line.310"></a>
<FONT color="green">311</FONT> }<a name="line.311"></a>
<FONT color="green">312</FONT> <a name="line.312"></a>
<FONT color="green">313</FONT> if (split[0] == null) {<a name="line.313"></a>
<FONT color="green">314</FONT> String msg = "No valid key could be found in line [" + line + "] to form a key/value pair.";<a name="line.314"></a>
<FONT color="green">315</FONT> throw new ParseException(msg, 0);<a name="line.315"></a>
<FONT color="green">316</FONT> }<a name="line.316"></a>
<FONT color="green">317</FONT> if (split[1] == null) {<a name="line.317"></a>
<FONT color="green">318</FONT> String msg = "No corresponding value could be found in line [" + line + "] for key [" + split[0] + "]";<a name="line.318"></a>
<FONT color="green">319</FONT> throw new ParseException(msg, 0);<a name="line.319"></a>
<FONT color="green">320</FONT> }<a name="line.320"></a>
<FONT color="green">321</FONT> <a name="line.321"></a>
<FONT color="green">322</FONT> return split;<a name="line.322"></a>
<FONT color="green">323</FONT> }<a name="line.323"></a>
<FONT color="green">324</FONT> <a name="line.324"></a>
<FONT color="green">325</FONT> public static String[] split(String line) {<a name="line.325"></a>
<FONT color="green">326</FONT> return split(line, DEFAULT_DELIMITER_CHAR);<a name="line.326"></a>
<FONT color="green">327</FONT> }<a name="line.327"></a>
<FONT color="green">328</FONT> <a name="line.328"></a>
<FONT color="green">329</FONT> public static String[] split(String line, char delimiter) {<a name="line.329"></a>
<FONT color="green">330</FONT> return split(line, delimiter, DEFAULT_QUOTE_CHAR);<a name="line.330"></a>
<FONT color="green">331</FONT> }<a name="line.331"></a>
<FONT color="green">332</FONT> <a name="line.332"></a>
<FONT color="green">333</FONT> public static String[] split(String line, char delimiter, char quoteChar) {<a name="line.333"></a>
<FONT color="green">334</FONT> return split(line, delimiter, quoteChar, quoteChar);<a name="line.334"></a>
<FONT color="green">335</FONT> }<a name="line.335"></a>
<FONT color="green">336</FONT> <a name="line.336"></a>
<FONT color="green">337</FONT> public static String[] split(String line, char delimiter, char beginQuoteChar, char endQuoteChar) {<a name="line.337"></a>
<FONT color="green">338</FONT> return split(line, delimiter, beginQuoteChar, endQuoteChar, false, true);<a name="line.338"></a>
<FONT color="green">339</FONT> }<a name="line.339"></a>
<FONT color="green">340</FONT> <a name="line.340"></a>
<FONT color="green">341</FONT> /**<a name="line.341"></a>
<FONT color="green">342</FONT> * Splits the specified delimited String into tokens, supporting quoted tokens so that quoted strings themselves<a name="line.342"></a>
<FONT color="green">343</FONT> * won't be tokenized.<a name="line.343"></a>
<FONT color="green">344</FONT> * &lt;p/&gt;<a name="line.344"></a>
<FONT color="green">345</FONT> * This method's implementation is very loosely based (with significant modifications) on<a name="line.345"></a>
<FONT color="green">346</FONT> * &lt;a href="http://blogs.bytecode.com.au/glen"&gt;Glen Smith&lt;/a&gt;'s open-source<a name="line.346"></a>
<FONT color="green">347</FONT> * &lt;a href="http://opencsv.svn.sourceforge.net/viewvc/opencsv/trunk/src/au/com/bytecode/opencsv/CSVReader.java?&amp;view=markup"&gt;CSVReader.java&lt;/a&gt;<a name="line.347"></a>
<FONT color="green">348</FONT> * file.<a name="line.348"></a>
<FONT color="green">349</FONT> * &lt;p/&gt;<a name="line.349"></a>
<FONT color="green">350</FONT> * That file is Apache 2.0 licensed as well, making Glen's code a great starting point for us to modify to<a name="line.350"></a>
<FONT color="green">351</FONT> * our needs.<a name="line.351"></a>
<FONT color="green">352</FONT> *<a name="line.352"></a>
<FONT color="green">353</FONT> * @param aLine the String to parse<a name="line.353"></a>
<FONT color="green">354</FONT> * @param delimiter the delimiter by which the &lt;tt&gt;line&lt;/tt&gt; argument is to be split<a name="line.354"></a>
<FONT color="green">355</FONT> * @param beginQuoteChar the character signifying the start of quoted text (so the quoted text will not be split)<a name="line.355"></a>
<FONT color="green">356</FONT> * @param endQuoteChar the character signifying the end of quoted text<a name="line.356"></a>
<FONT color="green">357</FONT> * @param retainQuotes if the quotes themselves should be retained when constructing the corresponding token<a name="line.357"></a>
<FONT color="green">358</FONT> * @param trimTokens if leading and trailing whitespace should be trimmed from discovered tokens.<a name="line.358"></a>
<FONT color="green">359</FONT> * @return the tokens discovered from parsing the given delimited &lt;tt&gt;line&lt;/tt&gt;.<a name="line.359"></a>
<FONT color="green">360</FONT> */<a name="line.360"></a>
<FONT color="green">361</FONT> public static String[] split(String aLine, char delimiter, char beginQuoteChar, char endQuoteChar,<a name="line.361"></a>
<FONT color="green">362</FONT> boolean retainQuotes, boolean trimTokens) {<a name="line.362"></a>
<FONT color="green">363</FONT> String line = clean(aLine);<a name="line.363"></a>
<FONT color="green">364</FONT> if (line == null) {<a name="line.364"></a>
<FONT color="green">365</FONT> return null;<a name="line.365"></a>
<FONT color="green">366</FONT> }<a name="line.366"></a>
<FONT color="green">367</FONT> <a name="line.367"></a>
<FONT color="green">368</FONT> List&lt;String&gt; tokens = new ArrayList&lt;String&gt;();<a name="line.368"></a>
<FONT color="green">369</FONT> StringBuilder sb = new StringBuilder();<a name="line.369"></a>
<FONT color="green">370</FONT> boolean inQuotes = false;<a name="line.370"></a>
<FONT color="green">371</FONT> <a name="line.371"></a>
<FONT color="green">372</FONT> for (int i = 0; i &lt; line.length(); i++) {<a name="line.372"></a>
<FONT color="green">373</FONT> <a name="line.373"></a>
<FONT color="green">374</FONT> char c = line.charAt(i);<a name="line.374"></a>
<FONT color="green">375</FONT> if (c == beginQuoteChar) {<a name="line.375"></a>
<FONT color="green">376</FONT> // this gets complex... the quote may end a quoted block, or escape another quote.<a name="line.376"></a>
<FONT color="green">377</FONT> // do a 1-char lookahead:<a name="line.377"></a>
<FONT color="green">378</FONT> if (inQuotes // we are in quotes, therefore there can be escaped quotes in here.<a name="line.378"></a>
<FONT color="green">379</FONT> &amp;&amp; line.length() &gt; (i + 1) // there is indeed another character to check.<a name="line.379"></a>
<FONT color="green">380</FONT> &amp;&amp; line.charAt(i + 1) == beginQuoteChar) { // ..and that char. is a quote also.<a name="line.380"></a>
<FONT color="green">381</FONT> // we have two quote chars in a row == one quote char, so consume them both and<a name="line.381"></a>
<FONT color="green">382</FONT> // put one on the token. we do *not* exit the quoted text.<a name="line.382"></a>
<FONT color="green">383</FONT> sb.append(line.charAt(i + 1));<a name="line.383"></a>
<FONT color="green">384</FONT> i++;<a name="line.384"></a>
<FONT color="green">385</FONT> } else {<a name="line.385"></a>
<FONT color="green">386</FONT> inQuotes = !inQuotes;<a name="line.386"></a>
<FONT color="green">387</FONT> if (retainQuotes) {<a name="line.387"></a>
<FONT color="green">388</FONT> sb.append(c);<a name="line.388"></a>
<FONT color="green">389</FONT> }<a name="line.389"></a>
<FONT color="green">390</FONT> }<a name="line.390"></a>
<FONT color="green">391</FONT> } else if (c == endQuoteChar) {<a name="line.391"></a>
<FONT color="green">392</FONT> inQuotes = !inQuotes;<a name="line.392"></a>
<FONT color="green">393</FONT> if (retainQuotes) {<a name="line.393"></a>
<FONT color="green">394</FONT> sb.append(c);<a name="line.394"></a>
<FONT color="green">395</FONT> }<a name="line.395"></a>
<FONT color="green">396</FONT> } else if (c == delimiter &amp;&amp; !inQuotes) {<a name="line.396"></a>
<FONT color="green">397</FONT> String s = sb.toString();<a name="line.397"></a>
<FONT color="green">398</FONT> if (trimTokens) {<a name="line.398"></a>
<FONT color="green">399</FONT> s = s.trim();<a name="line.399"></a>
<FONT color="green">400</FONT> }<a name="line.400"></a>
<FONT color="green">401</FONT> tokens.add(s);<a name="line.401"></a>
<FONT color="green">402</FONT> sb = new StringBuilder(); // start work on next token<a name="line.402"></a>
<FONT color="green">403</FONT> } else {<a name="line.403"></a>
<FONT color="green">404</FONT> sb.append(c);<a name="line.404"></a>
<FONT color="green">405</FONT> }<a name="line.405"></a>
<FONT color="green">406</FONT> }<a name="line.406"></a>
<FONT color="green">407</FONT> String s = sb.toString();<a name="line.407"></a>
<FONT color="green">408</FONT> if (trimTokens) {<a name="line.408"></a>
<FONT color="green">409</FONT> s = s.trim();<a name="line.409"></a>
<FONT color="green">410</FONT> }<a name="line.410"></a>
<FONT color="green">411</FONT> tokens.add(s);<a name="line.411"></a>
<FONT color="green">412</FONT> return tokens.toArray(new String[tokens.size()]);<a name="line.412"></a>
<FONT color="green">413</FONT> }<a name="line.413"></a>
<FONT color="green">414</FONT> <a name="line.414"></a>
<FONT color="green">415</FONT> /**<a name="line.415"></a>
<FONT color="green">416</FONT> * Joins the elements of the provided {@code Iterator} into<a name="line.416"></a>
<FONT color="green">417</FONT> * a single String containing the provided elements.&lt;/p&gt;<a name="line.417"></a>
<FONT color="green">418</FONT> * &lt;p/&gt;<a name="line.418"></a>
<FONT color="green">419</FONT> * No delimiter is added before or after the list.<a name="line.419"></a>
<FONT color="green">420</FONT> * A {@code null} separator is the same as an empty String ("").&lt;/p&gt;<a name="line.420"></a>
<FONT color="green">421</FONT> * &lt;p/&gt;<a name="line.421"></a>
<FONT color="green">422</FONT> * Copied from Commons Lang, version 3 (r1138702).&lt;/p&gt;<a name="line.422"></a>
<FONT color="green">423</FONT> *<a name="line.423"></a>
<FONT color="green">424</FONT> * @param iterator the {@code Iterator} of values to join together, may be null<a name="line.424"></a>
<FONT color="green">425</FONT> * @param separator the separator character to use, null treated as ""<a name="line.425"></a>
<FONT color="green">426</FONT> * @return the joined String, {@code null} if null iterator input<a name="line.426"></a>
<FONT color="green">427</FONT> * @since 1.2<a name="line.427"></a>
<FONT color="green">428</FONT> */<a name="line.428"></a>
<FONT color="green">429</FONT> public static String join(Iterator&lt;?&gt; iterator, String separator) {<a name="line.429"></a>
<FONT color="green">430</FONT> final String empty = "";<a name="line.430"></a>
<FONT color="green">431</FONT> <a name="line.431"></a>
<FONT color="green">432</FONT> // handle null, zero and one elements before building a buffer<a name="line.432"></a>
<FONT color="green">433</FONT> if (iterator == null) {<a name="line.433"></a>
<FONT color="green">434</FONT> return null;<a name="line.434"></a>
<FONT color="green">435</FONT> }<a name="line.435"></a>
<FONT color="green">436</FONT> if (!iterator.hasNext()) {<a name="line.436"></a>
<FONT color="green">437</FONT> return empty;<a name="line.437"></a>
<FONT color="green">438</FONT> }<a name="line.438"></a>
<FONT color="green">439</FONT> Object first = iterator.next();<a name="line.439"></a>
<FONT color="green">440</FONT> if (!iterator.hasNext()) {<a name="line.440"></a>
<FONT color="green">441</FONT> return first == null ? empty : first.toString();<a name="line.441"></a>
<FONT color="green">442</FONT> }<a name="line.442"></a>
<FONT color="green">443</FONT> <a name="line.443"></a>
<FONT color="green">444</FONT> // two or more elements<a name="line.444"></a>
<FONT color="green">445</FONT> StringBuilder buf = new StringBuilder(256); // Java default is 16, probably too small<a name="line.445"></a>
<FONT color="green">446</FONT> if (first != null) {<a name="line.446"></a>
<FONT color="green">447</FONT> buf.append(first);<a name="line.447"></a>
<FONT color="green">448</FONT> }<a name="line.448"></a>
<FONT color="green">449</FONT> <a name="line.449"></a>
<FONT color="green">450</FONT> while (iterator.hasNext()) {<a name="line.450"></a>
<FONT color="green">451</FONT> if (separator != null) {<a name="line.451"></a>
<FONT color="green">452</FONT> buf.append(separator);<a name="line.452"></a>
<FONT color="green">453</FONT> }<a name="line.453"></a>
<FONT color="green">454</FONT> Object obj = iterator.next();<a name="line.454"></a>
<FONT color="green">455</FONT> if (obj != null) {<a name="line.455"></a>
<FONT color="green">456</FONT> buf.append(obj);<a name="line.456"></a>
<FONT color="green">457</FONT> }<a name="line.457"></a>
<FONT color="green">458</FONT> }<a name="line.458"></a>
<FONT color="green">459</FONT> return buf.toString();<a name="line.459"></a>
<FONT color="green">460</FONT> }<a name="line.460"></a>
<FONT color="green">461</FONT> <a name="line.461"></a>
<FONT color="green">462</FONT> /**<a name="line.462"></a>
<FONT color="green">463</FONT> * Splits the {@code delimited} string (delimited by the specified {@code separator} character) and returns the<a name="line.463"></a>
<FONT color="green">464</FONT> * delimited values as a {@code Set}.<a name="line.464"></a>
<FONT color="green">465</FONT> * &lt;p/&gt;<a name="line.465"></a>
<FONT color="green">466</FONT> * If either argument is {@code null}, this method returns {@code null}.<a name="line.466"></a>
<FONT color="green">467</FONT> *<a name="line.467"></a>
<FONT color="green">468</FONT> * @param delimited the string to split<a name="line.468"></a>
<FONT color="green">469</FONT> * @param separator the character that delineates individual tokens to split<a name="line.469"></a>
<FONT color="green">470</FONT> * @return the delimited values as a {@code Set}.<a name="line.470"></a>
<FONT color="green">471</FONT> * @since 1.2<a name="line.471"></a>
<FONT color="green">472</FONT> */<a name="line.472"></a>
<FONT color="green">473</FONT> public static Set&lt;String&gt; splitToSet(String delimited, String separator) {<a name="line.473"></a>
<FONT color="green">474</FONT> if (delimited == null || separator == null) {<a name="line.474"></a>
<FONT color="green">475</FONT> return null;<a name="line.475"></a>
<FONT color="green">476</FONT> }<a name="line.476"></a>
<FONT color="green">477</FONT> String[] split = split(delimited, separator.charAt(0));<a name="line.477"></a>
<FONT color="green">478</FONT> return CollectionUtils.asSet(split);<a name="line.478"></a>
<FONT color="green">479</FONT> }<a name="line.479"></a>
<FONT color="green">480</FONT> <a name="line.480"></a>
<FONT color="green">481</FONT> /**<a name="line.481"></a>
<FONT color="green">482</FONT> * Returns the input argument, but ensures the first character is capitalized (if possible).<a name="line.482"></a>
<FONT color="green">483</FONT> * @param in the string to uppercase the first character.<a name="line.483"></a>
<FONT color="green">484</FONT> * @return the input argument, but with the first character capitalized (if possible).<a name="line.484"></a>
<FONT color="green">485</FONT> * @since 1.2<a name="line.485"></a>
<FONT color="green">486</FONT> */<a name="line.486"></a>
<FONT color="green">487</FONT> public static String uppercaseFirstChar(String in) {<a name="line.487"></a>
<FONT color="green">488</FONT> if (in == null || in.length() == 0) {<a name="line.488"></a>
<FONT color="green">489</FONT> return in;<a name="line.489"></a>
<FONT color="green">490</FONT> }<a name="line.490"></a>
<FONT color="green">491</FONT> int length = in.length();<a name="line.491"></a>
<FONT color="green">492</FONT> StringBuilder sb = new StringBuilder(length);<a name="line.492"></a>
<FONT color="green">493</FONT> <a name="line.493"></a>
<FONT color="green">494</FONT> sb.append(Character.toUpperCase(in.charAt(0)));<a name="line.494"></a>
<FONT color="green">495</FONT> if (length &gt; 1) {<a name="line.495"></a>
<FONT color="green">496</FONT> String remaining = in.substring(1);<a name="line.496"></a>
<FONT color="green">497</FONT> sb.append(remaining);<a name="line.497"></a>
<FONT color="green">498</FONT> }<a name="line.498"></a>
<FONT color="green">499</FONT> return sb.toString();<a name="line.499"></a>
<FONT color="green">500</FONT> }<a name="line.500"></a>
<FONT color="green">501</FONT> <a name="line.501"></a>
<FONT color="green">502</FONT> }<a name="line.502"></a>
</PRE>
</BODY>
</HTML>