@Deprecated
public abstract class StringUtils
extends java.lang.Object
| Constructor and Description |
|---|
StringUtils()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static java.lang.String[] |
addStringToArray(java.lang.String[] array,
java.lang.String str)
Deprecated.
Append the given
String to the given String array, returning a new array consisting of the input
array contents plus the given String. |
static java.lang.String |
applyRelativePath(java.lang.String path,
java.lang.String relativePath)
Deprecated.
Apply the given relative path to the given Java resource path, assuming standard Java folder separation (i.e.
|
static java.lang.String |
arrayToCommaDelimitedString(java.lang.Object[] arr)
Deprecated.
Convert a
String array into a comma delimited String (i.e., CSV). |
static java.lang.String |
arrayToDelimitedString(java.lang.Object[] arr,
java.lang.String delim)
Deprecated.
Convert a
String array into a delimited String (e.g. |
static java.lang.String |
capitalize(java.lang.String str)
Deprecated.
Capitalize a
String, changing the first letter to upper case as per Character.toUpperCase(char). |
static java.lang.String |
cleanPath(java.lang.String path)
Deprecated.
Normalize the path by suppressing sequences like "path/.." and inner simple dots.
|
static java.lang.String |
collectionToCommaDelimitedString(java.util.Collection<?> coll)
Deprecated.
Convert a
Collection into a delimited String (e.g., CSV). |
static java.lang.String |
collectionToDelimitedString(java.util.Collection<?> coll,
java.lang.String delim)
Deprecated.
Convert a
Collection into a delimited String (e.g. |
static java.lang.String |
collectionToDelimitedString(java.util.Collection<?> coll,
java.lang.String delim,
java.lang.String prefix,
java.lang.String suffix)
Deprecated.
Convert a
Collection to a delimited String (e.g. |
static java.util.Set<java.lang.String> |
commaDelimitedListToSet(java.lang.String str)
Deprecated.
Convert a comma delimited list (e.g., a row from a CSV file) into a set.
|
static java.lang.String[] |
commaDelimitedListToStringArray(java.lang.String str)
Deprecated.
Convert a comma delimited list (e.g., a row from a CSV file) into an array of strings.
|
static java.lang.String[] |
concatenateStringArrays(java.lang.String[] array1,
java.lang.String[] array2)
Deprecated.
Concatenate the given
String arrays into one, with overlapping array elements included twice. |
static boolean |
containsWhitespace(java.lang.CharSequence str)
Deprecated.
Check whether the given
CharSequence contains any whitespace characters. |
static boolean |
containsWhitespace(java.lang.String str)
Deprecated.
Check whether the given
String contains any whitespace characters. |
static int |
countOccurrencesOf(java.lang.String str,
java.lang.String sub)
Deprecated.
Count the occurrences of the substring
sub in string str. |
static java.lang.String |
delete(java.lang.String inString,
java.lang.String pattern)
Deprecated.
Delete all occurrences of the given substring.
|
static java.lang.String |
deleteAny(java.lang.String inString,
java.lang.String charsToDelete)
Deprecated.
Delete any character in a given
String. |
static java.lang.String[] |
delimitedListToStringArray(java.lang.String str,
java.lang.String delimiter)
Deprecated.
Take a
String that is a delimited list and convert it into a String array. |
static java.lang.String[] |
delimitedListToStringArray(java.lang.String str,
java.lang.String delimiter,
java.lang.String charsToDelete)
Deprecated.
Take a
String that is a delimited list and convert it into a String array. |
static boolean |
endsWithIgnoreCase(java.lang.String str,
java.lang.String suffix)
Deprecated.
Test if the given
String ends with the specified suffix, ignoring upper/lower case. |
static java.lang.String |
getFilename(java.lang.String path)
Deprecated.
Extract the filename from the given Java resource path, e.g.
|
static java.lang.String |
getFilenameExtension(java.lang.String path)
Deprecated.
Extract the filename extension from the given Java resource path, e.g.
|
static boolean |
hasLength(java.lang.CharSequence str)
Deprecated.
Check that the given
CharSequence is neither null nor of length 0. |
static boolean |
hasLength(java.lang.String str)
Deprecated.
Check that the given
String is neither null nor of length 0. |
static boolean |
hasText(java.lang.CharSequence str)
Deprecated.
Check whether the given
CharSequence contains actual text. |
static boolean |
hasText(java.lang.String str)
Deprecated.
Check whether the given
String contains actual text. |
static boolean |
isEmpty(java.lang.Object str)
Deprecated.
Check whether the given
String is empty. |
static java.lang.String[] |
mergeStringArrays(java.lang.String[] array1,
java.lang.String[] array2)
Deprecated.
Merge the given
String arrays into one, with overlapping array elements only included once. |
static java.util.Locale |
parseLocaleString(java.lang.String localeString)
Deprecated.
Parse the given
localeString value into a Locale. |
static java.util.TimeZone |
parseTimeZoneString(java.lang.String timeZoneString)
Deprecated.
Parse the given
timeZoneString value into a TimeZone. |
static boolean |
pathEquals(java.lang.String path1,
java.lang.String path2)
Deprecated.
Compare two paths after normalization of them.
|
static java.lang.String |
quote(java.lang.String str)
Deprecated.
Quote the given
String with single quotes. |
static java.lang.Object |
quoteIfString(java.lang.Object obj)
Deprecated.
Turn the given Object into a
String with single quotes if it is a String; keeping the Object
as-is else. |
static java.lang.String[] |
removeDuplicateStrings(java.lang.String[] array)
Deprecated.
Remove duplicate strings from the given array.
|
static java.lang.String |
replace(java.lang.String inString,
java.lang.String oldPattern,
java.lang.String newPattern)
Deprecated.
Replace all occurrences of a substring within a string with another string.
|
static java.lang.String[] |
sortStringArray(java.lang.String[] array)
Deprecated.
Turn given source
String array into sorted array. |
static java.lang.String[] |
split(java.lang.String toSplit,
java.lang.String delimiter)
Deprecated.
Split a
String at the first occurrence of the delimiter. |
static java.util.Properties |
splitArrayElementsIntoProperties(java.lang.String[] array,
java.lang.String delimiter)
Deprecated.
Take an array of strings and split each element based on the given delimiter.
|
static java.util.Properties |
splitArrayElementsIntoProperties(java.lang.String[] array,
java.lang.String delimiter,
java.lang.String charsToDelete)
Deprecated.
Take an array of strings and split each element based on the given delimiter.
|
static boolean |
startsWithIgnoreCase(java.lang.String str,
java.lang.String prefix)
Deprecated.
Test if the given
String starts with the specified prefix, ignoring upper/lower case. |
static java.lang.String |
stripFilenameExtension(java.lang.String path)
Deprecated.
Strip the filename extension from the given Java resource path, e.g.
|
static boolean |
substringMatch(java.lang.CharSequence str,
int index,
java.lang.CharSequence substring)
Deprecated.
Test whether the given string matches the given substring at the given index.
|
static java.lang.String[] |
tokenizeToStringArray(java.lang.String str,
java.lang.String delimiters)
Deprecated.
Tokenize the given
String into a String array via a StringTokenizer. |
static java.lang.String[] |
tokenizeToStringArray(java.lang.String str,
java.lang.String delimiters,
boolean trimTokens,
boolean ignoreEmptyTokens)
Deprecated.
Tokenize the given
String into a String array via a StringTokenizer. |
static java.lang.String |
toLanguageTag(java.util.Locale locale)
Deprecated.
Determine the RFC 3066 compliant language tag, as used for the HTTP "Accept-Language" header.
|
static java.lang.String[] |
toStringArray(java.util.Collection<java.lang.String> collection)
Deprecated.
Copy the given
Collection into a String array. |
static java.lang.String[] |
toStringArray(java.util.Enumeration<java.lang.String> enumeration)
Deprecated.
Copy the given Enumeration into a
String array. |
static java.lang.String |
trimAllWhitespace(java.lang.String str)
Deprecated.
Trim all whitespace from the given
String: leading, trailing, and in between characters. |
static java.lang.String[] |
trimArrayElements(java.lang.String[] array)
Deprecated.
Trim the elements of the given
String array, calling String.trim() on each of them. |
static java.lang.String |
trimLeadingCharacter(java.lang.String str,
char leadingCharacter)
Deprecated.
Trim all occurrences of the supplied leading character from the given
String. |
static java.lang.String |
trimLeadingWhitespace(java.lang.String str)
Deprecated.
Trim leading whitespace from the given
String. |
static java.lang.String |
trimTrailingCharacter(java.lang.String str,
char trailingCharacter)
Deprecated.
Trim all occurrences of the supplied trailing character from the given
String. |
static java.lang.String |
trimTrailingWhitespace(java.lang.String str)
Deprecated.
Trim trailing whitespace from the given
String. |
static java.lang.String |
trimWhitespace(java.lang.String str)
Deprecated.
Trim leading and trailing whitespace from the given
String. |
static java.lang.String |
uncapitalize(java.lang.String str)
Deprecated.
Uncapitalize a
String, changing the first letter to lower case as per Character.toLowerCase(char). |
static java.lang.String |
unqualify(java.lang.String qualifiedName)
Deprecated.
Unqualify a string qualified by a '.' dot character.
|
static java.lang.String |
unqualify(java.lang.String qualifiedName,
char separator)
Deprecated.
Unqualify a string qualified by a separator character.
|
public static boolean isEmpty(java.lang.Object str)
String is empty.
This method accepts any Object as an argument, comparing it to null and the empty String. As a consequence, this method will never return true for a non-null non-String object.
The Object signature is useful for general attribute handling code that commonly deals with Strings but generally has to iterate over Objects since attributes may e.g. be primitive value objects as well.
str - the candidate string.public static boolean hasLength(java.lang.CharSequence str)
CharSequence is neither null nor of length 0.
Note: this method returns true for a CharSequence that purely consists of whitespace.
StringUtils.hasLength(null) = false StringUtils.hasLength("") = false
StringUtils.hasLength(" ") = true StringUtils.hasLength("Hello") = true str - the CharSequence to check (may be null).CharSequence is not null and has length.public static boolean hasLength(java.lang.String str)
String is neither null nor of length 0.
Note: this method returns true for a String that purely consists of whitespace.
str - the String to check (may be null).String is not null and has length.public static boolean hasText(java.lang.CharSequence str)
CharSequence contains actual text.
More specifically, this method returns true if the CharSequence is 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 str - the CharSequence to check (may be null).CharSequence is not null, its length is greater than 0, and it does not contain
whitespace only.public static boolean hasText(java.lang.String str)
String contains actual text.
More specifically, this method returns true if the String is not null, its length is greater than 0,
and it contains at least one non-whitespace character.
str - the String to check (may be null).String is not null, its length is greater than 0, and it does not contain whitespace
only.public static boolean containsWhitespace(java.lang.CharSequence str)
CharSequence contains any whitespace characters.str - the CharSequence to check (may be null).CharSequence is not empty and contains at least 1 whitespace character.public static boolean containsWhitespace(java.lang.String str)
String contains any whitespace characters.str - the String to check (may be null).String is not empty and contains at least 1 whitespace character.public static java.lang.String trimWhitespace(java.lang.String str)
String.str - the String to check.String.public static java.lang.String trimAllWhitespace(java.lang.String str)
String: leading, trailing, and in between characters.str - the String to check.String.public static java.lang.String trimLeadingWhitespace(java.lang.String str)
String.str - the String to check.String.public static java.lang.String trimTrailingWhitespace(java.lang.String str)
String.str - the String to check.String.public static java.lang.String trimLeadingCharacter(java.lang.String str,
char leadingCharacter)
String.str - the String to check.leadingCharacter - the leading character to be trimmed.String.public static java.lang.String trimTrailingCharacter(java.lang.String str,
char trailingCharacter)
String.str - the String to check.trailingCharacter - the trailing character to be trimmed.String.public static boolean startsWithIgnoreCase(java.lang.String str,
java.lang.String prefix)
String starts with the specified prefix, ignoring upper/lower case.str - the String to check.prefix - the prefix to look for.public static boolean endsWithIgnoreCase(java.lang.String str,
java.lang.String suffix)
String ends with the specified suffix, ignoring upper/lower case.str - the String to check.suffix - the suffix to look for.public static boolean substringMatch(java.lang.CharSequence str,
int index,
java.lang.CharSequence substring)
str - the original string (or StringBuilder).index - the index in the original string to start matching against.substring - the substring to match at the given index.public static int countOccurrencesOf(java.lang.String str,
java.lang.String sub)
sub in string str.str - string to search in.sub - string to search for.public static java.lang.String replace(java.lang.String inString,
java.lang.String oldPattern,
java.lang.String newPattern)
inString - String to examine.oldPattern - String to replace.newPattern - String to insert.String with the replacements.public static java.lang.String delete(java.lang.String inString,
java.lang.String pattern)
inString - the original String.pattern - the pattern to delete all occurrences of.String.public static java.lang.String deleteAny(java.lang.String inString,
java.lang.String charsToDelete)
String.inString - the original String.charsToDelete - a set of characters to delete. E.g. "az\n" will delete 'a's, 'z's and new lines.String.public static java.lang.String quote(java.lang.String str)
String with single quotes.str - the input String (e.g. "myString").String (e.g. "'myString'"), or null if the input was null.public static java.lang.Object quoteIfString(java.lang.Object obj)
String with single quotes if it is a String; keeping the Object
as-is else.obj - the input Object (e.g. "myString").String (e.g. "'myString'"), or the input object as-is if not a String.public static java.lang.String unqualify(java.lang.String qualifiedName)
qualifiedName - the qualified name.public static java.lang.String unqualify(java.lang.String qualifiedName,
char separator)
qualifiedName - the qualified name.separator - the separator.public static java.lang.String capitalize(java.lang.String str)
String, changing the first letter to upper case as per Character.toUpperCase(char).
No other letters are changed.str - the String to capitalize.String.public static java.lang.String uncapitalize(java.lang.String str)
String, changing the first letter to lower case as per Character.toLowerCase(char). No other letters are changed.str - the String to uncapitalize.String.public static java.lang.String getFilename(java.lang.String path)
"mypath/myfile.txt" -> "myfile.txt".path - the file path (may be null).public static java.lang.String getFilenameExtension(java.lang.String path)
path - the file path (may be null).public static java.lang.String stripFilenameExtension(java.lang.String path)
path - the file path.public static java.lang.String applyRelativePath(java.lang.String path,
java.lang.String relativePath)
path - the path to start from (usually a full file path).relativePath - the relative path to apply (relative to the full file path above).public static java.lang.String cleanPath(java.lang.String path)
The result is convenient for path comparison. For other uses, notice that Windows separators ("\") are replaced by simple slashes.
path - the original path.public static boolean pathEquals(java.lang.String path1,
java.lang.String path2)
path1 - first path for comparison.path2 - second path for comparison.public static java.util.Locale parseLocaleString(java.lang.String localeString)
localeString value into a Locale. This is the inverse operation of Locale's toString.
localeString - the locale String, following Locale's toString() format ("en",
"en_UK", etc); also accepts spaces as separators, as an alternative to underscores.Locale instance, or null if none.java.lang.IllegalArgumentException - in case of an invalid locale specification.public static java.lang.String toLanguageTag(java.util.Locale locale)
locale - the Locale to transform to a language tag.String.public static java.util.TimeZone parseTimeZoneString(java.lang.String timeZoneString)
timeZoneString value into a TimeZone.timeZoneString - the time zone String, following TimeZone.getTimeZone(String) but
throwing IllegalArgumentException in case of an invalid time zone specification.TimeZone instance.java.lang.IllegalArgumentException - in case of an invalid time zone specification.public static java.lang.String[] addStringToArray(java.lang.String[] array,
java.lang.String str)
String to the given String array, returning a new array consisting of the input
array contents plus the given String.array - the array to append to (can be null).str - the String to append.null).public static java.lang.String[] concatenateStringArrays(java.lang.String[] array1,
java.lang.String[] array2)
String arrays into one, with overlapping array elements included twice. The order of elements in the original arrays is preserved.
array1 - the first array (can be null).array2 - the second array (can be null).null if both given arrays were null).public static java.lang.String[] mergeStringArrays(java.lang.String[] array1,
java.lang.String[] array2)
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 occurrence).
array1 - the first array (can be null).array2 - the second array (can be null).null if both given arrays were null).public static java.lang.String[] sortStringArray(java.lang.String[] array)
String array into sorted array.array - the source array.null).public static java.lang.String[] toStringArray(java.util.Collection<java.lang.String> collection)
Collection into a String array. The Collection must contain String elements only.
collection - the Collection to copy.String array.public static java.lang.String[] toStringArray(java.util.Enumeration<java.lang.String> enumeration)
String array. The Enumeration must contain String elements
only.enumeration - the Enumeration to copy.String array.public static java.lang.String[] trimArrayElements(java.lang.String[] array)
String array, calling String.trim() on each of them.array - the original String array.public static java.lang.String[] removeDuplicateStrings(java.lang.String[] array)
As of 4.2, it preserves the original order, as it uses a LinkedHashSet.
array - the String array.public static java.lang.String[] split(java.lang.String toSplit,
java.lang.String delimiter)
String at the first occurrence of the delimiter. Does not include the delimiter in the result.toSplit - the string to split.delimiter - to split the string up with.null if the delimiter wasn't found in the given input
String.public static java.util.Properties splitArrayElementsIntoProperties(java.lang.String[] array,
java.lang.String delimiter)
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.
array - the array to process.delimiter - to split each element using (typically the equals symbol).Properties instance representing the array contents, or null if the array to process
was null or empty.public static java.util.Properties splitArrayElementsIntoProperties(java.lang.String[] array,
java.lang.String delimiter,
java.lang.String charsToDelete)
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.
array - the array to process.delimiter - 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.Properties instance representing the array contents, or null if the array to process
was null or empty.public static java.lang.String[] tokenizeToStringArray(java.lang.String str,
java.lang.String delimiters)
String into a String array via a StringTokenizer. Trims tokens and omits empty tokens.
The given delimiters string can consist of any number of delimiter characters. Each of those
characters
can be used to separate tokens. StandardCookieProcessor delimiter is always a single character; for
multi-character delimiters, consider using delimitedListToStringArray(java.lang.String, java.lang.String).
str - the String to tokenize.delimiters - the delimiter characters, assembled as a String (each of the characters is
individually considered as a delimiter).StringTokenizer,
String.trim(),
delimitedListToStringArray(java.lang.String, java.lang.String)public static java.lang.String[] tokenizeToStringArray(java.lang.String str,
java.lang.String delimiters,
boolean trimTokens,
boolean ignoreEmptyTokens)
String into a String array via a StringTokenizer. The given delimiters string can consist of any number of delimiter characters. Each of those characters can be used to
separate tokens. StandardCookieProcessor delimiter is always a single character; for multi-character delimiters,
consider using delimitedListToStringArray(java.lang.String, java.lang.String).
str - the String to tokenize.delimiters - the delimiter characters, assembled as a String (each of the characters is
individually considered as a delimiter).trimTokens - trim the tokens via String.trim().ignoreEmptyTokens - 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).StringTokenizer,
String.trim(),
delimitedListToStringArray(java.lang.String, java.lang.String)public static java.lang.String[] delimitedListToStringArray(java.lang.String str,
java.lang.String delimiter)
String that is a delimited list and convert it into a String array.
StandardCookieProcessor single delimiter may consist of more than one character, but it will still be
considered as a single delimiter string, rather than as bunch of potential delimiter characters, in contrast to
tokenizeToStringArray(java.lang.String, java.lang.String).
str - the input String.delimiter - the delimiter between elements (this is a single delimiter, rather than a bunch individual
delimiter characters).tokenizeToStringArray(java.lang.String, java.lang.String)public static java.lang.String[] delimitedListToStringArray(java.lang.String str,
java.lang.String delimiter,
java.lang.String charsToDelete)
String that is a delimited list and convert it into a String array.
StandardCookieProcessor single delimiter may consist of more than one character, but it will still be
considered as a single delimiter string, rather than as bunch of potential delimiter characters, in contrast to
tokenizeToStringArray(java.lang.String, java.lang.String).
str - the input String.delimiter - 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.tokenizeToStringArray(java.lang.String, java.lang.String)public static java.lang.String[] commaDelimitedListToStringArray(java.lang.String str)
str - the input String.public static java.util.Set<java.lang.String> commaDelimitedListToSet(java.lang.String str)
Note that this will suppress
duplicates, and as of 4.2, the elements in the returned set will preserve the original order in a LinkedHashSet.
str - the input String.String entries in the list.removeDuplicateStrings(String[])public static java.lang.String collectionToDelimitedString(java.util.Collection<?> coll,
java.lang.String delim,
java.lang.String prefix,
java.lang.String suffix)
Collection to a delimited String (e.g. CSV). Useful for toString()
implementations.
coll - the Collection to convert.delim - the delimiter to use (typically a ",").prefix - the String to start each element with.suffix - the String to end each element with.Stringpublic static java.lang.String collectionToDelimitedString(java.util.Collection<?> coll,
java.lang.String delim)
Collection into a delimited String (e.g. CSV). Useful for toString()
implementations.
coll - the Collection to convert.delim - the delimiter to use (typically a ",").String.public static java.lang.String collectionToCommaDelimitedString(java.util.Collection<?> coll)
Collection into a delimited String (e.g., CSV). Useful for toString()
implementations.
coll - the Collection to convert.String.public static java.lang.String arrayToDelimitedString(java.lang.Object[] arr,
java.lang.String delim)
String array into a delimited String (e.g. CSV). Useful for toString()
implementations.
arr - the array to display.delim - the delimiter to use (typically a ",").String.public static java.lang.String arrayToCommaDelimitedString(java.lang.Object[] arr)
String array into a comma delimited String (i.e., CSV). Useful for toString() implementations.
arr - the array to display.String.