Return-Path: Delivered-To: apmail-directory-commits-archive@www.apache.org Received: (qmail 49421 invoked from network); 1 Nov 2006 19:47:11 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 1 Nov 2006 19:47:11 -0000 Received: (qmail 15498 invoked by uid 500); 1 Nov 2006 19:47:22 -0000 Delivered-To: apmail-directory-commits-archive@directory.apache.org Received: (qmail 15462 invoked by uid 500); 1 Nov 2006 19:47:22 -0000 Mailing-List: contact commits-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 15450 invoked by uid 99); 1 Nov 2006 19:47:22 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 01 Nov 2006 11:47:22 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 01 Nov 2006 11:47:10 -0800 Received: by eris.apache.org (Postfix, from userid 65534) id 5520F1A984F; Wed, 1 Nov 2006 11:46:46 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r470056 - /directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java Date: Wed, 01 Nov 2006 19:46:46 -0000 To: commits@directory.apache.org From: elecharny@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20061101194646.5520F1A984F@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: elecharny Date: Wed Nov 1 11:46:45 2006 New Revision: 470056 URL: http://svn.apache.org/viewvc?view=rev&rev=470056 Log: Fixed javadoc Modified: directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java Modified: directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java URL: http://svn.apache.org/viewvc/directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java?view=diff&rev=470056&r1=470055&r2=470056 ============================================================================== --- directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java (original) +++ directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java Wed Nov 1 11:46:45 2006 @@ -323,7 +323,7 @@ * @return the deep trimmed string * @see StringTools#deepTrim( String ) * - * @TODO Replace the toCharArray() by substrig manipulations + * TODO Replace the toCharArray() by substring manipulations */ public static final String deepTrim( String str, boolean toLowerCase ) { @@ -799,8 +799,7 @@ /** * Helper function that returns a char from an hex * - * @param octet - * The hex to dump + * @param hex The hex to dump * @return A char representation of the hex */ public static final char dumpHex( byte hex ) @@ -1153,12 +1152,11 @@ * Return the Unicode char which is coded in the bytes at the given * position. * - * @param bytes - * The byte[] represntation of an Unicode string. - * @param pos - * The current position to start decoding the char - * @return The decoded char, or -1 if no char can be decoded TODO : Should - * stop after the third byte, as a char is only 2 bytes long. + * @param car The character to be transformed to an array of bytes + * + * @return The byte array representing the char + * + * TODO : Should stop after the third byte, as a char is only 2 bytes long. */ public static final byte[] charToBytes( char car ) { @@ -1317,7 +1315,7 @@ * The string which contains the data * @param index * Current position in the string - * @param test + * @param text * The text we want to check * @return true if the string contains the text. */ @@ -2002,9 +2000,9 @@ * StringUtils.trim(" abc ") = "abc" * * - * @param str - * the String to be trimmed, may be null - * @return the trimmed string, null if null String input + * @param bytes the byte array to be trimmed, may be null + * + * @return the trimmed byte array */ public static final byte[] trim( byte[] bytes ) { @@ -2108,21 +2106,21 @@ /** *

- * Removes spaces (char <= 32) from start of this array, handling + * Removes spaces (char <= 32) from a position in this array, handling * null by returning null. *

* Trim removes start characters <= 32. * * 
      *  StringUtils.trimLeft(null)          = null
-     *  StringUtils.trimLeft("")            = ""
-     *  StringUtils.trimLeft("     ")       = ""
-     *  StringUtils.trimLeft("abc")         = "abc"
-     *  StringUtils.trimLeft("    abc    ") = "abc    "
+     *  StringUtils.trimLeft("",...)            = ""
+     *  StringUtils.trimLeft("     ",...)       = ""
+     *  StringUtils.trimLeft("abc",...)         = "abc"
+     *  StringUtils.trimLeft("    abc    ",...) = "abc    "
      *
* - * @param string - * the string to be trimmed, may be null + * @param string the string to be trimmed, may be null + * @param pos The starting position * @return the position of the first char which is not a space, or the last * position of the array. */ @@ -2753,7 +2751,6 @@ * String is returned. * * @param str the string containing hex escapes - * @param index the index at which we start decoding * @return decoded string */ public static final String decodeEscapedHex( String str ) throws InvalidNameException