GrepCode: org.springframework.util.StringUtils (.java) - Class

Maven-Central
/
org.springframework / spring-core
/
2.5.6

3.1.1.RELEASE
3.0.6.RELEASE
3.0.5.RELEASE
3.0.4.RELEASE
3.0.3.RELEASE
3.0.2.RELEASE
3.0.1.RELEASE
3.0.0.RELEASE
2.5.6
2.5.6.SEC03
2.5.6.SEC02
2.5.5
2.5.4
2.5.3
2.5.2
2.5.1
1.2.1
/
org.springframework.util.StringUtils
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Q&A
Stack Overflow Questions
1. Hidden features of Spring framework?
After seeing many hidden features about programming language, i would like to know hidden features of Spring "de facto" framework. As you know, Spring documentation hides many features and would be nice to share it. And you: what hidden feature of Spring framework do you know ?
2. Clearest way to comma-delimit a list (Java)?
Using a comma is just to make it specific - it could be any delimiter, so using List's default toString() doesn't help. (The question could be rephrased as: "best way to implement List's toString?") This is a well-known problem, and I know several ways of doing it, but I'm wondering what the best way is (where "best" means clearest and/or shortest, not most efficient). The problem as a story...
3. CSS text-transform not sending upper case to Business Layer
I created a simple markup such as this. <html> <head> <head> <body> <input type="text" style="text-transform:uppercase" /> </body> </html> I was assuming that the browser will capitalize all inputs and indeed it was transformed In my business layer, I am assuming that browser will send the form data on Upper case format also ...
1
   /*
2
    * Copyright 2002-2008 the original author or authors.
3
    *
4
    * Licensed under the Apache License, Version 2.0 (the "License");
5
    * you may not use this file except in compliance with the License.
6
    * You may obtain a copy of the License at
7
    *
8
    *      http://www.apache.org/licenses/LICENSE-2.0
9
    *
10
   * Unless required by applicable law or agreed to in writing, software
11
   * distributed under the License is distributed on an "AS IS" BASIS,
12
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
   * See the License for the specific language governing permissions and
14
   * limitations under the License.
15
   */
16
  
17
  package org.springframework.util;
18
  
19
  import java.util.ArrayList;
20
  import java.util.Arrays;
21
  import java.util.Collection;
22
  import java.util.Collections;
23
  import java.util.Enumeration;
24
  import java.util.Iterator;
25
  import java.util.LinkedList;
26
  import java.util.List;
27
  import java.util.Locale;
28
  import java.util.Properties;
29
  import java.util.Set;
30
  import java.util.StringTokenizer;
31
  import java.util.TreeSet;

 Miscellaneous java.lang.String utility methods.

 Mainly for internal use within the framework; consider
 Jakarta's Commons Lang
 for a more comprehensive suite of String utilities.

 
This class delivers some simple functionality that should really
 be provided by the core Java String and java.lang.StringBuffer
 classes, such as the ability to replace(java.lang.String,java.lang.String,java.lang.String) all occurrences of a given
 substring in a target string. It also provides easy-to-use methods to convert
 between delimited strings, such as CSV strings, and collections and arrays.

 
 Author(s):Rod JohnsonJuergen HoellerKeith DonaldRob HarropRick Evans Since:16 April 2001 See also:org.apache.commons.lang.StringUtils
53
  
