| java.lang.Object
 org.apache.commons.lang.WordUtils
| WordUtils | | public class WordUtils (Code) | | Operations on Strings that contain words.
This class tries to handle null input gracefully.
An exception will not be thrown for a null input.
Each method documents its behaviour in more detail.
author:
Apache Jakarta Velocity
author:
Stephen Colebourne
author:
Henning P. Schmiedehausen
author:
Gary Gregory
since:
2.0
version:
$Id: WordUtils.java 471626 2006-11-06 04:02:09Z bayard $ |
| Constructor Summary | |
| public | WordUtils()
WordUtils instances should NOT be constructed in
standard programming.
|
| Method Summary | |
| public static String | capitalize(String str)
Capitalizes all the whitespace separated words in a String.
Only the first letter of each word is changed. | | public static String | capitalize(String str, char[] delimiters)
Capitalizes all the delimiter separated words in a String.
Only the first letter of each word is changed. | | public static String | capitalizeFully(String str)
Converts all the whitespace separated words in a String into capitalized words,
that is each word is made up of a titlecase character and then a series of
lowercase characters. | | public static String | capitalizeFully(String str, char[] delimiters)
Converts all the delimiter separated words in a String into capitalized words,
that is each word is made up of a titlecase character and then a series of
lowercase characters. | | public static String | initials(String str)
Extracts the initial letters from each word in the String.
The first letter of the string and all first letters after
whitespace are returned as a new string. | | public static String | initials(String str, char[] delimiters)
Extracts the initial letters from each word in the String.
The first letter of the string and all first letters after the
defined delimiters are returned as a new string. | | public static String | swapCase(String str)
Swaps the case of a String using a word based algorithm.
- Upper case character converts to Lower case
- Title case character converts to Lower case
- Lower case character after Whitespace or at start converts to Title case
- Other Lower case character converts to Upper case
Whitespace is defined by
Character.isWhitespace(char) . | | public static String | uncapitalize(String str)
Uncapitalizes all the whitespace separated words in a String. | | public static String | uncapitalize(String str, char[] delimiters)
Uncapitalizes all the whitespace separated words in a String.
Only the first letter of each word is changed.
The delimiters represent a set of characters understood to separate words.
The first string character and the first non-delimiter character after a
delimiter will be uncapitalized. | | public static String | wrap(String str, int wrapLength)
Wraps a single line of text, identifying words by ' '.
New lines will be separated by the system property line separator. | | public static String | wrap(String str, int wrapLength, String newLineStr, boolean wrapLongWords)
Wraps a single line of text, identifying words by ' '.
Leading spaces on a new line are stripped. |
| WordUtils | | public WordUtils()(Code) | | WordUtils instances should NOT be constructed in
standard programming. Instead, the class should be used as
WordUtils.wrap("foo bar", 20);.
This constructor is public to permit tools that require a JavaBean
instance to operate.
|
| capitalize | | public static String capitalize(String str)(Code) | | Capitalizes all the whitespace separated words in a String.
Only the first letter of each word is changed. To convert the
rest of each word to lowercase at the same time,
use
WordUtils.capitalizeFully(String) .
Whitespace is defined by
Character.isWhitespace(char) .
A null input String returns null.
Capitalization uses the unicode title case, normally equivalent to
upper case.
WordUtils.capitalize(null) = null
WordUtils.capitalize("") = ""
WordUtils.capitalize("i am FINE") = "I Am FINE"
Parameters:
str - the String to capitalize, may be null capitalized String, null if null String input
See Also: WordUtils.uncapitalize(String)
See Also: WordUtils.capitalizeFully(String) |
| capitalize | | public static String capitalize(String str, char[] delimiters)(Code) | | Capitalizes all the delimiter separated words in a String.
Only the first letter of each word is changed. To convert the
rest of each word to lowercase at the same time,
use
WordUtils.capitalizeFully(String,char[]) .
The delimiters represent a set of characters understood to separate words.
The first string character and the first non-delimiter character after a
delimiter will be capitalized.
A null input String returns null.
Capitalization uses the unicode title case, normally equivalent to
upper case.
WordUtils.capitalize(null, *) = null
WordUtils.capitalize("", *) = ""
WordUtils.capitalize(*, new char[0]) = *
WordUtils.capitalize("i am fine", null) = "I Am Fine"
WordUtils.capitalize("i aM.fine", {'.'}) = "I aM.Fine"
Parameters:
str - the String to capitalize, may be null
Parameters:
delimiters - set of characters to determine capitalization, null means whitespace capitalized String, null if null String input
See Also: WordUtils.uncapitalize(String)
See Also: WordUtils.capitalizeFully(String)
since:
2.1 |
| capitalizeFully | | public static String capitalizeFully(String str)(Code) | | Converts all the whitespace separated words in a String into capitalized words,
that is each word is made up of a titlecase character and then a series of
lowercase characters.
Whitespace is defined by
Character.isWhitespace(char) .
A null input String returns null.
Capitalization uses the unicode title case, normally equivalent to
upper case.
WordUtils.capitalizeFully(null) = null
WordUtils.capitalizeFully("") = ""
WordUtils.capitalizeFully("i am FINE") = "I Am Fine"
Parameters:
str - the String to capitalize, may be null capitalized String, null if null String input |
| capitalizeFully | | public static String capitalizeFully(String str, char[] delimiters)(Code) | | Converts all the delimiter separated words in a String into capitalized words,
that is each word is made up of a titlecase character and then a series of
lowercase characters.
The delimiters represent a set of characters understood to separate words.
The first string character and the first non-delimiter character after a
delimiter will be capitalized.
A null input String returns null.
Capitalization uses the unicode title case, normally equivalent to
upper case.
WordUtils.capitalizeFully(null, *) = null
WordUtils.capitalizeFully("", *) = ""
WordUtils.capitalizeFully(*, null) = *
WordUtils.capitalizeFully(*, new char[0]) = *
WordUtils.capitalizeFully("i aM.fine", {'.'}) = "I am.Fine"
Parameters:
str - the String to capitalize, may be null
Parameters:
delimiters - set of characters to determine capitalization, null means whitespace capitalized String, null if null String input
since:
2.1 |
| initials | | public static String initials(String str)(Code) | | Extracts the initial letters from each word in the String.
The first letter of the string and all first letters after
whitespace are returned as a new string.
Their case is not changed.
Whitespace is defined by
Character.isWhitespace(char) .
A null input String returns null.
WordUtils.initials(null) = null
WordUtils.initials("") = ""
WordUtils.initials("Ben John Lee") = "BJL"
WordUtils.initials("Ben J.Lee") = "BJ"
Parameters:
str - the String to get initials from, may be null String of initial letters, null if null String input
See Also: WordUtils.initials(String,char[])
since:
2.2 |
| initials | | public static String initials(String str, char[] delimiters)(Code) | | Extracts the initial letters from each word in the String.
The first letter of the string and all first letters after the
defined delimiters are returned as a new string.
Their case is not changed.
If the delimiters array is null, then Whitespace is used.
Whitespace is defined by
Character.isWhitespace(char) .
A null input String returns null.
An empty delimiter array returns an empty String.
WordUtils.initials(null, *) = null
WordUtils.initials("", *) = ""
WordUtils.initials("Ben John Lee", null) = "BJL"
WordUtils.initials("Ben J.Lee", null) = "BJ"
WordUtils.initials("Ben J.Lee", [' ','.']) = "BJL"
WordUtils.initials(*, new char[0]) = ""
Parameters:
str - the String to get initials from, may be null
Parameters:
delimiters - set of characters to determine words, null means whitespace String of initial letters, null if null String input
See Also: WordUtils.initials(String)
since:
2.2 |
| swapCase | | public static String swapCase(String str)(Code) | | Swaps the case of a String using a word based algorithm.
- Upper case character converts to Lower case
- Title case character converts to Lower case
- Lower case character after Whitespace or at start converts to Title case
- Other Lower case character converts to Upper case
Whitespace is defined by
Character.isWhitespace(char) .
A null input String returns null.
StringUtils.swapCase(null) = null
StringUtils.swapCase("") = ""
StringUtils.swapCase("The dog has a BONE") = "tHE DOG HAS A bone"
Parameters:
str - the String to swap case, may be null the changed String, null if null String input |
| uncapitalize | | public static String uncapitalize(String str)(Code) | | Uncapitalizes all the whitespace separated words in a String.
Only the first letter of each word is changed.
Whitespace is defined by
Character.isWhitespace(char) .
A null input String returns null.
WordUtils.uncapitalize(null) = null
WordUtils.uncapitalize("") = ""
WordUtils.uncapitalize("I Am FINE") = "i am fINE"
Parameters:
str - the String to uncapitalize, may be null uncapitalized String, null if null String input
See Also: WordUtils.capitalize(String) |
| uncapitalize | | public static String uncapitalize(String str, char[] delimiters)(Code) | | Uncapitalizes all the whitespace separated words in a String.
Only the first letter of each word is changed.
The delimiters represent a set of characters understood to separate words.
The first string character and the first non-delimiter character after a
delimiter will be uncapitalized.
Whitespace is defined by
Character.isWhitespace(char) .
A null input String returns null.
WordUtils.uncapitalize(null, *) = null
WordUtils.uncapitalize("", *) = ""
WordUtils.uncapitalize(*, null) = *
WordUtils.uncapitalize(*, new char[0]) = *
WordUtils.uncapitalize("I AM.FINE", {'.'}) = "i AM.fINE"
Parameters:
str - the String to uncapitalize, may be null
Parameters:
delimiters - set of characters to determine uncapitalization, null means whitespace uncapitalized String, null if null String input
See Also: WordUtils.capitalize(String)
since:
2.1 |
| wrap | | public static String wrap(String str, int wrapLength)(Code) | | Wraps a single line of text, identifying words by ' '.
New lines will be separated by the system property line separator.
Very long words, such as URLs will not be wrapped.
Leading spaces on a new line are stripped.
Trailing spaces are not stripped.
WordUtils.wrap(null, *) = null
WordUtils.wrap("", *) = ""
Parameters:
str - the String to be word wrapped, may be null
Parameters:
wrapLength - the column to wrap the words at, less than 1 is treated as 1 a line with newlines inserted, null if null input |
| wrap | | public static String wrap(String str, int wrapLength, String newLineStr, boolean wrapLongWords)(Code) | | Wraps a single line of text, identifying words by ' '.
Leading spaces on a new line are stripped.
Trailing spaces are not stripped.
WordUtils.wrap(null, *, *, *) = null
WordUtils.wrap("", *, *, *) = ""
Parameters:
str - the String to be word wrapped, may be null
Parameters:
wrapLength - the column to wrap the words at, less than 1 is treated as 1
Parameters:
newLineStr - the string to insert for a new line, null uses the system property line separator
Parameters:
wrapLongWords - true if long words (such as URLs) should be wrapped a line with newlines inserted, null if null input |
|
|