Java Doc for StringUtils.java in  » J2EE » spring-framework-2.0.6 » org » springframework » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » spring framework 2.0.6 » org.springframework.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.util.StringUtils

StringUtils
abstract public class StringUtils (Code)
Miscellaneous 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 StringBuffer classes, such as the ability to replace 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:
   Rod Johnson
author:
   Juergen Hoeller
author:
   Keith Donald
author:
   Rob Harrop
since:
   16 April 2001
See Also:   org.apache.commons.lang.StringUtils





Method Summary
public static  String[]addStringToArray(String[] array, String str)
     Append the given String to the given String array, returning a new array consisting of the input array contents plus the given String.
public static  StringapplyRelativePath(String path, String relativePath)
     Apply the given relative path to the given path, assuming standard Java folder separation (i.e.
public static  StringarrayToCommaDelimitedString(Object[] arr)
     Convenience method to return a String array as a CSV String. E.g.
public static  StringarrayToDelimitedString(Object[] arr, String delim)
     Convenience method to return a String array as a delimited (e.g.
public static  Stringcapitalize(String str)
     Capitalize a String, changing the first letter to upper case as per Character.toUpperCase(char) .
public static  StringcleanPath(String path)
     Normalize the path by suppressing sequences like "path/.." and inner simple dots.

The result is convenient for path comparison.

public static  StringcollectionToCommaDelimitedString(Collection coll)
     Convenience method to return a Collection as a CSV String. E.g.
public static  StringcollectionToDelimitedString(Collection coll, String delim, String prefix, String suffix)
     Convenience method to return a Collection as a delimited (e.g.
public static  StringcollectionToDelimitedString(Collection coll, String delim)
     Convenience method to return a Collection as a delimited (e.g.
public static  SetcommaDelimitedListToSet(String str)
     Convenience method to convert a CSV string list to a set.
public static  String[]commaDelimitedListToStringArray(String str)
     Convert a CSV list into an array of Strings.
public static  String[]concatenateStringArrays(String[] array1, String[] array2)
     Concatenate the given String arrays into one, with overlapping array elements included twice.
public static  booleancontainsWhitespace(String str)
     Check whether the given String contains any whitespace characters.
public static  intcountOccurrencesOf(String str, String sub)
     Count the occurrences of the substring in string s.
Parameters:
  str - string to search in.
public static  Stringdelete(String inString, String pattern)
     Delete all occurrences of the given substring.
public static  StringdeleteAny(String inString, String charsToDelete)
     Delete any character in a given string.
Parameters:
  charsToDelete - a set of characters to delete.E.g.
public static  String[]delimitedListToStringArray(String str, String delimiter)
     Take a String which is a delimited list and convert it to a String array.
public static  booleanendsWithIgnoreCase(String str, String suffix)
     Test if the given String ends with the specified suffix, ignoring upper/lower case.
public static  StringgetFilename(String path)
     Extract the filename from the given path, e.g.
public static  StringgetFilenameExtension(String path)
     Extract the filename extension from the given path, e.g.
public static  booleanhasLength(String str)
     Check that the given String is neither null nor of length 0.
public static  booleanhasText(String str)
     Check whether the given String has actual text.
public static  String[]mergeStringArrays(String[] array1, String[] array2)
     Merge the given String arrays into one, with overlapping array elements only included once.
public static  LocaleparseLocaleString(String localeString)
     Parse the given locale string into a java.util.Locale. This is the inverse operation of Locale's toString.
Parameters:
  localeString - the locale string, followingjava.util.Locale's toString format ("en", "en_UK", etc).Also accepts spaces as separators, as alternative to underscores.
public static  booleanpathEquals(String path1, String path2)
     Compare two paths after normalization of them.
public static  Stringquote(String str)
     Quote the given String with single quotes.
Parameters:
  str - the input String (e.g.
public static  ObjectquoteIfString(Object obj)
     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.
public static  String[]removeDuplicateStrings(String[] array)
     Remove duplicate Strings from the given array.
public static  Stringreplace(String inString, String oldPattern, String newPattern)
     Replace all occurences of a substring within a string with another string.
public static  String[]sortStringArray(String[] array)
     Turn given source String array into sorted array.
public static  String[]split(String toSplit, String delimiter)
     Split a String at the first occurrence of the delimiter.
public static  PropertiessplitArrayElementsIntoProperties(String[] array, String delimiter)
     Take an array Strings and split each element based on the given delimiter.
public static  PropertiessplitArrayElementsIntoProperties(String[] array, String delimiter, String charsToDelete)
     Take an array Strings and split each element based on the given delimiter.
public static  booleanstartsWithIgnoreCase(String str, String prefix)
     Test if the given String starts with the specified prefix, ignoring upper/lower case.
public static  StringstripFilenameExtension(String path)
     Strip the filename extension from the given path, e.g.
public static  String[]toStringArray(Collection collection)
     Copy the given Collection into a String array.
public static  String[]tokenizeToStringArray(String str, String delimiters)
     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.

public static  String[]tokenizeToStringArray(String str, String delimiters, boolean trimTokens, boolean ignoreEmptyTokens)
     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.

public static  StringtrimAllWhitespace(String str)
     Trim all whitespace from the given String: leading, trailing, and inbetween characters.
public static  StringtrimLeadingWhitespace(String str)
     Trim leading whitespace from the given String.
public static  StringtrimTrailingWhitespace(String str)
     Trim trailing whitespace from the given String.
public static  StringtrimWhitespace(String str)
     Trim leading and trailing whitespace from the given String.
public static  Stringuncapitalize(String str)
     Uncapitalize a String, changing the first letter to lower case as per Character.toLowerCase(char) .
public static  Stringunqualify(String qualifiedName)
     Unqualify a string qualified by a '.' dot character.
public static  Stringunqualify(String qualifiedName, char separator)
     Unqualify a string qualified by a separator character.



Method Detail
addStringToArray
public static String[] addStringToArray(String[] array, String str)(Code)
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)
Parameters:
  str - the String to append the new array (never null)



applyRelativePath
public static String applyRelativePath(String path, String relativePath)(Code)
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)
Parameters:
  relativePath - the relative path to apply(relative to the full file path above) the full file path that results from applying the relative path



arrayToCommaDelimitedString
public static String arrayToCommaDelimitedString(Object[] arr)(Code)
Convenience method to return a String array as a CSV String. E.g. useful for toString() implementations.
Parameters:
  arr - the array to display



arrayToDelimitedString
public static String arrayToDelimitedString(Object[] arr, String delim)(Code)
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 display
Parameters:
  delim - the delimiter to use (probably a ",")



capitalize
public static String capitalize(String str)(Code)
Capitalize a String, changing the first letter to upper case as per Character.toUpperCase(char) . No other letters are changed.
Parameters:
  str - the String to capitalize, may be null the capitalized String, null if null



cleanPath
public static String cleanPath(String path)(Code)
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 the normalized path




collectionToCommaDelimitedString
public static String collectionToCommaDelimitedString(Collection coll)(Code)
Convenience method to return a Collection as a CSV String. E.g. useful for toString() implementations.
Parameters:
  coll - the Collection to display



collectionToDelimitedString
public static String collectionToDelimitedString(Collection coll, String delim, String prefix, String suffix)(Code)
Convenience method to return a Collection as a delimited (e.g. CSV) String. E.g. useful for toString() implementations.
Parameters:
  coll - the Collection to display
Parameters:
  delim - the delimiter to use (probably a ",")
Parameters:
  prefix - the String to start each element with
Parameters:
  suffix - the String to end each element with



collectionToDelimitedString
public static String collectionToDelimitedString(Collection coll, String delim)(Code)
Convenience method to return a Collection as a delimited (e.g. CSV) String. E.g. useful for toString() implementations.
Parameters:
  coll - the Collection to display
Parameters:
  delim - the delimiter to use (probably a ",")



commaDelimitedListToSet
public static Set commaDelimitedListToSet(String str)(Code)
Convenience method to convert a CSV string list to a set. Note that this will suppress duplicates.
Parameters:
  str - the input String a Set of String entries in the list



commaDelimitedListToStringArray
public static String[] commaDelimitedListToStringArray(String str)(Code)
Convert a CSV list into an array of Strings.
Parameters:
  str - the input String an array of Strings, or the empty array in case of empty input



concatenateStringArrays
public static String[] concatenateStringArrays(String[] array1, String[] array2)(Code)
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)
Parameters:
  array2 - the second array (can be null) the new array (null if both given arrays were null)




containsWhitespace
public static boolean containsWhitespace(String str)(Code)
Check whether the given String contains any whitespace characters.
Parameters:
  str - the String to check (may be null) true if the String is not empty andcontains at least 1 whitespace character
See Also:   java.lang.Character.isWhitespace



countOccurrencesOf
public static int countOccurrencesOf(String str, String sub)(Code)
Count the occurrences of the substring in string s.
Parameters:
  str - string to search in. Return 0 if this is null.
Parameters:
  sub - string to search for. Return 0 if this is null.



delete
public static String delete(String inString, String pattern)(Code)
Delete all occurrences of the given substring.
Parameters:
  pattern - the pattern to delete all occurrences of



deleteAny
public static String deleteAny(String inString, String charsToDelete)(Code)
Delete any character in a given string.
Parameters:
  charsToDelete - a set of characters to delete.E.g. "az\n" will delete 'a's, 'z's and new lines.



delimitedListToStringArray
public static String[] delimitedListToStringArray(String str, String delimiter)(Code)
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 String
Parameters:
  delimiter - the delimiter between elements (this is a single delimiter,rather than a bunch individual delimiter characters) an array of the tokens in the list
See Also:   StringUtils.tokenizeToStringArray




endsWithIgnoreCase
public static boolean endsWithIgnoreCase(String str, String suffix)(Code)
Test if the given String ends with the specified suffix, ignoring upper/lower case.
Parameters:
  str - the String to check
Parameters:
  suffix - the suffix to look for
See Also:   java.lang.String.endsWith



getFilename
public static String getFilename(String path)(Code)
Extract the filename from the given path, e.g. "mypath/myfile.txt" -> "myfile.txt".
Parameters:
  path - the file path (may be null) the extracted filename, or null if none



getFilenameExtension
public static String getFilenameExtension(String path)(Code)
Extract the filename extension from the given path, e.g. "mypath/myfile.txt" -> "txt".
Parameters:
  path - the file path (may be null) the extracted filename extension, or null if none



hasLength
public static boolean hasLength(String str)(Code)
Check that the given String is neither null nor of length 0. Note: Will return true for a String that purely consists of whitespace.

 StringUtils.hasLength(null) = false
 StringUtils.hasLength("") = false
 StringUtils.hasLength(" ") = true
 StringUtils.hasLength("Hello") = true
 

Parameters:
  str - the String to check (may be null) true if the String is not null and has length
See Also:   StringUtils.hasText(String)



hasText
public static boolean hasText(String str)(Code)
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.

 StringUtils.hasText(null) = false
 StringUtils.hasText("") = false
 StringUtils.hasText(" ") = false
 StringUtils.hasText("12345") = true
 StringUtils.hasText(" 12345 ") = true
 

Parameters:
  str - the String to check (may be null) true if the String is not null, its length isgreater than 0, and is does not contain whitespace only
See Also:   java.lang.Character.isWhitespace



mergeStringArrays
public static String[] mergeStringArrays(String[] array1, String[] array2)(Code)
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)
Parameters:
  array2 - the second array (can be null) the new array (null if both given arrays were null)




parseLocaleString
public static Locale parseLocaleString(String localeString)(Code)
Parse the given locale string into a java.util.Locale. This is the inverse operation of Locale's toString.
Parameters:
  localeString - the locale string, followingjava.util.Locale's toString format ("en", "en_UK", etc).Also accepts spaces as separators, as alternative to underscores. a corresponding Locale instance



pathEquals
public static boolean pathEquals(String path1, String path2)(Code)
Compare two paths after normalization of them.
Parameters:
  path1 - First path for comparizon
Parameters:
  path2 - Second path for comparizon whether the two paths are equivalent after normalization



quote
public static String quote(String str)(Code)
Quote the given String with single quotes.
Parameters:
  str - the input String (e.g. "myString") the quoted String (e.g. "'myString'"),or null if the input was null



quoteIfString
public static Object quoteIfString(Object obj)(Code)
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") the quoted String (e.g. "'myString'"),or the input object as-is if not a String



removeDuplicateStrings
public static String[] removeDuplicateStrings(String[] array)(Code)
Remove duplicate Strings from the given array. Also sorts the array, as it uses a TreeSet.
Parameters:
  array - the String array an array without duplicates, in natural sort order



replace
public static String replace(String inString, String oldPattern, String newPattern)(Code)
Replace all occurences of a substring within a string with another string.
Parameters:
  inString - String to examine
Parameters:
  oldPattern - String to replace
Parameters:
  newPattern - String to insert a String with the replacements



sortStringArray
public static String[] sortStringArray(String[] array)(Code)
Turn given source String array into sorted array.
Parameters:
  array - the source array the sorted array (never null)



split
public static String[] split(String toSplit, String delimiter)(Code)
Split a String at the first occurrence of the delimiter. Does not include the delimiter in the result.
Parameters:
  toSplit - the string to split
Parameters:
  delimiter - to split the string up with a two element array with index 0 being before the delimiter, andindex 1 being after the delimiter (neither element includes the delimiter);or null if the delimiter wasn't found in the given input String



splitArrayElementsIntoProperties
public static Properties splitArrayElementsIntoProperties(String[] array, String delimiter)(Code)
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 process
Parameters:
  delimiter - to split each element using (typically the equals symbol) a Properties instance representing the array contents,or null if the array to process was null or empty




splitArrayElementsIntoProperties
public static Properties splitArrayElementsIntoProperties(String[] array, String delimiter, String charsToDelete)(Code)
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 process
Parameters:
  delimiter - to split each element using (typically the equals symbol)
Parameters:
  charsToDelete - one or more characters to remove from each elementprior to attempting the split operation (typically the quotation marksymbol), or null if no removal should occur a Properties instance representing the array contents,or null if the array to process was null or empty




startsWithIgnoreCase
public static boolean startsWithIgnoreCase(String str, String prefix)(Code)
Test if the given String starts with the specified prefix, ignoring upper/lower case.
Parameters:
  str - the String to check
Parameters:
  prefix - the prefix to look for
See Also:   java.lang.String.startsWith



stripFilenameExtension
public static String stripFilenameExtension(String path)(Code)
Strip the filename extension from the given path, e.g. "mypath/myfile.txt" -> "mypath/myfile".
Parameters:
  path - the file path (may be null) the path with stripped filename extension,or null if none



toStringArray
public static String[] toStringArray(Collection collection)(Code)
Copy the given Collection into a String array. The Collection must contain String elements only.
Parameters:
  collection - the Collection to copy the String array (null if the passed-inCollection was null)



tokenizeToStringArray
public static String[] tokenizeToStringArray(String str, String delimiters)(Code)
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 tokenize
Parameters:
  delimiters - the delimiter characters, assembled as String(each of those characters is individually considered as delimiter). an array of the tokens
See Also:   java.util.StringTokenizer
See Also:   java.lang.String.trim
See Also:   StringUtils.delimitedListToStringArray




tokenizeToStringArray
public static String[] tokenizeToStringArray(String str, String delimiters, boolean trimTokens, boolean ignoreEmptyTokens)(Code)
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 tokenize
Parameters:
  delimiters - the delimiter characters, assembled as String(each of those characters is individually considered as delimiter)
Parameters:
  trimTokens - trim the tokens via String's trim
Parameters:
  ignoreEmptyTokens - omit empty tokens from the result array(only applies to tokens that are empty after trimming; StringTokenizerwill not consider subsequent delimiters as token in the first place). an array of the tokens (null if the input Stringwas null)
See Also:   java.util.StringTokenizer
See Also:   java.lang.String.trim
See Also:   StringUtils.delimitedListToStringArray




trimAllWhitespace
public static String trimAllWhitespace(String str)(Code)
Trim all whitespace from the given String: leading, trailing, and inbetween characters.
Parameters:
  str - the String to check the trimmed String
See Also:   java.lang.Character.isWhitespace



trimLeadingWhitespace
public static String trimLeadingWhitespace(String str)(Code)
Trim leading whitespace from the given String.
Parameters:
  str - the String to check the trimmed String
See Also:   java.lang.Character.isWhitespace



trimTrailingWhitespace
public static String trimTrailingWhitespace(String str)(Code)
Trim trailing whitespace from the given String.
Parameters:
  str - the String to check the trimmed String
See Also:   java.lang.Character.isWhitespace



trimWhitespace
public static String trimWhitespace(String str)(Code)
Trim leading and trailing whitespace from the given String.
Parameters:
  str - the String to check the trimmed String
See Also:   java.lang.Character.isWhitespace



uncapitalize
public static String uncapitalize(String str)(Code)
Uncapitalize a String, changing the first letter to lower case as per Character.toLowerCase(char) . No other letters are changed.
Parameters:
  str - the String to uncapitalize, may be null the uncapitalized String, null if null



unqualify
public static String unqualify(String qualifiedName)(Code)
Unqualify a string qualified by a '.' dot character. For example, "this.name.is.qualified", returns "qualified".
Parameters:
  qualifiedName - the qualified name



unqualify
public static String unqualify(String qualifiedName, char separator)(Code)
Unqualify a string qualified by a separator character. For example, "this:name:is:qualified" returns "qualified" if using a ':' separator.
Parameters:
  qualifiedName - the qualified name
Parameters:
  separator - the separator



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.