54
  public abstract class StringUtils {
55
  
56
  	private static final String FOLDER_SEPARATOR = "/";
57
  
58
  	private static final String WINDOWS_FOLDER_SEPARATOR = "\\";
59
  
60
  	private static final String TOP_PATH = "..";
61
  
62
  	private static final String CURRENT_PATH = ".";
63
  
64
  	private static final char EXTENSION_SEPARATOR = '.';
65
  
66
  
67
  	//---------------------------------------------------------------------
68
  	// General convenience methods for working with Strings
69
  	//---------------------------------------------------------------------
70
  
	
 Check that the given CharSequence is neither null nor of length 0.
 Note: Will return true for a CharSequence that purely consists of whitespace.
 
 StringUtils.hasLength(null) = false
 StringUtils.hasLength("") = false
 StringUtils.hasLength(" ") = true
 StringUtils.hasLength("Hello") = true
 
 Parameters:str the CharSequence to check (may be null) Returns:true if the CharSequence is not null and has length See also:hasText(java.lang.String)
83
  
84
  	public static boolean hasLength(CharSequence str) {
85
  		return (str != null && str.length() > 0);
86
  	}

	
 Check that the given String is neither null nor of length 0.
 Note: Will return true for a String that purely consists of whitespace.
 
 Parameters:str the String to check (may be null) Returns:true if the String is not null and has length See also:hasLength(java.lang.CharSequence)
94
  
95
  	public static boolean hasLength(String str) {
96
  		return hasLength((CharSequence) str);
97
  	}

	
 Check whether the given CharSequence has actual text.
 More specifically, returns true if the string not null,
 its length is greater than 0, and it contains at least one non-whitespace character.
 
 StringUtils.hasText(null) = false
 StringUtils.hasText("") = false
 StringUtils.hasText(" ") = false
 StringUtils.hasText("12345") = true
 StringUtils.hasText(" 12345 ") = true
 
 Parameters:str the CharSequence to check (may be null) Returns:true if the CharSequence is not null,
 its length is greater than 0, and it does not contain whitespace only See also:java.lang.Character.isWhitespace(char)
114
 
115
 	public static boolean hasText(CharSequence str) {
116
 		if (!hasLength(str)) {
117
 			return false;
118
 		}
119
 		int strLen = str.length();
120
 		for (int i = 0; i < strLen; i++) {
121
 			if (!Character.isWhitespace(str.charAt(i))) {
122
 				return true;
123
 			}
124
 		}
125
 		return false;
126
 	}

	
 Check whether the given String has actual text.
 More specifically, returns true if the string not null,
 its length is greater than 0, and it contains at least one non-whitespace character.
 
 Parameters:str the String to check (may be null) Returns:true if the String is not null, its length is
 greater than 0, and it does not contain whitespace only See also:hasText(java.lang.CharSequence)
136
 
137
 	public static boolean hasText(String str) {
138
 		return hasText((CharSequence) str);
139
 	}

	
 Check whether the given CharSequence contains any whitespace characters.
 
 Parameters:str the CharSequence to check (may be null) Returns:true if the CharSequence is not empty and
 contains at least 1 whitespace character See also:java.lang.Character.isWhitespace(char)
147
 
148
 	public static boolean containsWhitespace(CharSequence str) {
149
 		if (!hasLength(str)) {
150
 			return false;
151
 		}
152
 		int strLen = str.length();
153
 		for (int i = 0; i < strLen; i++) {
154
 			if (Character.isWhitespace(str.charAt(i))) {
155
 				return true;
156
 			}
157
 		}
158
 		return false;
159
 	}

	
 Check whether the given String contains any whitespace characters.
 
 Parameters:str the String to check (may be null) Returns:true if the String is not empty and
 contains at least 1 whitespace character See also:containsWhitespace(java.lang.CharSequence)
167
 
168
 	public static boolean containsWhitespace(String str) {
169
 		return containsWhitespace((CharSequence) str);
170
 	}

	
 Trim leading and trailing whitespace from the given String.
 
 Parameters:str the String to check Returns:the trimmed String See also:java.lang.Character.isWhitespace(char)
177
 
178
 	public static String trimWhitespace(String str) {
179
 		if (!hasLength(str)) {
180
 			return str;
181
 		}
182
 		StringBuffer buf = new StringBuffer(str);
183
 		while (buf.length() > 0 && Character.isWhitespace(buf.charAt(0))) {
184
 			buf.deleteCharAt(0);
185
 		}
186
 		while (buf.length() > 0 && Character.isWhitespace(buf.charAt(buf.length() - 1))) {
187
 			buf.deleteCharAt(buf.length() - 1);
188
 		}
189
 		return buf.toString();
190
 	}

	
 Trim all whitespace from the given String:
 leading, trailing, and inbetween characters.
 
 Parameters:str the String to check Returns:the trimmed String See also:java.lang.Character.isWhitespace(char)
198
 
199
 	public static String trimAllWhitespace(String str) {
200
 		if (!hasLength(str)) {
201
 			return str;
202
 		}
203
 		StringBuffer buf = new StringBuffer(str);
204
 		int index = 0;
205
 		while (buf.length() > index) {
206
 			if (Character.isWhitespace(buf.charAt(index))) {
207
 				buf.deleteCharAt(index);
208
 			}
209
 			else {
210
 				index++;
211
 			}
212
 		}
213
 		return buf.toString();
214
 	}

	
 Trim leading whitespace from the given String.
 
 Parameters:str the String to check Returns:the trimmed String See also:java.lang.Character.isWhitespace(char)
221
 
222
 	public static String trimLeadingWhitespace(String str) {
223
 		if (!hasLength(str)) {
224
 			return str;
225
 		}
226
 		StringBuffer buf = new StringBuffer(str);
227
 		while (buf.length() > 0 && Character.isWhitespace(buf.charAt(0))) {
228
 			buf.deleteCharAt(0);
229
 		}
230
 		return buf.toString();
231
 	}

	
 Trim trailing whitespace from the given String.
 
 Parameters:str the String to check Returns:the trimmed String See also:java.lang.Character.isWhitespace(char)
238
 
239
 	public static String trimTrailingWhitespace(String str) {
240
 		if (!hasLength(str)) {
241
 			return str;
242
 		}
243
 		StringBuffer buf = new StringBuffer(str);
244
 		while (buf.length() > 0 && Character.isWhitespace(buf.charAt(buf.length() - 1))) {
245
 			buf.deleteCharAt(buf.length() - 1);
246
 		}
247
 		return buf.toString();
248
 	}

	
 Trim all occurences of the supplied leading character from the given String.
 
 Parameters:str the String to checkleadingCharacter the leading character to be trimmed Returns:the trimmed String
255
 
256
 	public static String trimLeadingCharacter(String str, char leadingCharacter) {
257
 		if (!hasLength(str)) {
258
 			return str;
259
 		}
260
 		StringBuffer buf = new StringBuffer(str);
261
 		while (buf.length() > 0 && buf.charAt(0) == leadingCharacter) {
262
 			buf.deleteCharAt(0);
263
 		}
264
 		return buf.toString();
265
 	}

	
 Trim all occurences of the supplied trailing character from the given String.
 
 Parameters:str the String to checktrailingCharacter the trailing character to be trimmed Returns:the trimmed String
272
 
273
 	public static String trimTrailingCharacter(String str, char trailingCharacter) {
274
 		if (!hasLength(str)) {
275
 			return str;
276
 		}
277
 		StringBuffer buf = new StringBuffer(str);
278
 		while (buf.length() > 0 && buf.charAt(buf.length() - 1) == trailingCharacter) {
279
 			buf.deleteCharAt(buf.length() - 1);
280
 		}
281
 		return buf.toString();
282
 	}


	
 Test if the given String starts with the specified prefix,
 ignoring upper/lower case.
 
 Parameters:str the String to checkprefix the prefix to look for See also:java.lang.String.startsWith(java.lang.String)
291
 
292
 	public static boolean startsWithIgnoreCase(String str, String prefix) {
293
 		if (str == null || prefix == null) {
294
 			return false;
295
 		}
296
 		if (str.startsWith(prefix)) {
297
 			return true;
298
 		}
299
 		if (str.length() < prefix.length()) {
300
 			return false;
301
 		}
302
 		String lcStr = str.substring(0, prefix.length()).toLowerCase();
303
 		String lcPrefix = prefix.toLowerCase();
304
 		return lcStr.equals(lcPrefix);
305
 	}

	
 Test if the given String ends with the specified suffix,
 ignoring upper/lower case.
 
 Parameters:str the String to checksuffix the suffix to look for See also:java.lang.String.endsWith(java.lang.String)
313
 
314
 	public static boolean endsWithIgnoreCase(String str, String suffix) {
315
 		if (str == null || suffix == null) {
316
 			return false;
317
 		}
318
 		if (str.endsWith(suffix)) {
319
 			return true;
320
 		}
321
 		if (str.length() < suffix.length()) {
322
 			return false;
323
 		}
324
 
325
 		String lcStr = str.substring(str.length() - suffix.length()).toLowerCase();
326
 		String lcSuffix = suffix.toLowerCase();
327
 		return lcStr.equals(lcSuffix);
328
 	}

	
 Test whether the given string matches the given substring
 at the given index.
 
 Parameters:str the original string (or StringBuffer)index the index in the original string to start matching againstsubstring the substring to match at the given index
336
 
337
 	public static boolean substringMatch(CharSequence str, int index, CharSequence substring) {
338
 		for (int j = 0; j < substring.length(); j++) {
339
 			int i = index + j;
340
 			if (i >= str.length() || str.charAt(i) != substring.charAt(j)) {
341
 				return false;
342
 			}
343
 		}
344
 		return true;
345
 	}

	
 Count the occurrences of the substring in string s.
 
 Parameters:str string to search in. Return 0 if this is null.sub string to search for. Return 0 if this is null.
351
 
352
 	public static int countOccurrencesOf(String str, String sub) {
353
 		if (str == null || sub == null || str.length() == 0 || sub.length() == 0) {
354
 			return 0;
355
 		}
356
 		int count = 0, pos = 0, idx = 0;
357
 		while ((idx = str.indexOf(sub, pos)) != -1) {
358
 			++count;
359
 			pos = idx + sub.length();
360
 		}
361
 		return count;
362
 	}

	
 Replace all occurences of a substring within a string with
 another string.
 
 Parameters:inString String to examineoldPattern String to replacenewPattern String to insert Returns:a String with the replacements
371
 
372
 	public static String replace(String inString, String oldPattern, String newPattern) {
373
 		if (!hasLength(inString) || !hasLength(oldPattern) || newPattern == null) {
374
 			return inString;
375
 		}
376
 		StringBuffer sbuf = new StringBuffer();
377
 		// output StringBuffer we'll build up
378
 		int pos = 0; // our position in the old string
379
 		int index = inString.indexOf(oldPattern);
380
 		// the index of an occurrence we've found, or -1
381
 		int patLen = oldPattern.length();
382
 		while (index >= 0) {
383
 			sbuf.append(inString.substring(pos, index));
384
 			sbuf.append(newPattern);
385
 			pos = index + patLen;
386
 			index = inString.indexOf(oldPattern, pos);
387
 		}
388
 		sbuf.append(inString.substring(pos));
389
 		// remember to append any characters to the right of a match
390
 		return sbuf.toString();
391
 	}

	
 Delete all occurrences of the given substring.
 
 Parameters:inString the original Stringpattern the pattern to delete all occurrences of Returns:the resulting String
398
 
399
 	public static String delete(String inString, String pattern) {
400
 		return replace(inString, pattern, "");
401
 	}

	
 Delete any character in a given String.
 
 Parameters:inString the original StringcharsToDelete a set of characters to delete.
 E.g. "az\n" will delete 'a's, 'z's and new lines. Returns:the resulting String
409
 
410
 	public static String deleteAny(String inString, String charsToDelete) {
411
 		if (!hasLength(inString) || !hasLength(charsToDelete)) {
412
 			return inString;
413
 		}
414
 		StringBuffer out = new StringBuffer();
415
 		for (int i = 0; i < inString.length(); i++) {
416
 			char c = inString.charAt(i);
417
 			if (charsToDelete.indexOf(c) == -1) {
418
 				out.append(c);
419
 			}
420
 		}
421
 		return out.toString();
422
 	}
423
 
424
 
425
 	//---------------------------------------------------------------------
426
 	// Convenience methods for working with formatted Strings
427
 	//---------------------------------------------------------------------
428
 
	
 Quote the given String with single quotes.
 
 Parameters:str the input String (e.g. "myString") Returns:the quoted String (e.g. "'myString'"),
 or null if the input was null
434
 
435
 	public static String quote(String str) {
436
 		return (str != null ? "'" + str + "'" : null);
437
 	}

	
 Turn the given Object into a String with single quotes
 if it is a String; keeping the Object as-is else.
 
 Parameters:obj the input Object (e.g. "myString") Returns:the quoted String (e.g. "'myString'"),
 or the input object as-is if not a String
445
 
446
 	public static Object quoteIfString(Object obj) {
447
 		return (obj instanceof String ? quote((String) obj) : obj);
448
 	}

	
 Unqualify a string qualified by a '.' dot character. For example,
 "this.name.is.qualified", returns "qualified".
 
 Parameters:qualifiedName the qualified name
454
 
455
 	public static String unqualify(String qualifiedName) {
456
 		return unqualify(qualifiedName, '.');
457
 	}

	
 Unqualify a string qualified by a separator character. For example,
 "this:name:is:qualified" returns "qualified" if using a ':' separator.
 
 Parameters:qualifiedName the qualified nameseparator the separator
464
 
465
 	public static String unqualify(String qualifiedName, char separator) {
466
 		return qualifiedName.substring(qualifiedName.lastIndexOf(separator) + 1);
467
 	}

	
 Capitalize a String, changing the first letter to
 upper case as per java.lang.Character.toUpperCase(char).
 No other letters are changed.
 
 Parameters:str the String to capitalize, may be null Returns:the capitalized String, null if null
475
 
476
 	public static String capitalize(String str) {
477
 		return changeFirstCharacterCase(str, true);
478
 	}

	
 Uncapitalize a String, changing the first letter to
 lower case as per java.lang.Character.toLowerCase(char).
 No other letters are changed.
 
 Parameters:str the String to uncapitalize, may be null Returns:the uncapitalized String, null if null
486
 
487
 	public static String uncapitalize(String str) {
488
 		return changeFirstCharacterCase(str, false);
489
 	}
490
 
491
 	private static String changeFirstCharacterCase(String str, boolean capitalize) {
492
 		if (str == null || str.length() == 0) {
493
 			return str;
494
 		}
495
 		StringBuffer buf = new StringBuffer(str.length());
496
 		if (capitalize) {
497
 			buf.append(Character.toUpperCase(str.charAt(0)));
498
 		}
499
 		else {
500
 			buf.append(Character.toLowerCase(str.charAt(0)));
501
 		}
502
 		buf.append(str.substring(1));
503
 		return buf.toString();
504
 	}

	
 Extract the filename from the given path,
 e.g. "mypath/myfile.txt" -> "myfile.txt".
 
 Parameters:path the file path (may be null) Returns:the extracted filename, or null if none
511
 
512
 	public static String getFilename(String path) {
513
 		if (path == null) {
514
 			return null;
515
 		}
516
 		int separatorIndex = path.lastIndexOf(FOLDER_SEPARATOR);
517
 		return (separatorIndex != -1 ? path.substring(separatorIndex + 1) : path);
518
 	}

	
 Extract the filename extension from the given path,
 e.g. "mypath/myfile.txt" -> "txt".
 
 Parameters:path the file path (may be null) Returns:the extracted filename extension, or null if none
525
 
526
 	public static String getFilenameExtension(String path) {
527
 		if (path == null) {
528
 			return null;
529
 		}
530
 		int sepIndex = path.lastIndexOf(EXTENSION_SEPARATOR);
531
 		return (sepIndex != -1 ? path.substring(sepIndex + 1) : null);
532
 	}

	
 Strip the filename extension from the given path,
 e.g. "mypath/myfile.txt" -> "mypath/myfile".
 
 Parameters:path the file path (may be null) Returns:the path with stripped filename extension,
 or null if none
540
 
541
 	public static String stripFilenameExtension(String path) {
542
 		if (path == null) {
543
 			return null;
544
 		}
545
 		int sepIndex = path.lastIndexOf(EXTENSION_SEPARATOR);
546
 		return (sepIndex != -1 ? path.substring(0, sepIndex) : path);
547
 	}

	
 Apply the given relative path to the given path,
 assuming standard Java folder separation (i.e. "/" separators);
 
 Parameters:path the path to start from (usually a full file path)relativePath the relative path to apply
 (relative to the full file path above) Returns:the full file path that results from applying the relative path
556
 
557
 	public static String applyRelativePath(String path, String relativePath) {
558
 		int separatorIndex = path.lastIndexOf(FOLDER_SEPARATOR);
559
 		if (separatorIndex != -1) {
560
 			String newPath = path.substring(0, separatorIndex);
561
 			if (!relativePath.startsWith(FOLDER_SEPARATOR)) {
562
 				newPath += FOLDER_SEPARATOR;
563
 			}
564
 			return newPath + relativePath;
565
 		}
566
 		else {
567
 			return relativePath;
568
 		}
569
 	}

	
 Normalize the path by suppressing sequences like "path/.." and
 inner simple dots.
 The result is convenient for path comparison. For other uses,
 notice that Windows separators ("\") are replaced by simple slashes.
 
 Parameters:path the original path Returns:the normalized path
578
 
579
 	public static String cleanPath(String path) {
580
 		if (path == null) {
581
 			return null;
582
 		}
583
 		String pathToUse = replace(path, WINDOWS_FOLDER_SEPARATOR, FOLDER_SEPARATOR);
584
 
585
 		// Strip prefix from path to analyze, to not treat it as part of the
586
 		// first path element. This is necessary to correctly parse paths like
587
 		// "file:core/../core/io/Resource.class", where the ".." should just
588
 		// strip the first "core" directory while keeping the "file:" prefix.
589
 		int prefixIndex = pathToUse.indexOf(":");
590
 		String prefix = "";
591
 		if (prefixIndex != -1) {
592
 			prefix = pathToUse.substring(0, prefixIndex + 1);
593
 			pathToUse = pathToUse.substring(prefixIndex + 1);
594
 		}
595
 		if (pathToUse.startsWith(FOLDER_SEPARATOR)) {
596
 			prefix = prefix + FOLDER_SEPARATOR;
597
 			pathToUse = pathToUse.substring(1);
598
 		}
599
 
600
 		String[] pathArray = delimitedListToStringArray(pathToUse, FOLDER_SEPARATOR);
601
 		List pathElements = new LinkedList();
602
 		int tops = 0;
603
 
604
 		for (int i = pathArray.length - 1; i >= 0; i--) {
605
 			String element = pathArray[i];
606
 			if (CURRENT_PATH.equals(element)) {
607
 				// Points to current directory - drop it.
608
 			}
609
 			else if (TOP_PATH.equals(element)) {
610
 				// Registering top path found.
611
 				tops++;
612
 			}
613
 			else {
614
 				if (tops > 0) {
615
 					// Merging path element with element corresponding to top path.
616
 					tops--;
617
 				}
618
 				else {
619
 					// Normal path element found.
620
 					pathElements.add(0, element);
621
 				}
622
 			}
623
 		}
624
 
625
 		// Remaining top paths need to be retained.
626
 		for (int i = 0; i < tops; i++) {
627
 			pathElements.add(0, TOP_PATH);
628
 		}
629
 
630
 		return prefix + collectionToDelimitedString(pathElements, FOLDER_SEPARATOR);
631
 	}

	
 Compare two paths after normalization of them.
 
 Parameters:path1 first path for comparisonpath2 second path for comparison Returns:whether the two paths are equivalent after normalization
638
 
639
 	public static boolean pathEquals(String path1, String path2) {
640
 		return cleanPath(path1).equals(cleanPath(path2));
641
 	}

	
 Parse the given localeString into a java.util.Locale.
 This is the inverse operation of Locale's toString.
 
 Parameters:localeString the locale string, following Locale's
 toString() format ("en", "en_UK", etc);
 also accepts spaces as separators, as an alternative to underscores Returns:a corresponding Locale instance
650
 
651
 	public static Locale parseLocaleString(String localeString) {
652
 		String[] parts = tokenizeToStringArray(localeString, "_ ", false, false);
653
 		String language = (parts.length > 0 ? parts[0] : "");
654
 		String country = (parts.length > 1 ? parts[1] : "");
655
 		String variant = "";
656
 		if (parts.length >= 2) {
657
 			// There is definitely a variant, and it is everything after the country
658
 			// code sans the separator between the country code and the variant.
659
 			int endIndexOfCountryCode = localeString.indexOf(country) + country.length();
660
 			// Strip off any leading '_' and whitespace, what's left is the variant.
661
 			variant = trimLeadingWhitespace(localeString.substring(endIndexOfCountryCode));
662
 			if (variant.startsWith("_")) {
663
 				variant = trimLeadingCharacter(variant, '_');
664
 			}
665
 		}
666
 		return (language.length() > 0 ? new Locale(language, country, variant) : null);
667
 	}

	
 Determine the RFC 3066 compliant language tag,
 as used for the HTTP "Accept-Language" header.
 
 Parameters:locale the Locale to transform to a language tag Returns:the RFC 3066 compliant language tag as String
674
 
675
 	public static String toLanguageTag(Locale locale) {
676
 		return locale.getLanguage() + (hasText(locale.getCountry()) ? "-" + locale.getCountry() : "");
677
 	}
678
 
679
 
680
 	//---------------------------------------------------------------------
681
 	// Convenience methods for working with String arrays
682
 	//---------------------------------------------------------------------
683
 
	
 Append the given String to the given String array, returning a new array
 consisting of the input array contents plus the given String.
 
 Parameters:array the array to append to (can be null)str the String to append Returns:the new array (never null)
690
 
691
 	public static String[] addStringToArray(String[] array, String str) {
692
 		if (ObjectUtils.isEmpty(array)) {
693
 			return new String[] {str};
694
 		}
695
 		String[] newArr = new String[array.length + 1];
696
 		System.arraycopy(array, 0, newArr, 0, array.length);
697
 		newArr[array.length] = str;
698
 		return newArr;
699
 	}

	
 Concatenate the given String arrays into one,
 with overlapping array elements included twice.
 The order of elements in the original arrays is preserved.
 
 Parameters:array1 the first array (can be null)array2 the second array (can be null) Returns:the new array (null if both given arrays were null)
708
 
709
 	public static String[] concatenateStringArrays(String[] array1, String[] array2) {
710
 		if (ObjectUtils.isEmpty(array1)) {
711
 			return array2;
712
 		}
713
 		if (ObjectUtils.isEmpty(array2)) {
714
 			return array1;
715
 		}
716
 		String[] newArr = new String[array1.length + array2.length];
717
 		System.arraycopy(array1, 0, newArr, 0, array1.length);
718
 		System.arraycopy(array2, 0, newArr, array1.length, array2.length);
719
 		return newArr;
720
 	}

	
 Merge the given String arrays into one, with overlapping
 array elements only included once.
 The order of elements in the original arrays is preserved
 (with the exception of overlapping elements, which are only
 included on their first occurence).
 
 Parameters:array1 the first array (can be null)array2 the second array (can be null) Returns:the new array (null if both given arrays were null)
731
 
732
 	public static String[] mergeStringArrays(String[] array1, String[] array2) {
733
 		if (ObjectUtils.isEmpty(array1)) {
734
 			return array2;
735
 		}
736
 		if (ObjectUtils.isEmpty(array2)) {
737
 			return array1;
738
 		}
739
 		List result = new ArrayList();
740
 		result.addAll(Arrays.asList(array1));
741
 		for (int i = 0; i < array2.length; i++) {
742
 			String str = array2[i];
743
 			if (!result.contains(str)) {
744
 				result.add(str);
745
 			}
746
 		}
747
 		return toStringArray(result);
748
 	}

	
 Turn given source String array into sorted array.
 
 Parameters:array the source array Returns:the sorted array (never null)
754
 
755
 	public static String[] sortStringArray(String[] array) {
756
 		if (ObjectUtils.isEmpty(array)) {
757
 			return new String[0];
758
 		}
759
 		Arrays.sort(array);
760
 		return array;
761
 	}

	
 Copy the given Collection into a String array.
 The Collection must contain String elements only.
 
 Parameters:collection the Collection to copy Returns:the String array (null if the passed-in
 Collection was null)
769
 
770
 	public static String[] toStringArray(Collection collection) {
771
 		if (collection == null) {
772
 			return null;
773
 		}
774
 		return (String[]) collection.toArray(new String[collection.size()]);
775
 	}

	
 Copy the given Enumeration into a String array.
 The Enumeration must contain String elements only.
 
 Parameters:enumeration the Enumeration to copy Returns:the String array (null if the passed-in
 Enumeration was null)
783
 
784
 	public static String[] toStringArray(Enumeration enumeration) {
785
 		if (enumeration == null) {
786
 			return null;
787
 		}
788
 		List list = Collections.list(enumeration);
789
 		return (String[]) list.toArray(new String[list.size()]);
790
 	}

	
 Trim the elements of the given String array,
 calling String.trim() on each of them.
 
 Parameters:array the original String array Returns:the resulting array (of the same size) with trimmed elements
797
 
798
 	public static String[] trimArrayElements(String[] array) {
799
 		if (ObjectUtils.isEmpty(array)) {
800
 			return new String[0];
801
 		}
802
 		String[] result = new String[array.length];
803
 		for (int i = 0; i < array.length; i++) {
804
 			String element = array[i];
805
 			result[i] = (element != null ? element.trim() : null);
806
 		}
807
 		return result;
808
 	}

	
 Remove duplicate Strings from the given array.
 Also sorts the array, as it uses a TreeSet.
 
 Parameters:array the String array Returns:an array without duplicates, in natural sort order
815
 
816
 	public static String[] removeDuplicateStrings(String[] array) {
817
 		if (ObjectUtils.isEmpty(array)) {
818
 			return array;
819
 		}
820
 		Set set = new TreeSet();
821
 		for (int i = 0; i < array.length; i++) {
822
 			set.add(array[i]);
823
 		}
824
 		return toStringArray(set);
825
 	}

	
 Split a String at the first occurrence of the delimiter.
 Does not include the delimiter in the result.
 
 Parameters:toSplit the string to splitdelimiter to split the string up with Returns:a two element array with index 0 being before the delimiter, and
 index 1 being after the delimiter (neither element includes the delimiter);
 or null if the delimiter wasn't found in the given input String
835
 
836
 	public static String[] split(String toSplit, String delimiter) {
837
 		if (!hasLength(toSplit) || !hasLength(delimiter)) {
838
 			return null;
839
 		}
840
 		int offset = toSplit.indexOf(delimiter);
841
 		if (offset < 0) {
842
 			return null;
843
 		}
844
 		String beforeDelimiter = toSplit.substring(0, offset);
845
 		String afterDelimiter = toSplit.substring(offset + delimiter.length());
846
 		return new String[] {beforeDelimiter, afterDelimiter};
847
 	}

	
 Take an array Strings and split each element based on the given delimiter.
 A Properties instance is then generated, with the left of the
 delimiter providing the key, and the right of the delimiter providing the value.
 Will trim both the key and value before adding them to the
 Properties instance.
 
 Parameters:array the array to processdelimiter to split each element using (typically the equals symbol) Returns:a Properties instance representing the array contents,
 or null if the array to process was null or empty
859
 
860
 	public static Properties splitArrayElementsIntoProperties(String[] array, String delimiter) {
861
 		return splitArrayElementsIntoProperties(array, delimiter, null);
862
 	}

	
 Take an array Strings and split each element based on the given delimiter.
 A Properties instance is then generated, with the left of the
 delimiter providing the key, and the right of the delimiter providing the value.
 Will trim both the key and value before adding them to the
 Properties instance.
 
 Parameters:array the array to processdelimiter to split each element using (typically the equals symbol)charsToDelete one or more characters to remove from each element
 prior to attempting the split operation (typically the quotation mark
 symbol), or null if no removal should occur Returns:a Properties instance representing the array contents,
 or null if the array to process was null or empty
877
 
878
 	public static Properties splitArrayElementsIntoProperties(
879
 			String[] array, String delimiter, String charsToDelete) {
880
 
881
 		if (ObjectUtils.isEmpty(array)) {
882
 			return null;
883
 		}
884
 		Properties result = new Properties();
885
 		for (int i = 0; i < array.length; i++) {
886
 			String element = array[i];
887
 			if (charsToDelete != null) {
888
 				element = deleteAny(array[i], charsToDelete);
889
 			}
890
 			String[] splittedElement = split(element, delimiter);
891
 			if (splittedElement == null) {
892
 				continue;
893
 			}
894
 			result.setProperty(splittedElement[0].trim(), splittedElement[1].trim());
895
 		}
896
 		return result;
897
 	}

	
 Tokenize the given String into a String array via a StringTokenizer.
 Trims tokens and omits empty tokens.
 The given delimiters string is supposed to consist of any number of
 delimiter characters. Each of those characters can be used to separate
 tokens. A delimiter is always a single character; for multi-character
 delimiters, consider using delimitedListToStringArray
 
 Parameters:str the String to tokenizedelimiters the delimiter characters, assembled as String
 (each of those characters is individually considered as delimiter). Returns:an array of the tokens See also:java.util.StringTokenizerjava.lang.String.trim()delimitedListToStringArray(java.lang.String,java.lang.String)
913
 
914
 	public static String[] tokenizeToStringArray(String str, String delimiters) {
915
 		return tokenizeToStringArray(str, delimiters, true, true);
916
 	}

	
 Tokenize the given String into a String array via a StringTokenizer.
 The given delimiters string is supposed to consist of any number of
 delimiter characters. Each of those characters can be used to separate
 tokens. A delimiter is always a single character; for multi-character
 delimiters, consider using delimitedListToStringArray
 
 Parameters:str the String to tokenizedelimiters the delimiter characters, assembled as String
 (each of those characters is individually considered as delimiter)trimTokens trim the tokens via String's trimignoreEmptyTokens omit empty tokens from the result array
 (only applies to tokens that are empty after trimming; StringTokenizer
 will not consider subsequent delimiters as token in the first place). Returns:an array of the tokens (null if the input String
 was null) See also:java.util.StringTokenizerjava.lang.String.trim()delimitedListToStringArray(java.lang.String,java.lang.String)
936
 
937
 	public static String[] tokenizeToStringArray(
938
 			String str, String delimiters, boolean trimTokens, boolean ignoreEmptyTokens) {
939
 
940
 		if (str == null) {
941
 			return null;
942
 		}
943
 		StringTokenizer st = new StringTokenizer(str, delimiters);
944
 		List tokens = new ArrayList();
945
 		while (st.hasMoreTokens()) {
946
 			String token = st.nextToken();
947
 			if (trimTokens) {
948
 				token = token.trim();
949
 			}
950
 			if (!ignoreEmptyTokens || token.length() > 0) {
951
 				tokens.add(token);
952
 			}
953
 		}
954
 		return toStringArray(tokens);
955
 	}

	
 Take a String which is a delimited list and convert it to a String array.
 A single delimiter can consists of more than one character: It will still
 be considered as single delimiter string, rather than as bunch of potential
 delimiter characters - in contrast to tokenizeToStringArray.
 
 Parameters:str the input Stringdelimiter the delimiter between elements (this is a single delimiter,
 rather than a bunch individual delimiter characters) Returns:an array of the tokens in the list See also:tokenizeToStringArray(java.lang.String,java.lang.String)
967
 
968
 	public static String[] delimitedListToStringArray(String str, String delimiter) {
969
 		return delimitedListToStringArray(str, delimiter, null);
970
 	}

	
 Take a String which is a delimited list and convert it to a String array.
 A single delimiter can consists of more than one character: It will still
 be considered as single delimiter string, rather than as bunch of potential
 delimiter characters - in contrast to tokenizeToStringArray.
 
 Parameters:str the input Stringdelimiter the delimiter between elements (this is a single delimiter,
 rather than a bunch individual delimiter characters)charsToDelete a set of characters to delete. Useful for deleting unwanted
 line breaks: e.g. "\r\n\f" will delete all new lines and line feeds in a String. Returns:an array of the tokens in the list See also:tokenizeToStringArray(java.lang.String,java.lang.String)
984
 
985
 	public static String[] delimitedListToStringArray(String str, String delimiter, String charsToDelete) {
986
 		if (str == null) {
987
 			return new String[0];
988
 		}
989
 		if (delimiter == null) {
990
 			return new String[] {str};
991
 		}
992
 		List result = new ArrayList();
993
 		if ("".equals(delimiter)) {
994
 			for (int i = 0; i < str.length(); i++) {
995
 				result.add(deleteAny(str.substring(i, i + 1), charsToDelete));
996
 			}
997
 		}
998
 		else {
999
 			int pos = 0;
1000
			int delPos = 0;
1001
			while ((delPos = str.indexOf(delimiter, pos)) != -1) {
1002
				result.add(deleteAny(str.substring(pos, delPos), charsToDelete));
1003
				pos = delPos + delimiter.length();
1004
			}
1005
			if (str.length() > 0 && pos <= str.length()) {
1006
				// Add rest of String, but not in case of empty input.
1007
				result.add(deleteAny(str.substring(pos), charsToDelete));
1008
			}
1009
		}
1010
		return toStringArray(result);
1011
	}

	
 Convert a CSV list into an array of Strings.
 
 Parameters:str the input String Returns:an array of Strings, or the empty array in case of empty input
1017
1018
	public static String[] commaDelimitedListToStringArray(String str) {
1019
		return delimitedListToStringArray(str, ",");
1020
	}

	
 Convenience method to convert a CSV string list to a set.
 Note that this will suppress duplicates.
 
 Parameters:str the input String Returns:a Set of String entries in the list
1027
1028
	public static Set commaDelimitedListToSet(String str) {
1029
		Set set = new TreeSet();
1030
		String[] tokens = commaDelimitedListToStringArray(str);
1031
		for (int i = 0; i < tokens.length; i++) {
1032
			set.add(tokens[i]);
1033
		}
1034
		return set;
1035
	}

	
 Convenience method to return a Collection as a delimited (e.g. CSV)
 String. E.g. useful for toString() implementations.
 
 Parameters:coll the Collection to displaydelim the delimiter to use (probably a ",")prefix the String to start each element withsuffix the String to end each element with Returns:the delimited String
1045
1046
	public static String collectionToDelimitedString(Collection coll, String delim, String prefix, String suffix) {
1047
		if (CollectionUtils.isEmpty(coll)) {
1048
			return "";
1049
		}
1050
		StringBuffer sb = new StringBuffer();
1051
		Iterator it = coll.iterator();
1052
		while (it.hasNext()) {
1053
			sb.append(prefix).append(it.next()).append(suffix);
1054
			if (it.hasNext()) {
1055
				sb.append(delim);
1056
			}
1057
		}
1058
		return sb.toString();
1059
	}

	
 Convenience method to return a Collection as a delimited (e.g. CSV)
 String. E.g. useful for toString() implementations.
 
 Parameters:coll the Collection to displaydelim the delimiter to use (probably a ",") Returns:the delimited String
1067
1068
	public static String collectionToDelimitedString(Collection coll, String delim) {
1069
		return collectionToDelimitedString(coll, delim, "", "");
1070
	}

	
 Convenience method to return a Collection as a CSV String.
 E.g. useful for toString() implementations.
 
 Parameters:coll the Collection to display Returns:the delimited String
1077
1078
	public static String collectionToCommaDelimitedString(Collection coll) {
1079
		return collectionToDelimitedString(coll, ",");
1080
	}

	
 Convenience method to return a String array as a delimited (e.g. CSV)
 String. E.g. useful for toString() implementations.
 
 Parameters:arr the array to displaydelim the delimiter to use (probably a ",") Returns:the delimited String
1088
1089
	public static String arrayToDelimitedString(Object[] arr, String delim) {
1090
		if (ObjectUtils.isEmpty(arr)) {
1091
			return "";
1092
		}
1093
		StringBuffer sb = new StringBuffer();
1094
		for (int i = 0; i < arr.length; i++) {
1095
			if (i > 0) {
1096
				sb.append(delim);
1097
			}
1098
			sb.append(arr[i]);
1099
		}
1100
		return sb.toString();
1101
	}

	
 Convenience method to return a String array as a CSV String.
 E.g. useful for toString() implementations.
 
 Parameters:arr the array to display Returns:the delimited String
1108
1109
	public static String arrayToCommaDelimitedString(Object[] arr) {
1110
		return arrayToDelimitedString(arr, ",");
1111
	}
1112
1113
}