You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by sc...@apache.org on 2011/03/04 17:07:14 UTC
svn commit: r1078032 [4/5] - in
/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3: ./
builder/
Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java?rev=1078032&r1=1078031&r2=1078032&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/StringUtils.java Fri Mar 4 16:07:14 2011
@@ -26,7 +26,7 @@ import java.util.regex.Pattern;
/**
* <p>Operations on {@link java.lang.String} that are
- * <code>null</code> safe.</p>
+ * {@code null} safe.</p>
*
* <ul>
* <li><b>IsEmpty/IsBlank</b>
@@ -77,28 +77,28 @@ import java.util.regex.Pattern;
* - the number of changes needed to change one String into another</li>
* </ul>
*
- * <p>The <code>StringUtils</code> class defines certain words related to
+ * <p>The {@code StringUtils} class defines certain words related to
* String handling.</p>
*
* <ul>
- * <li>null - <code>null</code></li>
- * <li>empty - a zero-length string (<code>""</code>)</li>
- * <li>space - the space character (<code>' '</code>, char 32)</li>
+ * <li>null - {@code null}</li>
+ * <li>empty - a zero-length string ({@code ""})</li>
+ * <li>space - the space character ({@code ' '}, char 32)</li>
* <li>whitespace - the characters defined by {@link Character#isWhitespace(char)}</li>
* <li>trim - the characters <= 32 as in {@link String#trim()}</li>
* </ul>
*
- * <p><code>StringUtils</code> handles <code>null</code> input Strings quietly.
- * That is to say that a <code>null</code> input will return <code>null</code>.
- * Where a <code>boolean</code> or <code>int</code> is being returned
+ * <p>{@code StringUtils} handles {@code null} input Strings quietly.
+ * That is to say that a {@code null} input will return {@code null}.
+ * Where a {@code boolean} or {@code int} is being returned
* details vary by method.</p>
*
- * <p>A side effect of the <code>null</code> handling is that a
- * <code>NullPointerException</code> should be considered a bug in
- * <code>StringUtils</code>.</p>
+ * <p>A side effect of the {@code null} handling is that a
+ * {@code NullPointerException} should be considered a bug in
+ * {@code StringUtils}.</p>
*
* <p>Methods in this class give sample code to explain their operation.
- * The symbol <code>*</code> is used to indicate any input including <code>null</code>.</p>
+ * The symbol {@code *} is used to indicate any input including {@code null}.</p>
*
* <p>#ThreadSafe#</p>
* @see java.lang.String
@@ -143,7 +143,7 @@ public class StringUtils {
// (not sure who tested this)
/**
- * The empty String <code>""</code>.
+ * The empty String {@code ""}.
* @since 2.0
*/
public static final String EMPTY = "";
@@ -165,9 +165,9 @@ public class StringUtils {
private static final Pattern WHITESPACE_BLOCK = Pattern.compile("\\s+");
/**
- * <p><code>StringUtils</code> instances should NOT be constructed in
+ * <p>{@code StringUtils} instances should NOT be constructed in
* standard programming. Instead, the class should be used as
- * <code>StringUtils.trim(" foo ");</code>.</p>
+ * {@code StringUtils.trim(" foo ");}.</p>
*
* <p>This constructor is public to permit tools that require a JavaBean
* instance to operate.</p>
@@ -194,7 +194,7 @@ public class StringUtils {
* That functionality is available in isBlank().</p>
*
* @param cs the CharSequence to check, may be null
- * @return <code>true</code> if the CharSequence is empty or null
+ * @return {@code true} if the CharSequence is empty or null
* @since 3.0 Changed signature from isEmpty(String) to isEmpty(CharSequence)
*/
public static boolean isEmpty(CharSequence cs) {
@@ -213,7 +213,7 @@ public class StringUtils {
* </pre>
*
* @param cs the CharSequence to check, may be null
- * @return <code>true</code> if the CharSequence is not empty and not null
+ * @return {@code true} if the CharSequence is not empty and not null
* @since 3.0 Changed signature from isNotEmpty(String) to isNotEmpty(CharSequence)
*/
public static boolean isNotEmpty(CharSequence cs) {
@@ -232,7 +232,7 @@ public class StringUtils {
* </pre>
*
* @param cs the CharSequence to check, may be null
- * @return <code>true</code> if the CharSequence is null, empty or whitespace
+ * @return {@code true} if the CharSequence is null, empty or whitespace
* @since 2.0
* @since 3.0 Changed signature from isBlank(String) to isBlank(CharSequence)
*/
@@ -261,7 +261,7 @@ public class StringUtils {
* </pre>
*
* @param cs the CharSequence to check, may be null
- * @return <code>true</code> if the CharSequence is
+ * @return {@code true} if the CharSequence is
* not empty and not null and not whitespace
* @since 2.0
* @since 3.0 Changed signature from isNotBlank(String) to isNotBlank(CharSequence)
@@ -274,8 +274,8 @@ public class StringUtils {
//-----------------------------------------------------------------------
/**
* <p>Removes control characters (char <= 32) from both
- * ends of this String, handling <code>null</code> by returning
- * <code>null</code>.</p>
+ * ends of this String, handling {@code null} by returning
+ * {@code null}.</p>
*
* <p>The String is trimmed using {@link String#trim()}.
* Trim removes start and end characters <= 32.
@@ -293,7 +293,7 @@ public class StringUtils {
* </pre>
*
* @param str the String to be trimmed, may be null
- * @return the trimmed string, <code>null</code> if null String input
+ * @return the trimmed string, {@code null} if null String input
*/
public static String trim(String str) {
return str == null ? null : str.trim();
@@ -301,8 +301,8 @@ public class StringUtils {
/**
* <p>Removes control characters (char <= 32) from both
- * ends of this String returning <code>null</code> if the String is
- * empty ("") after the trim or if it is <code>null</code>.
+ * ends of this String returning {@code null} if the String is
+ * empty ("") after the trim or if it is {@code null}.
*
* <p>The String is trimmed using {@link String#trim()}.
* Trim removes start and end characters <= 32.
@@ -318,7 +318,7 @@ public class StringUtils {
*
* @param str the String to be trimmed, may be null
* @return the trimmed String,
- * <code>null</code> if only chars <= 32, empty or null String input
+ * {@code null} if only chars <= 32, empty or null String input
* @since 2.0
*/
public static String trimToNull(String str) {
@@ -329,7 +329,7 @@ public class StringUtils {
/**
* <p>Removes control characters (char <= 32) from both
* ends of this String returning an empty String ("") if the String
- * is empty ("") after the trim or if it is <code>null</code>.
+ * is empty ("") after the trim or if it is {@code null}.
*
* <p>The String is trimmed using {@link String#trim()}.
* Trim removes start and end characters <= 32.
@@ -344,7 +344,7 @@ public class StringUtils {
* </pre>
*
* @param str the String to be trimmed, may be null
- * @return the trimmed String, or an empty String if <code>null</code> input
+ * @return the trimmed String, or an empty String if {@code null} input
* @since 2.0
*/
public static String trimToEmpty(String str) {
@@ -359,7 +359,7 @@ public class StringUtils {
* <p>This is similar to {@link #trim(String)} but removes whitespace.
* Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.</p>
+ * <p>A {@code null} input String returns {@code null}.</p>
*
* <pre>
* StringUtils.strip(null) = null
@@ -373,7 +373,7 @@ public class StringUtils {
* </pre>
*
* @param str the String to remove whitespace from, may be null
- * @return the stripped String, <code>null</code> if null String input
+ * @return the stripped String, {@code null} if null String input
*/
public static String strip(String str) {
return strip(str, null);
@@ -381,7 +381,7 @@ public class StringUtils {
/**
* <p>Strips whitespace from the start and end of a String returning
- * <code>null</code> if the String is empty ("") after the strip.</p>
+ * {@code null} if the String is empty ("") after the strip.</p>
*
* <p>This is similar to {@link #trimToNull(String)} but removes whitespace.
* Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
@@ -399,7 +399,7 @@ public class StringUtils {
*
* @param str the String to be stripped, may be null
* @return the stripped String,
- * <code>null</code> if whitespace, empty or null String input
+ * {@code null} if whitespace, empty or null String input
* @since 2.0
*/
public static String stripToNull(String str) {
@@ -412,7 +412,7 @@ public class StringUtils {
/**
* <p>Strips whitespace from the start and end of a String returning
- * an empty String if <code>null</code> input.</p>
+ * an empty String if {@code null} input.</p>
*
* <p>This is similar to {@link #trimToEmpty(String)} but removes whitespace.
* Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
@@ -429,7 +429,7 @@ public class StringUtils {
* </pre>
*
* @param str the String to be stripped, may be null
- * @return the trimmed String, or an empty String if <code>null</code> input
+ * @return the trimmed String, or an empty String if {@code null} input
* @since 2.0
*/
public static String stripToEmpty(String str) {
@@ -441,10 +441,10 @@ public class StringUtils {
* This is similar to {@link String#trim()} but allows the characters
* to be stripped to be controlled.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
+ * <p>A {@code null} input String returns {@code null}.
* An empty string ("") input returns the empty string.</p>
*
- * <p>If the stripChars String is <code>null</code>, whitespace is
+ * <p>If the stripChars String is {@code null}, whitespace is
* stripped as defined by {@link Character#isWhitespace(char)}.
* Alternatively use {@link #strip(String)}.</p>
*
@@ -460,7 +460,7 @@ public class StringUtils {
*
* @param str the String to remove characters from, may be null
* @param stripChars the characters to remove, null treated as whitespace
- * @return the stripped String, <code>null</code> if null String input
+ * @return the stripped String, {@code null} if null String input
*/
public static String strip(String str, String stripChars) {
if (isEmpty(str)) {
@@ -473,10 +473,10 @@ public class StringUtils {
/**
* <p>Strips any of a set of characters from the start of a String.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
+ * <p>A {@code null} input String returns {@code null}.
* An empty string ("") input returns the empty string.</p>
*
- * <p>If the stripChars String is <code>null</code>, whitespace is
+ * <p>If the stripChars String is {@code null}, whitespace is
* stripped as defined by {@link Character#isWhitespace(char)}.</p>
*
* <pre>
@@ -492,7 +492,7 @@ public class StringUtils {
*
* @param str the String to remove characters from, may be null
* @param stripChars the characters to remove, null treated as whitespace
- * @return the stripped String, <code>null</code> if null String input
+ * @return the stripped String, {@code null} if null String input
*/
public static String stripStart(String str, String stripChars) {
int strLen;
@@ -517,10 +517,10 @@ public class StringUtils {
/**
* <p>Strips any of a set of characters from the end of a String.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
+ * <p>A {@code null} input String returns {@code null}.
* An empty string ("") input returns the empty string.</p>
*
- * <p>If the stripChars String is <code>null</code>, whitespace is
+ * <p>If the stripChars String is {@code null}, whitespace is
* stripped as defined by {@link Character#isWhitespace(char)}.</p>
*
* <pre>
@@ -537,7 +537,7 @@ public class StringUtils {
*
* @param str the String to remove characters from, may be null
* @param stripChars the set of characters to remove, null treated as whitespace
- * @return the stripped String, <code>null</code> if null String input
+ * @return the stripped String, {@code null} if null String input
*/
public static String stripEnd(String str, String stripChars) {
int end;
@@ -566,9 +566,9 @@ public class StringUtils {
* Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
* <p>A new array is returned each time, except for length zero.
- * A <code>null</code> array will return <code>null</code>.
+ * A {@code null} array will return {@code null}.
* An empty array will return itself.
- * A <code>null</code> array entry will be ignored.</p>
+ * A {@code null} array entry will be ignored.</p>
*
* <pre>
* StringUtils.stripAll(null) = null
@@ -578,7 +578,7 @@ public class StringUtils {
* </pre>
*
* @param strs the array to remove whitespace from, may be null
- * @return the stripped Strings, <code>null</code> if null array input
+ * @return the stripped Strings, {@code null} if null array input
*/
public static String[] stripAll(String[] strs) {
return stripAll(strs, null);
@@ -590,10 +590,10 @@ public class StringUtils {
* Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
* <p>A new array is returned each time, except for length zero.
- * A <code>null</code> array will return <code>null</code>.
+ * A {@code null} array will return {@code null}.
* An empty array will return itself.
- * A <code>null</code> array entry will be ignored.
- * A <code>null</code> stripChars will strip whitespace as defined by
+ * A {@code null} array entry will be ignored.
+ * A {@code null} stripChars will strip whitespace as defined by
* {@link Character#isWhitespace(char)}.</p>
*
* <pre>
@@ -607,7 +607,7 @@ public class StringUtils {
*
* @param strs the array to remove characters from, may be null
* @param stripChars the characters to remove, null treated as whitespace
- * @return the stripped Strings, <code>null</code> if null array input
+ * @return the stripped Strings, {@code null} if null array input
*/
public static String[] stripAll(String[] strs, String stripChars) {
int strsLen;
@@ -748,9 +748,9 @@ public class StringUtils {
// Equals
//-----------------------------------------------------------------------
/**
- * <p>Compares two CharSequences, returning <code>true</code> if they are equal.</p>
+ * <p>Compares two CharSequences, returning {@code true} if they are equal.</p>
*
- * <p><code>null</code>s are handled without exceptions. Two <code>null</code>
+ * <p>{@code null}s are handled without exceptions. Two {@code null}
* references are considered to be equal. The comparison is case sensitive.</p>
*
* <pre>
@@ -764,8 +764,8 @@ public class StringUtils {
* @see java.lang.String#equals(Object)
* @param cs1 the first CharSequence, may be null
* @param cs2 the second CharSequence, may be null
- * @return <code>true</code> if the CharSequences are equal, case sensitive, or
- * both <code>null</code>
+ * @return {@code true} if the CharSequences are equal, case sensitive, or
+ * both {@code null}
* @since 3.0 Changed signature from equals(String, String) to equals(CharSequence, CharSequence)
*/
public static boolean equals(CharSequence cs1, CharSequence cs2) {
@@ -773,10 +773,10 @@ public class StringUtils {
}
/**
- * <p>Compares two Strings, returning <code>true</code> if they are equal ignoring
+ * <p>Compares two Strings, returning {@code true} if they are equal ignoring
* the case.</p>
*
- * <p><code>null</code>s are handled without exceptions. Two <code>null</code>
+ * <p>{@code null}s are handled without exceptions. Two {@code null}
* references are considered equal. Comparison is case insensitive.</p>
*
* <pre>
@@ -790,8 +790,8 @@ public class StringUtils {
* @see java.lang.String#equalsIgnoreCase(String)
* @param str1 the first String, may be null
* @param str2 the second String, may be null
- * @return <code>true</code> if the Strings are equal, case insensitive, or
- * both <code>null</code>
+ * @return {@code true} if the Strings are equal, case insensitive, or
+ * both {@code null}
*/
public static boolean equalsIgnoreCase(String str1, String str2) {
return str1 == null ? str2 == null : str1.equalsIgnoreCase(str2);
@@ -800,10 +800,10 @@ public class StringUtils {
// IndexOf
//-----------------------------------------------------------------------
/**
- * <p>Finds the first index within a String, handling <code>null</code>.
+ * <p>Finds the first index within a String, handling {@code null}.
* This method uses {@link String#indexOf(int)}.</p>
*
- * <p>A <code>null</code> or empty ("") String will return <code>INDEX_NOT_FOUND (-1)</code>.</p>
+ * <p>A {@code null} or empty ("") String will return {@code INDEX_NOT_FOUND (-1)}.</p>
*
* <pre>
* StringUtils.indexOf(null, *) = -1
@@ -815,7 +815,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchChar the character to find
* @return the first index of the search character,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.0
*/
public static int indexOf(String str, int searchChar) {
@@ -827,12 +827,12 @@ public class StringUtils {
/**
* <p>Finds the first index within a String from a start position,
- * handling <code>null</code>.
+ * handling {@code null}.
* This method uses {@link String#indexOf(int, int)}.</p>
*
- * <p>A <code>null</code> or empty ("") String will return <code>(INDEX_NOT_FOUND) -1</code>.
+ * <p>A {@code null} or empty ("") String will return {@code (INDEX_NOT_FOUND) -1}.
* A negative start position is treated as zero.
- * A start position greater than the string length returns <code>-1</code>.</p>
+ * A start position greater than the string length returns {@code -1}.</p>
*
* <pre>
* StringUtils.indexOf(null, *, *) = -1
@@ -847,7 +847,7 @@ public class StringUtils {
* @param searchChar the character to find
* @param startPos the start position, negative treated as zero
* @return the first index of the search character,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.0
*/
public static int indexOf(String str, int searchChar, int startPos) {
@@ -858,10 +858,10 @@ public class StringUtils {
}
/**
- * <p>Finds the first index within a String, handling <code>null</code>.
+ * <p>Finds the first index within a String, handling {@code null}.
* This method uses {@link String#indexOf(String)}.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.</p>
+ * <p>A {@code null} String will return {@code -1}.</p>
*
* <pre>
* StringUtils.indexOf(null, *) = -1
@@ -877,7 +877,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
* @return the first index of the search String,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.0
*/
public static int indexOf(String str, String searchStr) {
@@ -888,10 +888,10 @@ public class StringUtils {
}
/**
- * <p>Finds the first index within a String, handling <code>null</code>.
+ * <p>Finds the first index within a String, handling {@code null}.
* This method uses {@link String#indexOf(String, int)}.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
+ * <p>A {@code null} String will return {@code -1}.
* A negative start position is treated as zero.
* An empty ("") search String always matches.
* A start position greater than the string length only matches
@@ -916,7 +916,7 @@ public class StringUtils {
* @param searchStr the String to find, may be null
* @param startPos the start position, negative treated as zero
* @return the first index of the search String,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.0
*/
public static int indexOf(String str, String searchStr, int startPos) {
@@ -927,10 +927,10 @@ public class StringUtils {
}
/**
- * <p>Finds the n-th index within a String, handling <code>null</code>.
+ * <p>Finds the n-th index within a String, handling {@code null}.
* This method uses {@link String#indexOf(String)}.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.</p>
+ * <p>A {@code null} String will return {@code -1}.</p>
*
* <pre>
* StringUtils.ordinalIndexOf(null, *, *) = -1
@@ -954,9 +954,9 @@ public class StringUtils {
*
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
- * @param ordinal the n-th <code>searchStr</code> to find
+ * @param ordinal the n-th {@code searchStr} to find
* @return the n-th index of the search String,
- * <code>-1</code> (<code>INDEX_NOT_FOUND</code>) if no match or <code>null</code> string input
+ * {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input
* @since 2.1
*/
public static int ordinalIndexOf(String str, String searchStr, int ordinal) {
@@ -964,17 +964,17 @@ public class StringUtils {
}
/**
- * <p>Finds the n-th index within a String, handling <code>null</code>.
+ * <p>Finds the n-th index within a String, handling {@code null}.
* This method uses {@link String#indexOf(String)}.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.</p>
+ * <p>A {@code null} String will return {@code -1}.</p>
*
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
- * @param ordinal the n-th <code>searchStr</code> to find
+ * @param ordinal the n-th {@code searchStr} to find
* @param lastIndex true if lastOrdinalIndexOf() otherwise false if ordinalIndexOf()
* @return the n-th index of the search String,
- * <code>-1</code> (<code>INDEX_NOT_FOUND</code>) if no match or <code>null</code> string input
+ * {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input
*/
// Shared code between ordinalIndexOf(String,String,int) and lastOrdinalIndexOf(String,String,int)
private static int ordinalIndexOf(String str, String searchStr, int ordinal, boolean lastIndex) {
@@ -1003,7 +1003,7 @@ public class StringUtils {
/**
* <p>Case in-sensitive find of the first index within a String.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
+ * <p>A {@code null} String will return {@code -1}.
* A negative start position is treated as zero.
* An empty ("") search String always matches.
* A start position greater than the string length only matches
@@ -1021,7 +1021,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
* @return the first index of the search String,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.5
*/
public static int indexOfIgnoreCase(String str, String searchStr) {
@@ -1032,7 +1032,7 @@ public class StringUtils {
* <p>Case in-sensitive find of the first index within a String
* from the specified position.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
+ * <p>A {@code null} String will return {@code -1}.
* A negative start position is treated as zero.
* An empty ("") search String always matches.
* A start position greater than the string length only matches
@@ -1056,7 +1056,7 @@ public class StringUtils {
* @param searchStr the String to find, may be null
* @param startPos the start position, negative treated as zero
* @return the first index of the search String,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.5
*/
public static int indexOfIgnoreCase(String str, String searchStr, int startPos) {
@@ -1084,10 +1084,10 @@ public class StringUtils {
// LastIndexOf
//-----------------------------------------------------------------------
/**
- * <p>Finds the last index within a String, handling <code>null</code>.
+ * <p>Finds the last index within a String, handling {@code null}.
* This method uses {@link String#lastIndexOf(int)}.</p>
*
- * <p>A <code>null</code> or empty ("") String will return <code>-1</code>.</p>
+ * <p>A {@code null} or empty ("") String will return {@code -1}.</p>
*
* <pre>
* StringUtils.lastIndexOf(null, *) = -1
@@ -1099,7 +1099,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchChar the character to find
* @return the last index of the search character,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.0
*/
public static int lastIndexOf(String str, int searchChar) {
@@ -1111,11 +1111,11 @@ public class StringUtils {
/**
* <p>Finds the last index within a String from a start position,
- * handling <code>null</code>.
+ * handling {@code null}.
* This method uses {@link String#lastIndexOf(int, int)}.</p>
*
- * <p>A <code>null</code> or empty ("") String will return <code>-1</code>.
- * A negative start position returns <code>-1</code>.
+ * <p>A {@code null} or empty ("") String will return {@code -1}.
+ * A negative start position returns {@code -1}.
* A start position greater than the string length searches the whole string.</p>
*
* <pre>
@@ -1133,7 +1133,7 @@ public class StringUtils {
* @param searchChar the character to find
* @param startPos the start position
* @return the last index of the search character,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.0
*/
public static int lastIndexOf(String str, int searchChar, int startPos) {
@@ -1144,10 +1144,10 @@ public class StringUtils {
}
/**
- * <p>Finds the last index within a String, handling <code>null</code>.
+ * <p>Finds the last index within a String, handling {@code null}.
* This method uses {@link String#lastIndexOf(String)}.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.</p>
+ * <p>A {@code null} String will return {@code -1}.</p>
*
* <pre>
* StringUtils.lastIndexOf(null, *) = -1
@@ -1162,7 +1162,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
* @return the last index of the search String,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.0
*/
public static int lastIndexOf(String str, String searchStr) {
@@ -1173,10 +1173,10 @@ public class StringUtils {
}
/**
- * <p>Finds the n-th last index within a String, handling <code>null</code>.
+ * <p>Finds the n-th last index within a String, handling {@code null}.
* This method uses {@link String#lastIndexOf(String)}.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.</p>
+ * <p>A {@code null} String will return {@code -1}.</p>
*
* <pre>
* StringUtils.lastOrdinalIndexOf(null, *, *) = -1
@@ -1200,9 +1200,9 @@ public class StringUtils {
*
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
- * @param ordinal the n-th last <code>searchStr</code> to find
+ * @param ordinal the n-th last {@code searchStr} to find
* @return the n-th last index of the search String,
- * <code>-1</code> (<code>INDEX_NOT_FOUND</code>) if no match or <code>null</code> string input
+ * {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input
* @since 2.5
*/
public static int lastOrdinalIndexOf(String str, String searchStr, int ordinal) {
@@ -1210,11 +1210,11 @@ public class StringUtils {
}
/**
- * <p>Finds the first index within a String, handling <code>null</code>.
+ * <p>Finds the first index within a String, handling {@code null}.
* This method uses {@link String#lastIndexOf(String, int)}.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
- * A negative start position returns <code>-1</code>.
+ * <p>A {@code null} String will return {@code -1}.
+ * A negative start position returns {@code -1}.
* An empty ("") search String always matches unless the start position is negative.
* A start position greater than the string length searches the whole string.</p>
*
@@ -1234,7 +1234,7 @@ public class StringUtils {
* @param searchStr the String to find, may be null
* @param startPos the start position, negative treated as zero
* @return the first index of the search String,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.0
*/
public static int lastIndexOf(String str, String searchStr, int startPos) {
@@ -1247,8 +1247,8 @@ public class StringUtils {
/**
* <p>Case in-sensitive find of the last index within a String.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
- * A negative start position returns <code>-1</code>.
+ * <p>A {@code null} String will return {@code -1}.
+ * A negative start position returns {@code -1}.
* An empty ("") search String always matches unless the start position is negative.
* A start position greater than the string length searches the whole string.</p>
*
@@ -1263,7 +1263,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
* @return the first index of the search String,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.5
*/
public static int lastIndexOfIgnoreCase(String str, String searchStr) {
@@ -1277,8 +1277,8 @@ public class StringUtils {
* <p>Case in-sensitive find of the last index within a String
* from the specified position.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
- * A negative start position returns <code>-1</code>.
+ * <p>A {@code null} String will return {@code -1}.
+ * A negative start position returns {@code -1}.
* An empty ("") search String always matches unless the start position is negative.
* A start position greater than the string length searches the whole string.</p>
*
@@ -1298,7 +1298,7 @@ public class StringUtils {
* @param searchStr the String to find, may be null
* @param startPos the start position
* @return the first index of the search String,
- * -1 if no match or <code>null</code> string input
+ * -1 if no match or {@code null} string input
* @since 2.5
*/
public static int lastIndexOfIgnoreCase(String str, String searchStr, int startPos) {
@@ -1326,10 +1326,10 @@ public class StringUtils {
// Contains
//-----------------------------------------------------------------------
/**
- * <p>Checks if String contains a search character, handling <code>null</code>.
+ * <p>Checks if String contains a search character, handling {@code null}.
* This method uses {@link String#indexOf(int)}.</p>
*
- * <p>A <code>null</code> or empty ("") String will return <code>false</code>.</p>
+ * <p>A {@code null} or empty ("") String will return {@code false}.</p>
*
* <pre>
* StringUtils.contains(null, *) = false
@@ -1341,7 +1341,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchChar the character to find
* @return true if the String contains the search character,
- * false if not or <code>null</code> string input
+ * false if not or {@code null} string input
* @since 2.0
*/
public static boolean contains(String str, int searchChar) {
@@ -1352,10 +1352,10 @@ public class StringUtils {
}
/**
- * <p>Checks if String contains a search String, handling <code>null</code>.
+ * <p>Checks if String contains a search String, handling {@code null}.
* This method uses {@link String#indexOf(String)}.</p>
*
- * <p>A <code>null</code> String will return <code>false</code>.</p>
+ * <p>A {@code null} String will return {@code false}.</p>
*
* <pre>
* StringUtils.contains(null, *) = false
@@ -1369,7 +1369,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
* @return true if the String contains the search String,
- * false if not or <code>null</code> string input
+ * false if not or {@code null} string input
* @since 2.0
*/
public static boolean contains(String str, String searchStr) {
@@ -1381,10 +1381,10 @@ public class StringUtils {
/**
* <p>Checks if String contains a search String irrespective of case,
- * handling <code>null</code>. Case-insensitivity is defined as by
+ * handling {@code null}. Case-insensitivity is defined as by
* {@link String#equalsIgnoreCase(String)}.
*
- * <p>A <code>null</code> String will return <code>false</code>.</p>
+ * <p>A {@code null} String will return {@code false}.</p>
*
* <pre>
* StringUtils.contains(null, *) = false
@@ -1400,7 +1400,7 @@ public class StringUtils {
* @param str the String to check, may be null
* @param searchStr the String to find, may be null
* @return true if the String contains the search String irrespective of
- * case or false if not or <code>null</code> string input
+ * case or false if not or {@code null} string input
*/
public static boolean containsIgnoreCase(String str, String searchStr) {
if (str == null || searchStr == null) {
@@ -1418,8 +1418,8 @@ public class StringUtils {
/**
* Check whether the given String contains any whitespace characters.
- * @param str the String to check (may be <code>null</code>)
- * @return <code>true</code> if the String is not empty and
+ * @param str the String to check (may be {@code null})
+ * @return {@code true} if the String is not empty and
* contains at least 1 whitespace character
* @see java.lang.Character#isWhitespace
* @since 3.0
@@ -1444,8 +1444,8 @@ public class StringUtils {
* <p>Search a CharSequence to find the first index of any
* character in the given set of characters.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
- * A <code>null</code> or zero length search array will return <code>-1</code>.</p>
+ * <p>A {@code null} String will return {@code -1}.
+ * A {@code null} or zero length search array will return {@code -1}.</p>
*
* <pre>
* StringUtils.indexOfAny(null, *) = -1
@@ -1493,8 +1493,8 @@ public class StringUtils {
* <p>Search a CharSequence to find the first index of any
* character in the given set of characters.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
- * A <code>null</code> search string will return <code>-1</code>.</p>
+ * <p>A {@code null} String will return {@code -1}.
+ * A {@code null} search string will return {@code -1}.</p>
*
* <pre>
* StringUtils.indexOfAny(null, *) = -1
@@ -1525,8 +1525,8 @@ public class StringUtils {
* <p>Checks if the CharSequence contains any character in the given
* set of characters.</p>
*
- * <p>A <code>null</code> CharSequence will return <code>false</code>.
- * A <code>null</code> or zero length search array will return <code>false</code>.</p>
+ * <p>A {@code null} CharSequence will return {@code false}.
+ * A {@code null} or zero length search array will return {@code false}.</p>
*
* <pre>
* StringUtils.containsAny(null, *) = false
@@ -1540,8 +1540,8 @@ public class StringUtils {
*
* @param cs the CharSequence to check, may be null
* @param searchChars the chars to search for, may be null
- * @return the <code>true</code> if any of the chars are found,
- * <code>false</code> if no match or null input
+ * @return the {@code true} if any of the chars are found,
+ * {@code false} if no match or null input
* @since 2.4
*/
public static boolean containsAny(String cs, char[] searchChars) {
@@ -1580,8 +1580,8 @@ public class StringUtils {
* </p>
*
* <p>
- * A <code>null</code> CharSequence will return <code>false</code>. A <code>null</code> search CharSequence will return
- * <code>false</code>.
+ * A {@code null} CharSequence will return {@code false}. A {@code null} search CharSequence will return
+ * {@code false}.
* </p>
*
* <pre>
@@ -1598,7 +1598,7 @@ public class StringUtils {
* the CharSequence to check, may be null
* @param searchChars
* the chars to search for, may be null
- * @return the <code>true</code> if any of the chars are found, <code>false</code> if no match or null input
+ * @return the {@code true} if any of the chars are found, {@code false} if no match or null input
* @since 2.4
*/
public static boolean containsAny(String cs, String searchChars) {
@@ -1614,8 +1614,8 @@ public class StringUtils {
* <p>Searches a CharSequence to find the first index of any
* character not in the given set of characters.</p>
*
- * <p>A <code>null</code> CharSequence will return <code>-1</code>.
- * A <code>null</code> or zero length search array will return <code>-1</code>.</p>
+ * <p>A {@code null} CharSequence will return {@code -1}.
+ * A {@code null} or zero length search array will return {@code -1}.</p>
*
* <pre>
* StringUtils.indexOfAnyBut(null, *) = -1
@@ -1665,8 +1665,8 @@ public class StringUtils {
* <p>Search a String to find the first index of any
* character not in the given set of characters.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
- * A <code>null</code> or empty search string will return <code>-1</code>.</p>
+ * <p>A {@code null} String will return {@code -1}.
+ * A {@code null} or empty search string will return {@code -1}.</p>
*
* <pre>
* StringUtils.indexOfAnyBut(null, *) = -1
@@ -1710,9 +1710,9 @@ public class StringUtils {
/**
* <p>Checks if the CharSequence contains only certain characters.</p>
*
- * <p>A <code>null</code> CharSequence will return <code>false</code>.
- * A <code>null</code> valid character array will return <code>false</code>.
- * An empty CharSequence (length()=0) always returns <code>true</code>.</p>
+ * <p>A {@code null} CharSequence will return {@code false}.
+ * A {@code null} valid character array will return {@code false}.
+ * An empty CharSequence (length()=0) always returns {@code true}.</p>
*
* <pre>
* StringUtils.containsOnly(null, *) = false
@@ -1746,9 +1746,9 @@ public class StringUtils {
/**
* <p>Checks if the CharSequence contains only certain characters.</p>
*
- * <p>A <code>null</code> CharSequence will return <code>false</code>.
- * A <code>null</code> valid character String will return <code>false</code>.
- * An empty String (length()=0) always returns <code>true</code>.</p>
+ * <p>A {@code null} CharSequence will return {@code false}.
+ * A {@code null} valid character String will return {@code false}.
+ * An empty String (length()=0) always returns {@code true}.</p>
*
* <pre>
* StringUtils.containsOnly(null, *) = false
@@ -1778,8 +1778,8 @@ public class StringUtils {
/**
* <p>Checks that the CharSequence does not contain certain characters.</p>
*
- * <p>A <code>null</code> CharSequence will return <code>true</code>.
- * A <code>null</code> invalid character array will return <code>true</code>.
+ * <p>A {@code null} CharSequence will return {@code true}.
+ * A {@code null} invalid character array will return {@code true}.
* An empty CharSequence (length()=0) always returns true.</p>
*
* <pre>
@@ -1831,8 +1831,8 @@ public class StringUtils {
/**
* <p>Checks that the CharSequence does not contain certain characters.</p>
*
- * <p>A <code>null</code> CharSequence will return <code>true</code>.
- * A <code>null</code> invalid character array will return <code>true</code>.
+ * <p>A {@code null} CharSequence will return {@code true}.
+ * A {@code null} invalid character array will return {@code true}.
* An empty String ("") always returns true.</p>
*
* <pre>
@@ -1863,10 +1863,10 @@ public class StringUtils {
/**
* <p>Find the first index of any of a set of potential substrings.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
- * A <code>null</code> or zero length search array will return <code>-1</code>.
- * A <code>null</code> search array entry will be ignored, but a search
- * array containing "" will return <code>0</code> if <code>str</code> is not
+ * <p>A {@code null} String will return {@code -1}.
+ * A {@code null} or zero length search array will return {@code -1}.
+ * A {@code null} search array entry will be ignored, but a search
+ * array containing "" will return {@code 0} if {@code str} is not
* null. This method uses {@link String#indexOf(String)}.</p>
*
* <pre>
@@ -1917,11 +1917,11 @@ public class StringUtils {
/**
* <p>Find the latest index of any of a set of potential substrings.</p>
*
- * <p>A <code>null</code> String will return <code>-1</code>.
- * A <code>null</code> search array will return <code>-1</code>.
- * A <code>null</code> or zero length search array entry will be ignored,
- * but a search array containing "" will return the length of <code>str</code>
- * if <code>str</code> is not null. This method uses {@link String#indexOf(String)}</p>
+ * <p>A {@code null} String will return {@code -1}.
+ * A {@code null} search array will return {@code -1}.
+ * A {@code null} or zero length search array entry will be ignored,
+ * but a search array containing "" will return the length of {@code str}
+ * if {@code str} is not null. This method uses {@link String#indexOf(String)}</p>
*
* <pre>
* StringUtils.lastIndexOfAny(null, *) = -1
@@ -1964,10 +1964,10 @@ public class StringUtils {
/**
* <p>Gets a substring from the specified String avoiding exceptions.</p>
*
- * <p>A negative start position can be used to start <code>n</code>
+ * <p>A negative start position can be used to start {@code n}
* characters from the end of the String.</p>
*
- * <p>A <code>null</code> String will return <code>null</code>.
+ * <p>A {@code null} String will return {@code null}.
* An empty ("") String will return "".</p>
*
* <pre>
@@ -1983,7 +1983,7 @@ public class StringUtils {
* @param str the String to get the substring from, may be null
* @param start the position to start from, negative means
* count back from the end of the String by this many characters
- * @return substring from start position, <code>null</code> if null String input
+ * @return substring from start position, {@code null} if null String input
*/
public static String substring(String str, int start) {
if (str == null) {
@@ -2008,16 +2008,16 @@ public class StringUtils {
/**
* <p>Gets a substring from the specified String avoiding exceptions.</p>
*
- * <p>A negative start position can be used to start/end <code>n</code>
+ * <p>A negative start position can be used to start/end {@code n}
* characters from the end of the String.</p>
*
- * <p>The returned substring starts with the character in the <code>start</code>
- * position and ends before the <code>end</code> position. All position counting is
+ * <p>The returned substring starts with the character in the {@code start}
+ * position and ends before the {@code end} position. All position counting is
* zero-based -- i.e., to start at the beginning of the string use
- * <code>start = 0</code>. Negative start and end positions can be used to
+ * {@code start = 0}. Negative start and end positions can be used to
* specify offsets relative to the end of the String.</p>
*
- * <p>If <code>start</code> is not strictly to the left of <code>end</code>, ""
+ * <p>If {@code start} is not strictly to the left of {@code end}, ""
* is returned.</p>
*
* <pre>
@@ -2038,7 +2038,7 @@ public class StringUtils {
* @param end the position to end at (exclusive), negative means
* count back from the end of the String by this many characters
* @return substring from start position to end positon,
- * <code>null</code> if null String input
+ * {@code null} if null String input
*/
public static String substring(String str, int start, int end) {
if (str == null) {
@@ -2076,10 +2076,10 @@ public class StringUtils {
// Left/Right/Mid
//-----------------------------------------------------------------------
/**
- * <p>Gets the leftmost <code>len</code> characters of a String.</p>
+ * <p>Gets the leftmost {@code len} characters of a String.</p>
*
- * <p>If <code>len</code> characters are not available, or the
- * String is <code>null</code>, the String will be returned without
+ * <p>If {@code len} characters are not available, or the
+ * String is {@code null}, the String will be returned without
* an exception. An empty String is returned if len is negative.</p>
*
* <pre>
@@ -2093,7 +2093,7 @@ public class StringUtils {
*
* @param str the String to get the leftmost characters from, may be null
* @param len the length of the required String
- * @return the leftmost characters, <code>null</code> if null String input
+ * @return the leftmost characters, {@code null} if null String input
*/
public static String left(String str, int len) {
if (str == null) {
@@ -2109,10 +2109,10 @@ public class StringUtils {
}
/**
- * <p>Gets the rightmost <code>len</code> characters of a String.</p>
+ * <p>Gets the rightmost {@code len} characters of a String.</p>
*
- * <p>If <code>len</code> characters are not available, or the String
- * is <code>null</code>, the String will be returned without an
+ * <p>If {@code len} characters are not available, or the String
+ * is {@code null}, the String will be returned without an
* an exception. An empty String is returned if len is negative.</p>
*
* <pre>
@@ -2126,7 +2126,7 @@ public class StringUtils {
*
* @param str the String to get the rightmost characters from, may be null
* @param len the length of the required String
- * @return the rightmost characters, <code>null</code> if null String input
+ * @return the rightmost characters, {@code null} if null String input
*/
public static String right(String str, int len) {
if (str == null) {
@@ -2142,13 +2142,13 @@ public class StringUtils {
}
/**
- * <p>Gets <code>len</code> characters from the middle of a String.</p>
+ * <p>Gets {@code len} characters from the middle of a String.</p>
*
- * <p>If <code>len</code> characters are not available, the remainder
+ * <p>If {@code len} characters are not available, the remainder
* of the String will be returned without an exception. If the
- * String is <code>null</code>, <code>null</code> will be returned.
+ * String is {@code null}, {@code null} will be returned.
* An empty String is returned if len is negative or exceeds the
- * length of <code>str</code>.</p>
+ * length of {@code str}.</p>
*
* <pre>
* StringUtils.mid(null, *, *) = null
@@ -2164,7 +2164,7 @@ public class StringUtils {
* @param str the String to get the characters from, may be null
* @param pos the position to start from, negative treated as zero
* @param len the length of the required String
- * @return the middle characters, <code>null</code> if null String input
+ * @return the middle characters, {@code null} if null String input
*/
public static String mid(String str, int pos, int len) {
if (str == null) {
@@ -2188,9 +2188,9 @@ public class StringUtils {
* <p>Gets the substring before the first occurrence of a separator.
* The separator is not returned.</p>
*
- * <p>A <code>null</code> string input will return <code>null</code>.
+ * <p>A {@code null} string input will return {@code null}.
* An empty ("") string input will return the empty string.
- * A <code>null</code> separator will return the input string.</p>
+ * A {@code null} separator will return the input string.</p>
*
* <p>If nothing is found, the string input is returned.</p>
*
@@ -2208,7 +2208,7 @@ public class StringUtils {
* @param str the String to get a substring from, may be null
* @param separator the String to search for, may be null
* @return the substring before the first occurrence of the separator,
- * <code>null</code> if null String input
+ * {@code null} if null String input
* @since 2.0
*/
public static String substringBefore(String str, String separator) {
@@ -2229,10 +2229,10 @@ public class StringUtils {
* <p>Gets the substring after the first occurrence of a separator.
* The separator is not returned.</p>
*
- * <p>A <code>null</code> string input will return <code>null</code>.
+ * <p>A {@code null} string input will return {@code null}.
* An empty ("") string input will return the empty string.
- * A <code>null</code> separator will return the empty string if the
- * input string is not <code>null</code>.</p>
+ * A {@code null} separator will return the empty string if the
+ * input string is not {@code null}.</p>
*
* <p>If nothing is found, the empty string is returned.</p>
*
@@ -2250,7 +2250,7 @@ public class StringUtils {
* @param str the String to get a substring from, may be null
* @param separator the String to search for, may be null
* @return the substring after the first occurrence of the separator,
- * <code>null</code> if null String input
+ * {@code null} if null String input
* @since 2.0
*/
public static String substringAfter(String str, String separator) {
@@ -2271,9 +2271,9 @@ public class StringUtils {
* <p>Gets the substring before the last occurrence of a separator.
* The separator is not returned.</p>
*
- * <p>A <code>null</code> string input will return <code>null</code>.
+ * <p>A {@code null} string input will return {@code null}.
* An empty ("") string input will return the empty string.
- * An empty or <code>null</code> separator will return the input string.</p>
+ * An empty or {@code null} separator will return the input string.</p>
*
* <p>If nothing is found, the string input is returned.</p>
*
@@ -2291,7 +2291,7 @@ public class StringUtils {
* @param str the String to get a substring from, may be null
* @param separator the String to search for, may be null
* @return the substring before the last occurrence of the separator,
- * <code>null</code> if null String input
+ * {@code null} if null String input
* @since 2.0
*/
public static String substringBeforeLast(String str, String separator) {
@@ -2309,10 +2309,10 @@ public class StringUtils {
* <p>Gets the substring after the last occurrence of a separator.
* The separator is not returned.</p>
*
- * <p>A <code>null</code> string input will return <code>null</code>.
+ * <p>A {@code null} string input will return {@code null}.
* An empty ("") string input will return the empty string.
- * An empty or <code>null</code> separator will return the empty string if
- * the input string is not <code>null</code>.</p>
+ * An empty or {@code null} separator will return the empty string if
+ * the input string is not {@code null}.</p>
*
* <p>If nothing is found, the empty string is returned.</p>
*
@@ -2331,7 +2331,7 @@ public class StringUtils {
* @param str the String to get a substring from, may be null
* @param separator the String to search for, may be null
* @return the substring after the last occurrence of the separator,
- * <code>null</code> if null String input
+ * {@code null} if null String input
* @since 2.0
*/
public static String substringAfterLast(String str, String separator) {
@@ -2354,8 +2354,8 @@ public class StringUtils {
* <p>Gets the String that is nested in between two instances of the
* same String.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> tag returns <code>null</code>.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} tag returns {@code null}.</p>
*
* <pre>
* StringUtils.substringBetween(null, *) = null
@@ -2368,7 +2368,7 @@ public class StringUtils {
*
* @param str the String containing the substring, may be null
* @param tag the String before and after the substring, may be null
- * @return the substring, <code>null</code> if no match
+ * @return the substring, {@code null} if no match
* @since 2.0
*/
public static String substringBetween(String str, String tag) {
@@ -2379,8 +2379,8 @@ public class StringUtils {
* <p>Gets the String that is nested in between two Strings.
* Only the first match is returned.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> open/close returns <code>null</code> (no match).
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} open/close returns {@code null} (no match).
* An empty ("") open and close returns an empty string.</p>
*
* <pre>
@@ -2399,7 +2399,7 @@ public class StringUtils {
* @param str the String containing the substring, may be null
* @param open the String before the substring, may be null
* @param close the String after the substring, may be null
- * @return the substring, <code>null</code> if no match
+ * @return the substring, {@code null} if no match
* @since 2.0
*/
public static String substringBetween(String str, String open, String close) {
@@ -2420,9 +2420,9 @@ public class StringUtils {
* <p>Searches a String for substrings delimited by a start and end tag,
* returning all matching substrings in an array.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> open/close returns <code>null</code> (no match).
- * An empty ("") open/close returns <code>null</code> (no match).</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} open/close returns {@code null} (no match).
+ * An empty ("") open/close returns {@code null} (no match).</p>
*
* <pre>
* StringUtils.substringsBetween("[a][b][c]", "[", "]") = ["a","b","c"]
@@ -2435,7 +2435,7 @@ public class StringUtils {
* @param str the String containing the substrings, null returns null, empty returns empty
* @param open the String identifying the start of the substring, empty returns null
* @param close the String identifying the end of the substring, empty returns null
- * @return a String Array of substrings, or <code>null</code> if no match
+ * @return a String Array of substrings, or {@code null} if no match
* @since 2.3
*/
public static String[] substringsBetween(String str, String open, String close) {
@@ -2483,7 +2483,7 @@ public class StringUtils {
* Adjacent separators are treated as one separator.
* For more control over the split use the StrTokenizer class.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.</p>
+ * <p>A {@code null} input String returns {@code null}.</p>
*
* <pre>
* StringUtils.split(null) = null
@@ -2494,7 +2494,7 @@ public class StringUtils {
* </pre>
*
* @param str the String to parse, may be null
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @return an array of parsed Strings, {@code null} if null String input
*/
public static String[] split(String str) {
return split(str, null, -1);
@@ -2508,7 +2508,7 @@ public class StringUtils {
* Adjacent separators are treated as one separator.
* For more control over the split use the StrTokenizer class.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.</p>
+ * <p>A {@code null} input String returns {@code null}.</p>
*
* <pre>
* StringUtils.split(null, *) = null
@@ -2521,7 +2521,7 @@ public class StringUtils {
*
* @param str the String to parse, may be null
* @param separatorChar the character used as the delimiter
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.0
*/
public static String[] split(String str, char separatorChar) {
@@ -2536,8 +2536,8 @@ public class StringUtils {
* Adjacent separators are treated as one separator.
* For more control over the split use the StrTokenizer class.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> separatorChars splits on whitespace.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} separatorChars splits on whitespace.</p>
*
* <pre>
* StringUtils.split(null, *) = null
@@ -2550,8 +2550,8 @@ public class StringUtils {
*
* @param str the String to parse, may be null
* @param separatorChars the characters used as the delimiters,
- * <code>null</code> splits on whitespace
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * {@code null} splits on whitespace
+ * @return an array of parsed Strings, {@code null} if null String input
*/
public static String[] split(String str, String separatorChars) {
return splitWorker(str, separatorChars, -1, false);
@@ -2564,11 +2564,11 @@ public class StringUtils {
* <p>The separator is not included in the returned String array.
* Adjacent separators are treated as one separator.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> separatorChars splits on whitespace.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} separatorChars splits on whitespace.</p>
*
- * <p>If more than <code>max</code> delimited substrings are found, the last
- * returned string includes all characters after the first <code>max - 1</code>
+ * <p>If more than {@code max} delimited substrings are found, the last
+ * returned string includes all characters after the first {@code max - 1}
* returned strings (including separator characters).</p>
*
* <pre>
@@ -2582,10 +2582,10 @@ public class StringUtils {
*
* @param str the String to parse, may be null
* @param separatorChars the characters used as the delimiters,
- * <code>null</code> splits on whitespace
+ * {@code null} splits on whitespace
* @param max the maximum number of elements to include in the
* array. A zero or negative value implies no limit
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @return an array of parsed Strings, {@code null} if null String input
*/
public static String[] split(String str, String separatorChars, int max) {
return splitWorker(str, separatorChars, max, false);
@@ -2597,8 +2597,8 @@ public class StringUtils {
* <p>The separator(s) will not be included in the returned String array.
* Adjacent separators are treated as one separator.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> separator splits on whitespace.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} separator splits on whitespace.</p>
*
* <pre>
* StringUtils.splitByWholeSeparator(null, *) = null
@@ -2611,8 +2611,8 @@ public class StringUtils {
*
* @param str the String to parse, may be null
* @param separator String containing the String to be used as a delimiter,
- * <code>null</code> splits on whitespace
- * @return an array of parsed Strings, <code>null</code> if null String was input
+ * {@code null} splits on whitespace
+ * @return an array of parsed Strings, {@code null} if null String was input
*/
public static String[] splitByWholeSeparator(String str, String separator) {
return splitByWholeSeparatorWorker( str, separator, -1, false ) ;
@@ -2620,13 +2620,13 @@ public class StringUtils {
/**
* <p>Splits the provided text into an array, separator string specified.
- * Returns a maximum of <code>max</code> substrings.</p>
+ * Returns a maximum of {@code max} substrings.</p>
*
* <p>The separator(s) will not be included in the returned String array.
* Adjacent separators are treated as one separator.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> separator splits on whitespace.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} separator splits on whitespace.</p>
*
* <pre>
* StringUtils.splitByWholeSeparator(null, *, *) = null
@@ -2640,10 +2640,10 @@ public class StringUtils {
*
* @param str the String to parse, may be null
* @param separator String containing the String to be used as a delimiter,
- * <code>null</code> splits on whitespace
+ * {@code null} splits on whitespace
* @param max the maximum number of elements to include in the returned
* array. A zero or negative value implies no limit.
- * @return an array of parsed Strings, <code>null</code> if null String was input
+ * @return an array of parsed Strings, {@code null} if null String was input
*/
public static String[] splitByWholeSeparator( String str, String separator, int max ) {
return splitByWholeSeparatorWorker(str, separator, max, false);
@@ -2656,8 +2656,8 @@ public class StringUtils {
* Adjacent separators are treated as separators for empty tokens.
* For more control over the split use the StrTokenizer class.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> separator splits on whitespace.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} separator splits on whitespace.</p>
*
* <pre>
* StringUtils.splitByWholeSeparatorPreserveAllTokens(null, *) = null
@@ -2670,8 +2670,8 @@ public class StringUtils {
*
* @param str the String to parse, may be null
* @param separator String containing the String to be used as a delimiter,
- * <code>null</code> splits on whitespace
- * @return an array of parsed Strings, <code>null</code> if null String was input
+ * {@code null} splits on whitespace
+ * @return an array of parsed Strings, {@code null} if null String was input
* @since 2.4
*/
public static String[] splitByWholeSeparatorPreserveAllTokens(String str, String separator) {
@@ -2680,14 +2680,14 @@ public class StringUtils {
/**
* <p>Splits the provided text into an array, separator string specified.
- * Returns a maximum of <code>max</code> substrings.</p>
+ * Returns a maximum of {@code max} substrings.</p>
*
* <p>The separator is not included in the returned String array.
* Adjacent separators are treated as separators for empty tokens.
* For more control over the split use the StrTokenizer class.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> separator splits on whitespace.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} separator splits on whitespace.</p>
*
* <pre>
* StringUtils.splitByWholeSeparatorPreserveAllTokens(null, *, *) = null
@@ -2701,10 +2701,10 @@ public class StringUtils {
*
* @param str the String to parse, may be null
* @param separator String containing the String to be used as a delimiter,
- * <code>null</code> splits on whitespace
+ * {@code null} splits on whitespace
* @param max the maximum number of elements to include in the returned
* array. A zero or negative value implies no limit.
- * @return an array of parsed Strings, <code>null</code> if null String was input
+ * @return an array of parsed Strings, {@code null} if null String was input
* @since 2.4
*/
public static String[] splitByWholeSeparatorPreserveAllTokens(String str, String separator, int max) {
@@ -2712,17 +2712,17 @@ public class StringUtils {
}
/**
- * Performs the logic for the <code>splitByWholeSeparatorPreserveAllTokens</code> methods.
+ * Performs the logic for the {@code splitByWholeSeparatorPreserveAllTokens} methods.
*
- * @param str the String to parse, may be <code>null</code>
+ * @param str the String to parse, may be {@code null}
* @param separator String containing the String to be used as a delimiter,
- * <code>null</code> splits on whitespace
+ * {@code null} splits on whitespace
* @param max the maximum number of elements to include in the returned
* array. A zero or negative value implies no limit.
- * @param preserveAllTokens if <code>true</code>, adjacent separators are
- * treated as empty token separators; if <code>false</code>, adjacent
+ * @param preserveAllTokens if {@code true}, adjacent separators are
+ * treated as empty token separators; if {@code false}, adjacent
* separators are treated as one separator.
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.4
*/
private static String[] splitByWholeSeparatorWorker(
@@ -2802,7 +2802,7 @@ public class StringUtils {
* Adjacent separators are treated as separators for empty tokens.
* For more control over the split use the StrTokenizer class.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.</p>
+ * <p>A {@code null} input String returns {@code null}.</p>
*
* <pre>
* StringUtils.splitPreserveAllTokens(null) = null
@@ -2812,8 +2812,8 @@ public class StringUtils {
* StringUtils.splitPreserveAllTokens(" abc ") = ["", "abc", ""]
* </pre>
*
- * @param str the String to parse, may be <code>null</code>
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @param str the String to parse, may be {@code null}
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.1
*/
public static String[] splitPreserveAllTokens(String str) {
@@ -2829,7 +2829,7 @@ public class StringUtils {
* Adjacent separators are treated as separators for empty tokens.
* For more control over the split use the StrTokenizer class.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.</p>
+ * <p>A {@code null} input String returns {@code null}.</p>
*
* <pre>
* StringUtils.splitPreserveAllTokens(null, *) = null
@@ -2846,10 +2846,10 @@ public class StringUtils {
* StringUtils.splitPreserveAllTokens(" a b c ", ' ') = ["", a", "b", "c", ""]
* </pre>
*
- * @param str the String to parse, may be <code>null</code>
+ * @param str the String to parse, may be {@code null}
* @param separatorChar the character used as the delimiter,
- * <code>null</code> splits on whitespace
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * {@code null} splits on whitespace
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.1
*/
public static String[] splitPreserveAllTokens(String str, char separatorChar) {
@@ -2857,16 +2857,16 @@ public class StringUtils {
}
/**
- * Performs the logic for the <code>split</code> and
- * <code>splitPreserveAllTokens</code> methods that do not return a
+ * Performs the logic for the {@code split} and
+ * {@code splitPreserveAllTokens} methods that do not return a
* maximum array length.
*
- * @param str the String to parse, may be <code>null</code>
+ * @param str the String to parse, may be {@code null}
* @param separatorChar the separate character
- * @param preserveAllTokens if <code>true</code>, adjacent separators are
- * treated as empty token separators; if <code>false</code>, adjacent
+ * @param preserveAllTokens if {@code true}, adjacent separators are
+ * treated as empty token separators; if {@code false}, adjacent
* separators are treated as one separator.
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @return an array of parsed Strings, {@code null} if null String input
*/
private static String[] splitWorker(String str, char separatorChar, boolean preserveAllTokens) {
// Performance tuned for 2.0 (JDK1.4)
@@ -2911,8 +2911,8 @@ public class StringUtils {
* Adjacent separators are treated as separators for empty tokens.
* For more control over the split use the StrTokenizer class.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> separatorChars splits on whitespace.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} separatorChars splits on whitespace.</p>
*
* <pre>
* StringUtils.splitPreserveAllTokens(null, *) = null
@@ -2929,10 +2929,10 @@ public class StringUtils {
* StringUtils.splitPreserveAllTokens(":cd:ef:", ":") = ["", cd", "ef", ""]
* </pre>
*
- * @param str the String to parse, may be <code>null</code>
+ * @param str the String to parse, may be {@code null}
* @param separatorChars the characters used as the delimiters,
- * <code>null</code> splits on whitespace
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * {@code null} splits on whitespace
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.1
*/
public static String[] splitPreserveAllTokens(String str, String separatorChars) {
@@ -2948,11 +2948,11 @@ public class StringUtils {
* Adjacent separators are treated as separators for empty tokens.
* Adjacent separators are treated as one separator.</p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
- * A <code>null</code> separatorChars splits on whitespace.</p>
+ * <p>A {@code null} input String returns {@code null}.
+ * A {@code null} separatorChars splits on whitespace.</p>
*
- * <p>If more than <code>max</code> delimited substrings are found, the last
- * returned string includes all characters after the first <code>max - 1</code>
+ * <p>If more than {@code max} delimited substrings are found, the last
+ * returned string includes all characters after the first {@code max - 1}
* returned strings (including separator characters).</p>
*
* <pre>
@@ -2967,12 +2967,12 @@ public class StringUtils {
* StringUtils.splitPreserveAllTokens("ab de fg", null, 4) = ["ab", "", "", "de fg"]
* </pre>
*
- * @param str the String to parse, may be <code>null</code>
+ * @param str the String to parse, may be {@code null}
* @param separatorChars the characters used as the delimiters,
- * <code>null</code> splits on whitespace
+ * {@code null} splits on whitespace
* @param max the maximum number of elements to include in the
* array. A zero or negative value implies no limit
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.1
*/
public static String[] splitPreserveAllTokens(String str, String separatorChars, int max) {
@@ -2980,18 +2980,18 @@ public class StringUtils {
}
/**
- * Performs the logic for the <code>split</code> and
- * <code>splitPreserveAllTokens</code> methods that return a maximum array
+ * Performs the logic for the {@code split} and
+ * {@code splitPreserveAllTokens} methods that return a maximum array
* length.
*
- * @param str the String to parse, may be <code>null</code>
+ * @param str the String to parse, may be {@code null}
* @param separatorChars the separate character
* @param max the maximum number of elements to include in the
* array. A zero or negative value implies no limit.
- * @param preserveAllTokens if <code>true</code>, adjacent separators are
- * treated as empty token separators; if <code>false</code>, adjacent
+ * @param preserveAllTokens if {@code true}, adjacent separators are
+ * treated as empty token separators; if {@code false}, adjacent
* separators are treated as one separator.
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @return an array of parsed Strings, {@code null} if null String input
*/
private static String[] splitWorker(String str, String separatorChars, int max, boolean preserveAllTokens) {
// Performance tuned for 2.0 (JDK1.4)
@@ -3080,7 +3080,7 @@ public class StringUtils {
/**
* <p>Splits a String by Character type as returned by
- * <code>java.lang.Character.getType(char)</code>. Groups of contiguous
+ * {@code java.lang.Character.getType(char)}. Groups of contiguous
* characters of the same type are returned as complete tokens.
* <pre>
* StringUtils.splitByCharacterType(null) = null
@@ -3093,8 +3093,8 @@ public class StringUtils {
* StringUtils.splitByCharacterType("foo200Bar") = ["foo", "200", "B", "ar"]
* StringUtils.splitByCharacterType("ASFRules") = ["ASFR", "ules"]
* </pre>
- * @param str the String to split, may be <code>null</code>
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @param str the String to split, may be {@code null}
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.4
*/
public static String[] splitByCharacterType(String str) {
@@ -3103,13 +3103,13 @@ public class StringUtils {
/**
* <p>Splits a String by Character type as returned by
- * <code>java.lang.Character.getType(char)</code>. Groups of contiguous
+ * {@code java.lang.Character.getType(char)}. Groups of contiguous
* characters of the same type are returned as complete tokens, with the
* following exception: the character of type
- * <code>Character.UPPERCASE_LETTER</code>, if any, immediately
- * preceding a token of type <code>Character.LOWERCASE_LETTER</code>
+ * {@code Character.UPPERCASE_LETTER}, if any, immediately
+ * preceding a token of type {@code Character.LOWERCASE_LETTER}
* will belong to the following token rather than to the preceding, if any,
- * <code>Character.UPPERCASE_LETTER</code> token.
+ * {@code Character.UPPERCASE_LETTER} token.
* <pre>
* StringUtils.splitByCharacterTypeCamelCase(null) = null
* StringUtils.splitByCharacterTypeCamelCase("") = []
@@ -3121,8 +3121,8 @@ public class StringUtils {
* StringUtils.splitByCharacterTypeCamelCase("foo200Bar") = ["foo", "200", "Bar"]
* StringUtils.splitByCharacterTypeCamelCase("ASFRules") = ["ASF", "Rules"]
* </pre>
- * @param str the String to split, may be <code>null</code>
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @param str the String to split, may be {@code null}
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.4
*/
public static String[] splitByCharacterTypeCamelCase(String str) {
@@ -3131,16 +3131,16 @@ public class StringUtils {
/**
* <p>Splits a String by Character type as returned by
- * <code>java.lang.Character.getType(char)</code>. Groups of contiguous
+ * {@code java.lang.Character.getType(char)}. Groups of contiguous
* characters of the same type are returned as complete tokens, with the
- * following exception: if <code>camelCase</code> is <code>true</code>,
- * the character of type <code>Character.UPPERCASE_LETTER</code>, if any,
- * immediately preceding a token of type <code>Character.LOWERCASE_LETTER</code>
+ * following exception: if {@code camelCase} is {@code true},
+ * the character of type {@code Character.UPPERCASE_LETTER}, if any,
+ * immediately preceding a token of type {@code Character.LOWERCASE_LETTER}
* will belong to the following token rather than to the preceding, if any,
- * <code>Character.UPPERCASE_LETTER</code> token.
- * @param str the String to split, may be <code>null</code>
+ * {@code Character.UPPERCASE_LETTER} token.
+ * @param str the String to split, may be {@code null}
* @param camelCase whether to use so-called "camel-case" for letter types
- * @return an array of parsed Strings, <code>null</code> if null String input
+ * @return an array of parsed Strings, {@code null} if null String input
* @since 2.4
*/
private static String[] splitByCharacterType(String str, boolean camelCase) {
@@ -3236,7 +3236,7 @@ public class StringUtils {
* </pre>
*
* @param array the array of values to join together, may be null
- * @return the joined String, <code>null</code> if null array input
+ * @return the joined String, {@code null} if null array input
* @since 2.0
*/
public static String join(Object[] array) {
@@ -3262,7 +3262,7 @@ public class StringUtils {
*
* @param array the array of values to join together, may be null
* @param separator the separator character to use
- * @return the joined String, <code>null</code> if null array input
+ * @return the joined String, {@code null} if null array input
* @since 2.0
*/
public static String join(Object[] array, char separator) {
@@ -3296,7 +3296,7 @@ public class StringUtils {
* an error to pass in an end index past the end of the array
* @param endIndex the index to stop joining from (exclusive). It is
* an error to pass in an end index past the end of the array
- * @return the joined String, <code>null</code> if null array input
+ * @return the joined String, {@code null} if null array input
* @since 2.0
*/
public static String join(Object[] array, char separator, int startIndex, int endIndex) {
@@ -3328,7 +3328,7 @@ public class StringUtils {
* containing the provided list of elements.</p>
*
* <p>No delimiter is added before or after the list.
- * A <code>null</code> separator is the same as an empty String ("").
+ * A {@code null} separator is the same as an empty String ("").
* Null objects or empty strings within the array are represented by
* empty strings.</p>
*
@@ -3344,7 +3344,7 @@ public class StringUtils {
*
* @param array the array of values to join together, may be null
* @param separator the separator character to use, null treated as ""
- * @return the joined String, <code>null</code> if null array input
+ * @return the joined String, {@code null} if null array input
*/
public static String join(Object[] array, String separator) {
if (array == null) {
@@ -3358,7 +3358,7 @@ public class StringUtils {
* containing the provided list of elements.</p>
*
* <p>No delimiter is added before or after the list.
- * A <code>null</code> separator is the same as an empty String ("").
+ * A {@code null} separator is the same as an empty String ("").
* Null objects or empty strings within the array are represented by
* empty strings.</p>
*
@@ -3378,7 +3378,7 @@ public class StringUtils {
* an error to pass in an end index past the end of the array
* @param endIndex the index to stop joining from (exclusive). It is
* an error to pass in an end index past the end of the array
- * @return the joined String, <code>null</code> if null array input
+ * @return the joined String, {@code null} if null array input
*/
public static String join(Object[] array, String separator, int startIndex, int endIndex) {
if (array == null) {
@@ -3412,7 +3412,7 @@ public class StringUtils {
}
/**
- * <p>Joins the elements of the provided <code>Iterator</code> into
+ * <p>Joins the elements of the provided {@code Iterator} into
* a single String containing the provided elements.</p>
*
* <p>No delimiter is added before or after the list. Null objects or empty
@@ -3420,9 +3420,9 @@ public class StringUtils {
*
* <p>See the examples here: {@link #join(Object[],char)}. </p>
*
- * @param iterator the <code>Iterator</code> of values to join together, may be null
+ * @param iterator the {@code Iterator} of values to join together, may be null
* @param separator the separator character to use
- * @return the joined String, <code>null</code> if null iterator input
+ * @return the joined String, {@code null} if null iterator input
* @since 2.0
*/
public static String join(Iterator<?> iterator, char separator) {
@@ -3457,17 +3457,17 @@ public class StringUtils {
}
/**
- * <p>Joins the elements of the provided <code>Iterator</code> into
+ * <p>Joins the elements of the provided {@code Iterator} into
* a single String containing the provided elements.</p>
*
* <p>No delimiter is added before or after the list.
- * A <code>null</code> separator is the same as an empty String ("").</p>
+ * A {@code null} separator is the same as an empty String ("").</p>
*
* <p>See the examples here: {@link #join(Object[],String)}. </p>
*
- * @param iterator the <code>Iterator</code> of values to join together, may be null
+ * @param iterator the {@code Iterator} of values to join together, may be null
* @param separator the separator character to use, null treated as ""
- * @return the joined String, <code>null</code> if null iterator input
+ * @return the joined String, {@code null} if null iterator input
*/
public static String join(Iterator<?> iterator, String separator) {
@@ -3502,7 +3502,7 @@ public class StringUtils {
}
/**
- * <p>Joins the elements of the provided <code>Iterable</code> into
+ * <p>Joins the elements of the provided {@code Iterable} into
* a single String containing the provided elements.</p>
*
* <p>No delimiter is added before or after the list. Null objects or empty
@@ -3510,9 +3510,9 @@ public class StringUtils {
*
* <p>See the examples here: {@link #join(Object[],char)}. </p>
*
- * @param iterable the <code>Iterable</code> providing the values to join together, may be null
+ * @param iterable the {@code Iterable} providing the values to join together, may be null
* @param separator the separator character to use
- * @return the joined String, <code>null</code> if null iterator input
+ * @return the joined String, {@code null} if null iterator input
* @since 2.3
*/
public static String join(Iterable<?> iterable, char separator) {
@@ -3523,17 +3523,17 @@ public class StringUtils {
}
/**
- * <p>Joins the elements of the provided <code>Iterable</code> into
+ * <p>Joins the elements of the provided {@code Iterable} into
* a single String containing the provided elements.</p>
*
* <p>No delimiter is added before or after the list.
- * A <code>null</code> separator is the same as an empty String ("").</p>
+ * A {@code null} separator is the same as an empty String ("").</p>
*
* <p>See the examples here: {@link #join(Object[],String)}. </p>
*
- * @param iterable the <code>Iterable</code> providing the values to join together, may be null
+ * @param iterable the {@code Iterable} providing the values to join together, may be null
* @param separator the separator character to use, null treated as ""
- * @return the joined String, <code>null</code> if null iterator input
+ * @return the joined String, {@code null} if null iterator input
* @since 2.3
*/
public static String join(Iterable<?> iterable, String separator) {
@@ -3557,7 +3557,7 @@ public class StringUtils {
* </pre>
*
* @param str the String to delete whitespace from, may be null
- * @return the String without whitespaces, <code>null</code> if null String input
+ * @return the String without whitespaces, {@code null} if null String input
*/
public static String deleteWhitespace(String str) {
if (isEmpty(str)) {
@@ -3583,9 +3583,9 @@ public class StringUtils {
* <p>Removes a substring only if it is at the begining of a source string,
* otherwise returns the source string.</p>
*
- * <p>A <code>null</code> source string will return <code>null</code>.
+ * <p>A {@code null} source string will return {@code null}.
[... 1309 lines stripped ...]