org.apache.commons.lang
Class WordUtils

java.lang.Object
  org.apache.commons.lang.WordUtils

public class WordUtils

extends Object

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.

Since:

2.0

Version:

$Id: WordUtils.java,v 1.8 2003/08/23 10:39:20 scolebourne Exp $

Author:

Apache Jakarta Velocity, Henri Yandell, Stephen Colebourne, Henning P. Schmiedehausen, Gary Gregory

Constructor Summary

WordUtils()
WordWrapUtils instances should NOT be constructed in standard programming.

Method Summary

static String	capitalize(String str) Capitalizes all the whitespace separated words in a String.
static String	capitalizeFully(String str) Capitalizes all the whitespace separated words in a String.
static String	swapCase(String str) Swaps the case of a String using a word based algorithm.
static String	uncapitalize(String str) Uncapitalizes all the whitespace separated words in a String.
static String	wrap(String str, int wrapLength) Wraps a single line of text, identifying words by ' '.
static String	wrap(String str, int wrapLength, String newLineStr, boolean wrapLongWords) Wraps a single line of text, identifying words by ' '.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WordUtils

public WordUtils()

WordWrapUtils instances should NOT be constructed in standard programming. Instead, the class should be used as WordWrapUtils.wrap("foo bar", 20);.

This constructor is public to permit tools that require a JavaBean instance to operate.

Method Detail

wrap

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. 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

wrapLength - the column to wrap the words at, less than 1 is treated as 1

Returns:

a line with newlines inserted, null if null input

wrap

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. Trailing spaces are not stripped.

 WordUtils.wrap(null, *, *, *) = null
 WordUtils.wrap("", *, *, *) = ""
 

Parameters:

str - the String to be word wrapped, may be null

wrapLength - the column to wrap the words at, less than 1 is treated as 1

newLineStr - the string to insert for a new line, null uses the system property line separator

wrapLongWords - true if long words (such as URLs) should be wrapped

Returns:

a line with newlines inserted, null if null input

capitalize

public static String capitalize(String str)

Capitalizes all the whitespace separated words in a String. Only the first letter of each word is changed. To change all letters to the capitalized case, use 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

Returns:

capitalized String, null if null String input

See Also:

uncapitalize(String), capitalizeFully(String)

capitalizeFully

public static String capitalizeFully(String str)

Capitalizes all the whitespace separated words in a String. All letters are changed, so the resulting string will be fully changed.

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

Returns:

capitalized String, null if null String input

uncapitalize

public static String uncapitalize(String str)

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

Returns:

uncapitalized String, null if null String input

See Also:

capitalize(String)

swapCase

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). 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

Returns:

the changed String, null if null String input