Further tidying of Javadoc.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1592873 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Duncan Jones 2014-05-06 20:41:59 +00:00
parent 01fe91839a
commit daf4b4f98c
1 changed files with 9 additions and 13 deletions

View File

@ -7638,27 +7638,23 @@ public class StringUtils {
/**
* <p>
* Wraps a String with a char.
* Wraps a string with a char.
* <p>
*
* <p>
* A {@code null} input String returns {@code null}.
* </p>
*
* <pre>
* StringUtils.wrap(null, *) = null
* StringUtils.wrap("", *) = ""
* StringUtils.wrap("ab", '\0') = "ab"
* StringUtils.wrap("ab", 'x') = "xabx"
* StringUtils.wrap("ab", '\'') = "'ab'"
* StringUtils.wrap(null, *) = null
* StringUtils.wrap("", *) = ""
* StringUtils.wrap("ab", '\0') = "ab"
* StringUtils.wrap("ab", 'x') = "xabx"
* StringUtils.wrap("ab", '\'') = "'ab'"
* StringUtils.wrap("\"ab\"", '\"') = "\"ab\""
* </pre>
*
* @param str
* the String to be wrapper, may be null
* the string to be wrapped, may be {@code null}
* @param wrapWith
* the char that will wrap str
* @return wrapped String, {@code null} if null String input
* the char that will wrap {@code str}
* @return the wrapped string, or {@code null} if {@code str==null}
* @since 3.4
*/
public static String wrap(String str, char wrapWith) {