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