diff --git a/src/java/org/apache/commons/lang/StringUtils.java b/src/java/org/apache/commons/lang/StringUtils.java index ad8d96e22..5f9a09aff 100644 --- a/src/java/org/apache/commons/lang/StringUtils.java +++ b/src/java/org/apache/commons/lang/StringUtils.java @@ -84,7 +84,7 @@ * - removes the last part of a String *
  • LeftPad/RightPad/Center/Repeat * - pads a String - *
  • UpperCase/LowerCase/SwapCase/Capitalise/Uncapitalise + *
  • UpperCase/LowerCase/SwapCase/Capitalize/Uncapitalize * - change the case of a String *
  • NestedString * - returns a substring nested within other Strings @@ -144,7 +144,7 @@ * @author Gary Gregory * @author Phil Steitz * @since 1.0 - * @version $Id: StringUtils.java,v 1.93 2003/08/13 23:30:58 scolebourne Exp $ + * @version $Id: StringUtils.java,v 1.94 2003/08/14 00:04:20 bayard Exp $ */ public class StringUtils { // Performance testing notes (JDK 1.4, Jul03, scolebourne) @@ -3410,22 +3410,22 @@ public static String lowerCase(String str) { } /** - *

    Capitalises a String changing the first letter to title case as + *

    Capitalizes a String changing the first letter to title case as * per {@link Character#toTitleCase(char)}. No other letters are changed.

    * *

    A null input String returns null.

    * *
    -     * StringUtils.capitalise(null)  = null
    -     * StringUtils.capitalise("")    = ""
    -     * StringUtils.capitalise("cat") = "Cat"
    -     * StringUtils.capitalise("cAt") = "CAt"
    +     * StringUtils.capitalize(null)  = null
    +     * StringUtils.capitalize("")    = ""
    +     * StringUtils.capitalize("cat") = "Cat"
    +     * StringUtils.capitalize("cAt") = "CAt"
          * 
    * - * @param str the String to capitalise, may be null - * @return the capitalised String, null if null String input + * @param str the String to capitalize, may be null + * @return the capitalized String, null if null String input */ - public static String capitalise(String str) { + public static String capitalize(String str) { int strLen; if (str == null || (strLen = str.length()) == 0) { return str; @@ -3437,22 +3437,29 @@ public static String capitalise(String str) { } /** - *

    Uncapitalises a String changing the first letter to title case as + * @deprecated Use the standardly named {@link #capitalize(String)}. + */ + public static String capitalise(String str) { + return capitalize(str); + } + + /** + *

    Uncapitalizes a String changing the first letter to title case as * per {@link Character#toLowerCase(char)}. No other letters are changed.

    * *

    A null input String returns null.

    * *
    -     * StringUtils.uncapitalise(null)  = null
    -     * StringUtils.uncapitalise("")    = ""
    -     * StringUtils.uncapitalise("Cat") = "cat"
    -     * StringUtils.uncapitalise("CAT") = "cAT"
    +     * StringUtils.uncapitalize(null)  = null
    +     * StringUtils.uncapitalize("")    = ""
    +     * StringUtils.uncapitalize("Cat") = "cat"
    +     * StringUtils.uncapitalize("CAT") = "cAT"
          * 
    * - * @param str the String to uncapitalise, may be null - * @return the uncapitalised String, null if null String input + * @param str the String to uncapitalize, may be null + * @return the uncapitalized String, null if null String input */ - public static String uncapitalise(String str) { + public static String uncapitalize(String str) { int strLen; if (str == null || (strLen = str.length()) == 0) { return str; @@ -3463,6 +3470,13 @@ public static String uncapitalise(String str) { .toString(); } + /** + * @deprecated Use the standardly named {@link #uncapitalize(String)}. + */ + public static String uncapitalise(String str) { + return uncapitalize(str); + } + /** *

    Swaps the case of a String using a word based algorithm.

    * @@ -3518,22 +3532,22 @@ public static String swapCase(String str) { } /** - *

    Capitalises all the whitespace separated words in a String. + *

    Capitalizes all the whitespace separated words in a String. * Only the first letter of each word is changed.

    * *

    Whitespace is defined by {@link Character#isWhitespace(char)}. * A null input String returns null.

    * *
    -     * StringUtils.capitaliseAllWords(null)        = null
    -     * StringUtils.capitaliseAllWords("")          = ""
    -     * StringUtils.capitaliseAllWords("i am FINE") = "I Am FINE"
    +     * StringUtils.capitalizeAllWords(null)        = null
    +     * StringUtils.capitalizeAllWords("")          = ""
    +     * StringUtils.capitalizeAllWords("i am FINE") = "I Am FINE"
          * 
    * - * @param str the String to capitalise, may be null - * @return capitalised String, null if null String input + * @param str the String to capitalize, may be null + * @return capitalized String, null if null String input */ - public static String capitaliseAllWords(String str) { + public static String capitalizeAllWords(String str) { int strLen; if (str == null || (strLen = str.length()) == 0) { return str; @@ -3556,22 +3570,29 @@ public static String capitaliseAllWords(String str) { } /** - *

    Uncapitalises all the whitespace separated words in a String. + * @deprecated Use the standardly named {@link #capitalize(String)}. + */ + public static String capitaliseAllWords(String str) { + return capitalizeAllWords(str); + } + + /** + *

    Uncapitalizes all the whitespace separated words in a String. * Only the first letter of each word is changed.

    * *

    Whitespace is defined by {@link Character#isWhitespace(char)}. * A null input String returns null.

    * *
    -     * StringUtils.uncapitaliseAllWords(null)        = null
    -     * StringUtils.uncapitaliseAllWords("")          = ""
    -     * StringUtils.uncapitaliseAllWords("I Am FINE") = "i am fINE"
    +     * StringUtils.uncapitalizeAllWords(null)        = null
    +     * StringUtils.uncapitalizeAllWords("")          = ""
    +     * StringUtils.uncapitalizeAllWords("I Am FINE") = "i am fINE"
          * 
    * - * @param str the String to uncapitalise, may be null - * @return uncapitalised String, null if null String input + * @param str the String to uncapitalize, may be null + * @return uncapitalized String, null if null String input */ - public static String uncapitaliseAllWords(String str) { + public static String uncapitalizeAllWords(String str) { int strLen; if (str == null || (strLen = str.length()) == 0) { return str; @@ -3593,6 +3614,13 @@ public static String uncapitaliseAllWords(String str) { return buffer.toString(); } + /** + * @deprecated Use the standardly named {@link #uncapitalize(String)}. + */ + public static String uncapitaliseAllWords(String str) { + return uncapitalizeAllWords(str); + } + // Count matches //----------------------------------------------------------------------- /** diff --git a/src/test/org/apache/commons/lang/StringUtilsTest.java b/src/test/org/apache/commons/lang/StringUtilsTest.java index 16929bb49..f69596c22 100644 --- a/src/test/org/apache/commons/lang/StringUtilsTest.java +++ b/src/test/org/apache/commons/lang/StringUtilsTest.java @@ -74,7 +74,7 @@ * @author Holger Krauth * @author Henning P. Schmiedehausen * @author Phil Steitz - * @version $Id: StringUtilsTest.java,v 1.46 2003/08/13 23:08:06 scolebourne Exp $ + * @version $Id: StringUtilsTest.java,v 1.47 2003/08/14 00:04:20 bayard Exp $ */ public class StringUtilsTest extends TestCase { @@ -162,31 +162,31 @@ public void testCaseFunctions() { assertEquals(null, StringUtils.upperCase(null)); assertEquals(null, StringUtils.lowerCase(null)); assertEquals(null, StringUtils.swapCase(null)); - assertEquals(null, StringUtils.capitalise(null)); - assertEquals(null, StringUtils.uncapitalise(null)); - assertEquals(null, StringUtils.capitaliseAllWords(null)); - assertEquals(null, StringUtils.uncapitaliseAllWords(null)); + assertEquals(null, StringUtils.capitalize(null)); + assertEquals(null, StringUtils.uncapitalize(null)); + assertEquals(null, StringUtils.capitalizeAllWords(null)); + assertEquals(null, StringUtils.uncapitalizeAllWords(null)); - assertEquals("capitalise(String) failed", - CAP_FOO, StringUtils.capitalise(FOO) ); - assertEquals("capitalise(empty-string) failed", - "", StringUtils.capitalise("") ); - assertEquals("capitalise(single-char-string) failed", - "X", StringUtils.capitalise("x") ); - assertEquals("capitaliseAllWords(String) failed", - "Foo Bar Baz", StringUtils.capitaliseAllWords(SENTENCE) ); - assertEquals("capitaliseAllWords(empty-string) failed", - "", StringUtils.capitaliseAllWords("") ); - assertEquals("uncapitalise(String) failed", - FOO, StringUtils.uncapitalise(CAP_FOO) ); - assertEquals("uncapitalise(empty-string) failed", - "", StringUtils.uncapitalise("") ); - assertEquals("uncapitalise(single-char-string) failed", - "x", StringUtils.uncapitalise("X") ); - assertEquals("uncapitaliseAllWords(String) failed", - SENTENCE, StringUtils.uncapitaliseAllWords("Foo Bar Baz") ); - assertEquals("uncapitaliseAllWords(empty-string) failed", - "", StringUtils.uncapitaliseAllWords("") ); + assertEquals("capitalize(String) failed", + CAP_FOO, StringUtils.capitalize(FOO) ); + assertEquals("capitalize(empty-string) failed", + "", StringUtils.capitalize("") ); + assertEquals("capitalize(single-char-string) failed", + "X", StringUtils.capitalize("x") ); + assertEquals("capitalizeAllWords(String) failed", + "Foo Bar Baz", StringUtils.capitalizeAllWords(SENTENCE) ); + assertEquals("capitalizeAllWords(empty-string) failed", + "", StringUtils.capitalizeAllWords("") ); + assertEquals("uncapitalize(String) failed", + FOO, StringUtils.uncapitalize(CAP_FOO) ); + assertEquals("uncapitalize(empty-string) failed", + "", StringUtils.uncapitalize("") ); + assertEquals("uncapitalize(single-char-string) failed", + "x", StringUtils.uncapitalize("X") ); + assertEquals("uncapitalizeAllWords(String) failed", + SENTENCE, StringUtils.uncapitalizeAllWords("Foo Bar Baz") ); + assertEquals("uncapitalizeAllWords(empty-string) failed", + "", StringUtils.uncapitalizeAllWords("") ); assertEquals("upperCase(String) failed", "FOO TEST THING", StringUtils.upperCase("fOo test THING") );