From 91a22bc49472c0546a3aa71ff0351edaa497cb95 Mon Sep 17 00:00:00 2001
From: Stephen Colebourne <scolebourne@apache.org>
Date: Sun, 20 Jul 2003 14:47:29 +0000
Subject: [PATCH] Add summary javadoc section to StringUtils class Rename
 reverseDelimitedString to reverseDelimited

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137472 13f79535-47bb-0310-9956-ffa450edef68
---
 .../org/apache/commons/lang/StringUtils.java  | 62 ++++++++++++++++---
 .../apache/commons/lang/StringUtilsTest.java  | 14 ++---
 2 files changed, 61 insertions(+), 15 deletions(-)

diff --git a/src/java/org/apache/commons/lang/StringUtils.java b/src/java/org/apache/commons/lang/StringUtils.java
index 4d1c4dfc6..2ab52c096 100644
--- a/src/java/org/apache/commons/lang/StringUtils.java
+++ b/src/java/org/apache/commons/lang/StringUtils.java
@@ -60,6 +60,51 @@ import java.util.List;
 /**
  * <p>Common <code>String</code> manipulation routines that are 
  * <code>null</code> safe.</p>
+ * 
+ * <ul>
+ *  <li><b>IsEmpty/IsBlank</b>
+ *      - checks if a String contains text
+ *  <li><b>Trim/Strip</b>
+ *      - remove leading and trailing whitespace
+ *  <li><b>Equals</b>
+ *      - compare two strings null-safe
+ *  <li><b>IndexOf/LastIndexOf/Contains</b>
+ *      - null-safe index of checks
+ *  <li><b>IndexOfAny/LastIndexOfAny/IndexOfAnyBut/LastIndexOfAnyBut</b>
+ *      - index of any of a set of Strings
+ *  <li><b>ContainsOnly/ContainsNone</b>
+ *      - does String contain only/none of these characters
+ *  <li><b>SubString/Left/Right/Mid</b>
+ *      - null-safe substring extraction
+ *  <li><b>Split</b>
+ *      - splits a String into an array of subtrings based on a separator
+ *  <li><b>Join/Concatenate</b>
+ *      - joins an array of Strings into one with optional separator
+ *  <li><b>Replace/Delete/Overlay</b>
+ *      - Searches a String and replaces one String with another
+ *  <li><b>Chomp/Chop/Slice</b>
+ *      - searches a String and returns the substring before/after the separator
+ *  <li><b>LeftPad/RightPad/Center/Repeat</b>
+ *      - pads a String
+ *  <li><b>UpperCase/LowerCase/SwapCase/Capitalise/Uncapitalise</b>
+ *      - change the case of a String
+ *  <li><b>NestedString</b>
+ *      - returns a substring nested within other Strings
+ *  <li><b>CountMatches</b>
+ *      - counts the number of occurrances of one String in another
+ *  <li><b>IsAlpha/IsNumeric/IsWhitespace</b>
+ *      - checks the characters in a String
+ *  <li><b>DefaultString</b>
+ *      - protects against a null input String
+ *  <li><b>Reverse/ReverseDelimited</b>
+ *      - reverses a String
+ *  <li><b>Abbreviate</b>
+ *      - abbreviates a string using ellipsis
+ *  <li><b>Difference</b>
+ *      - compares two Strings and reports on their differences
+ *  <li><b>LevensteinDistance</b>
+ *      - the number of changes needed to change one String into another
+ * </ul>
  *
  * <p>The <code>StringUtils</code> class defines certain words related to
  * String handling.</p>
@@ -67,8 +112,9 @@ import java.util.List;
  * <ul>
  *  <li>null - <code>null</code>
  *  <li>empty - a zero-length string (<code>""</code>)
- *  <li>space - the space character (<code>' '</code>)(32)
+ *  <li>space - the space character (<code>' '</code>)(char 32)
  *  <li>whitespace - the characters defined by {@link Character#isWhitespace(char)}
+ *  <li>trim - the characters &lt;= 32 as in {@link String#trim(String)}
  * </ul>
  * 
  * <p><code>StringUtils</code> handles <code>null</code> input Strings quietly.
@@ -96,7 +142,7 @@ import java.util.List;
  * @author Arun Mammen Thomas
  * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
  * @since 1.0
- * @version $Id: StringUtils.java,v 1.71 2003/07/20 10:29:22 scolebourne Exp $
+ * @version $Id: StringUtils.java,v 1.72 2003/07/20 14:47:29 scolebourne Exp $
  */
 public class StringUtils {
     // Performance testing notes (JDK 1.4, Jul03, scolebourne)
@@ -3335,17 +3381,17 @@ public class StringUtils {
      * is <code>'.'</code>).</p>
      * 
      * <pre>
-     * StringUtils.reverseDelimitedString(null, '.')    = null
-     * StringUtils.reverseDelimitedString("", '.')      = ""
-     * StringUtils.reverseDelimitedString("a.b.c", 'x') = "a.b.c"
-     * StringUtils.reverseDelimitedString("a.b.c", ".") = "c.b.a"
+     * StringUtils.reverseDelimited(null, '.')    = null
+     * StringUtils.reverseDelimited("", '.')      = ""
+     * StringUtils.reverseDelimited("a.b.c", 'x') = "a.b.c"
+     * StringUtils.reverseDelimited("a.b.c", ".") = "c.b.a"
      * </pre>
      * 
      * @param str  the String to reverse, may be null
      * @param separatorChar  the separator character to use
      * @return the reversed String, <code>null</code> if null String input
      */
-    public static String reverseDelimitedString(String str, char separatorChar) {
+    public static String reverseDelimited(String str, char separatorChar) {
         if (str == null) {
             return null;
         }
@@ -3373,7 +3419,7 @@ public class StringUtils {
      * @param str  the String to reverse, may be null
      * @param separatorChars  the separator characters to use, null treated as whitespace
      * @return the reversed String, <code>null</code> if null String input
-     * @deprecated Use {@link #reverseDelimitedString(String, char)} instead.
+     * @deprecated Use {@link #reverseDelimited(String, char)} instead.
      *      This method is broken as the join doesn't know which char to use.
      *      Method will be removed in Commons Lang 3.0.
      * 
diff --git a/src/test/org/apache/commons/lang/StringUtilsTest.java b/src/test/org/apache/commons/lang/StringUtilsTest.java
index 8e7026240..152e2f33a 100644
--- a/src/test/org/apache/commons/lang/StringUtilsTest.java
+++ b/src/test/org/apache/commons/lang/StringUtilsTest.java
@@ -72,7 +72,7 @@ import junit.textui.TestRunner;
  * @author <a href="mailto:fredrik@westermarck.com>Fredrik Westermarck</a>
  * @author Holger Krauth
  * @author <a href="hps@intermeta.de">Henning P. Schmiedehausen</a>
- * @version $Id: StringUtilsTest.java,v 1.32 2003/07/20 10:29:21 scolebourne Exp $
+ * @version $Id: StringUtilsTest.java,v 1.33 2003/07/20 14:47:29 scolebourne Exp $
  */
 public class StringUtilsTest extends TestCase {
     
@@ -704,12 +704,12 @@ public class StringUtilsTest extends TestCase {
         assertEquals("sdrawkcab", StringUtils.reverse("backwards") );
     }
         
-    public void testReverseDelimitedString_StringChar() {
-        assertEquals(null, StringUtils.reverseDelimitedString(null, '.') );
-        assertEquals("", StringUtils.reverseDelimitedString("", '.') );
-        assertEquals("c.b.a", StringUtils.reverseDelimitedString("a.b.c", '.') );
-        assertEquals("a b c", StringUtils.reverseDelimitedString("a b c", '.') );
-        assertEquals("", StringUtils.reverseDelimitedString("", '.') );
+    public void testReverseDelimited_StringChar() {
+        assertEquals(null, StringUtils.reverseDelimited(null, '.') );
+        assertEquals("", StringUtils.reverseDelimited("", '.') );
+        assertEquals("c.b.a", StringUtils.reverseDelimited("a.b.c", '.') );
+        assertEquals("a b c", StringUtils.reverseDelimited("a b c", '.') );
+        assertEquals("", StringUtils.reverseDelimited("", '.') );
     }
 
     public void testReverseDelimitedString_StringString() {