| 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
org.apache.commons.lang.StringUtils 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
StringUtils.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
author:
Rick Evans
since:
16 April 2001 |
| 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 String | applyRelativePath(String path, String relativePath)
Apply the given relative path to the given path,
assuming standard Java folder separation (i.e. | | public static String | arrayToCommaDelimitedString(Object[] arr)
Convenience method to return a String array as a CSV String.
E.g. | | public static String | arrayToDelimitedString(Object[] arr, String delim)
Convenience method to return a String array as a delimited (e.g. | | public static String | capitalize(String str)
Capitalize a String, changing the first letter to
upper case as per
Character.toUpperCase(char) . | | public static String | cleanPath(String path)
Normalize the path by suppressing sequences like "path/.." and
inner simple dots.
The result is convenient for path comparison. | | public static String | collectionToCommaDelimitedString(Collection coll)
Convenience method to return a Collection as a CSV String.
E.g. | | public static String | collectionToDelimitedString(Collection coll, String delim, String prefix, String suffix)
Convenience method to return a Collection as a delimited (e.g. | | public static String | collectionToDelimitedString(Collection coll, String delim)
Convenience method to return a Collection as a delimited (e.g. | | public static Set | commaDelimitedListToSet(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 boolean | containsWhitespace(String str)
Check whether the given String contains any whitespace characters. | | public static int | countOccurrencesOf(String str, String sub)
Count the occurrences of the substring in string s.
Parameters:
str - string to search in. | | public static String | delete(String inString, String pattern)
Delete all occurrences of the given substring. | | public static String | deleteAny(String inString, String charsToDelete)
Delete any character in a given String.
Parameters:
inString - the original 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 String[] | delimitedListToStringArray(String str, String delimiter, String charsToDelete)
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)
Parameters:
charsToDelete - a set of characters to delete. | | public static boolean | endsWithIgnoreCase(String str, String suffix)
Test if the given String ends with the specified suffix,
ignoring upper/lower case. | | public static String | getFilename(String path)
Extract the filename from the given path,
e.g. | | public static String | getFilenameExtension(String path)
Extract the filename extension from the given path,
e.g. | | public static boolean | hasLength(String str)
Check that the given String is neither null nor of length 0. | | public static boolean | hasText(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 Locale | parseLocaleString(String localeString)
Parse the given localeString into a
Locale . | | public static boolean | pathEquals(String path1, String path2)
Compare two paths after normalization of them. | | public static String | quote(String str)
Quote the given String with single quotes.
Parameters:
str - the input String (e.g. | | public static Object | quoteIfString(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 String | replace(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 Properties | splitArrayElementsIntoProperties(String[] array, String delimiter)
Take an array Strings and split each element based on the given delimiter. | | public static Properties | splitArrayElementsIntoProperties(String[] array, String delimiter, String charsToDelete)
Take an array Strings and split each element based on the given delimiter. | | public static boolean | startsWithIgnoreCase(String str, String prefix)
Test if the given String starts with the specified prefix,
ignoring upper/lower case. | | public static String | stripFilenameExtension(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[] | toStringArray(Enumeration enumeration)
Copy the given Enumeration 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 String | trimAllWhitespace(String str)
Trim all whitespace from the given String:
leading, trailing, and inbetween characters. | | public static String[] | trimArrayElements(String[] array)
Trim the elements of the given String array,
calling String.trim() on each of them. | | public static String | trimLeadingCharacter(String str, char leadingCharacter)
Trim all occurences of the supplied leading character from the given String. | | public static String | trimLeadingWhitespace(String str)
Trim leading whitespace from the given String. | | public static String | trimTrailingCharacter(String str, char trailingCharacter)
Trim all occurences of the supplied trailing character from the given String. | | public static String | trimTrailingWhitespace(String str)
Trim trailing whitespace from the given String. | | public static String | trimWhitespace(String str)
Trim leading and trailing whitespace from the given String. | | public static String | uncapitalize(String str)
Uncapitalize a String, changing the first letter to
lower case as per
Character.toLowerCase(char) . | | public static String | unqualify(String qualifiedName)
Unqualify a string qualified by a '.' dot character. | | public static String | unqualify(String qualifiedName, char separator)
Unqualify a string qualified by a separator character. |
| 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 the delimited String |
| 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 ",") the delimited String |
| 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 the delimited String |
| 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 the delimited String |
| 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 ",") the delimited String |
| 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:
inString - the original String
Parameters:
pattern - the pattern to delete all occurrences of the resulting String |
| deleteAny | | public static String deleteAny(String inString, String charsToDelete)(Code) | | Delete any character in a given String.
Parameters:
inString - the original String
Parameters:
charsToDelete - a set of characters to delete.E.g. "az\n" will delete 'a's, 'z's and new lines. the resulting String |
| 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 |
| delimitedListToStringArray | | public static String[] delimitedListToStringArray(String str, String delimiter, String charsToDelete)(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)
Parameters:
charsToDelete - a set of characters to delete. Useful for deleting unwantedline breaks: e.g. "\r\n\f" will delete all new lines and line feeds in a String. 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 it 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 localeString into a
Locale .
This is the inverse operation of
Locale.toString Locale's toString .
Parameters:
localeString - the locale string, following Locale'stoString() format ("en", "en_UK", etc);also accepts spaces as separators, as an 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 comparison
Parameters:
path2 - second path for comparison 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) |
| toStringArray | | public static String[] toStringArray(Enumeration enumeration)(Code) | | Copy the given Enumeration into a String array.
The Enumeration must contain String elements only.
Parameters:
enumeration - the Enumeration to copy the String array (null if the passed-inEnumeration 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 |
| trimArrayElements | | public static String[] trimArrayElements(String[] array)(Code) | | Trim the elements of the given String array,
calling String.trim() on each of them.
Parameters:
array - the original String array the resulting array (of the same size) with trimmed elements |
| trimLeadingCharacter | | public static String trimLeadingCharacter(String str, char leadingCharacter)(Code) | | Trim all occurences of the supplied leading character from the given String.
Parameters:
str - the String to check
Parameters:
leadingCharacter - the leading character to be trimmed the trimmed String |
| trimTrailingCharacter | | public static String trimTrailingCharacter(String str, char trailingCharacter)(Code) | | Trim all occurences of the supplied trailing character from the given String.
Parameters:
str - the String to check
Parameters:
trailingCharacter - the trailing character to be trimmed the trimmed String |
| 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 |
|
|