diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java
index 0f16d63f3..6284bc11b 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -2529,7 +2529,7 @@ public class StringUtils {
*/
@Deprecated
public static int indexOf(final CharSequence seq, final CharSequence searchSeq) {
- return Strings.CS.indexOf(seq, searchSeq, 0);
+ return Strings.CS.indexOf(seq, searchSeq);
}
/**
@@ -2564,7 +2564,7 @@ public class StringUtils {
* -1 if no match or {@code null} string input
* @since 2.0
* @since 3.0 Changed signature from indexOf(String, String, int) to indexOf(CharSequence, CharSequence, int)
- * @deprecated Use {@link Strings#indexOf(CharSequence, CharSequence) Strings.CS.indexOf(CharSequence, CharSequence)}
+ * @deprecated Use {@link Strings#indexOf(CharSequence, CharSequence, int) Strings.CS.indexOf(CharSequence, CharSequence, int)}
*/
@Deprecated
public static int indexOf(final CharSequence seq, final CharSequence searchSeq, final int startPos) {
@@ -3061,7 +3061,7 @@ public class StringUtils {
*/
@Deprecated
public static int indexOfIgnoreCase(final CharSequence str, final CharSequence searchStr) {
- return Strings.CI.indexOf(str, searchStr, 0);
+ return Strings.CI.indexOf(str, searchStr);
}
/**
diff --git a/src/main/java/org/apache/commons/lang3/Strings.java b/src/main/java/org/apache/commons/lang3/Strings.java
index c5614ba9d..edca2c0a2 100644
--- a/src/main/java/org/apache/commons/lang3/Strings.java
+++ b/src/main/java/org/apache/commons/lang3/Strings.java
@@ -31,6 +31,9 @@ import org.apache.commons.lang3.function.ToBooleanBiFunction;
*/
public abstract class Strings {
+ /**
+ * Builds {@link Strings} instances.
+ */
public static class Builder extends AbstractSupplier
- * A {@code null} CharSequence will return {@code false}.
- *
- * A {@code null} CharSequence will return {@code -1}. A negative start position returns {@code -1}. An empty ("") search CharSequence always matches
- * unless the start position is negative. A start position greater than the string length searches the whole string. The search starts at the startPos
- * and works backwards; matches starting after the start position are ignored.
- *
- * A {@code null} CharSequence will return {@code -1}. A negative start position returns {@code -1}. An empty ("") search CharSequence always matches
- * unless the start position is negative. A start position greater than the string length searches the whole string. The search starts at the startPos
- * and works backwards; matches starting after the start position are ignored.
- *
+ * The return values are:
+ *
+ * This is a {@code null} safe version of :
+ *
+ * {@code null} value is considered less than non-{@code null} value. Two {@code null} references are considered equal.
+ *
+ * Case-sensitive examples
+ *
+ * Case-insensitive examples
+ *
- * StringUtils.containsIgnoreCase(null, *) = false
- * StringUtils.containsIgnoreCase(*, null) = false
- * StringUtils.containsIgnoreCase("", "") = true
- * StringUtils.containsIgnoreCase("abc", "") = true
- * StringUtils.containsIgnoreCase("abc", "a") = true
- * StringUtils.containsIgnoreCase("abc", "z") = false
- * StringUtils.containsIgnoreCase("abc", "A") = true
- * StringUtils.containsIgnoreCase("abc", "Z") = false
- *
- *
- * @param str the CharSequence to check, may be null
- * @param searchStr the CharSequence to find, may be null
- * @return true if the CharSequence contains the search CharSequence irrespective of case or false if not or {@code null} string input
- */
@Override
public boolean contains(final CharSequence str, final CharSequence searchStr) {
if (str == null || searchStr == null) {
@@ -172,32 +159,6 @@ public abstract class Strings {
return INDEX_NOT_FOUND;
}
- /**
- * Case in-sensitive find of the last index within a CharSequence from the specified position.
- *
- *
- * StringUtils.lastIndexOfIgnoreCase(null, *, *) = -1
- * StringUtils.lastIndexOfIgnoreCase(*, null, *) = -1
- * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "A", 8) = 7
- * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B", 8) = 5
- * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "AB", 8) = 4
- * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B", 9) = 5
- * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B", -1) = -1
- * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "A", 0) = 0
- * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B", 0) = -1
- *
- *
- * @param str the CharSequence to check, may be null
- * @param searchStr the CharSequence to find, may be null
- * @param startPos the start position
- * @return the last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} input
- */
@Override
public int lastIndexOf(final CharSequence str, final CharSequence searchStr, int startPos) {
if (str == null || searchStr == null) {
@@ -287,35 +248,6 @@ public abstract class Strings {
return CharSequenceUtils.indexOf(seq, searchSeq, startPos);
}
- /**
- * Finds the last index within a CharSequence, handling {@code null}. This method uses {@link String#lastIndexOf(String, int)} if possible.
- *
- *
- * StringUtils.lastIndexOf(null, *, *) = -1
- * StringUtils.lastIndexOf(*, null, *) = -1
- * StringUtils.lastIndexOf("aabaabaa", "a", 8) = 7
- * StringUtils.lastIndexOf("aabaabaa", "b", 8) = 5
- * StringUtils.lastIndexOf("aabaabaa", "ab", 8) = 4
- * StringUtils.lastIndexOf("aabaabaa", "b", 9) = 5
- * StringUtils.lastIndexOf("aabaabaa", "b", -1) = -1
- * StringUtils.lastIndexOf("aabaabaa", "a", 0) = 0
- * StringUtils.lastIndexOf("aabaabaa", "b", 0) = -1
- * StringUtils.lastIndexOf("aabaabaa", "b", 1) = -1
- * StringUtils.lastIndexOf("aabaabaa", "b", 2) = 2
- * StringUtils.lastIndexOf("aabaabaa", "ba", 2) = 2
- *
- *
- * @param seq the CharSequence to check, may be null
- * @param searchSeq the CharSequence to find, may be null
- * @param startPos the start position, negative treated as zero
- * @return the last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} string input
- */
@Override
public int lastIndexOf(final CharSequence seq, final CharSequence searchSeq, final int startPos) {
return CharSequenceUtils.lastIndexOf(seq, searchSeq, startPos);
@@ -333,6 +265,11 @@ public abstract class Strings {
*/
public static final Strings CS = new CsStrings(true);
+ /**
+ * Constructs a new {@link Builder} instance.
+ *
+ * @return a new {@link Builder} instance.
+ */
public static final Builder builder() {
return new Builder();
}
@@ -371,6 +308,12 @@ public abstract class Strings {
*/
private final boolean nullIsLess;
+ /**
+ * Constructs a new instance.
+ *
+ * @param ignoreCase Ignores case when possible.
+ * @param nullIsLess Compares null as less when possible.
+ */
private Strings(final boolean ignoreCase, final boolean nullIsLess) {
this.ignoreCase = ignoreCase;
this.nullIsLess = nullIsLess;
@@ -456,7 +399,66 @@ public abstract class Strings {
return str + suffix;
}
- public abstract int compare(String s1, String s2);
+ /**
+ * Compare two Strings lexicographically, like {@link String#compareTo(String)}.
+ *
+ *
+ *
+ *
+ * str1.compareTo(str2)
+ *
+ *
+ * {@code
+ * StringUtils.compare(null, null) = 0
+ * StringUtils.compare(null , "a") < 0
+ * StringUtils.compare("a", null) > 0
+ * StringUtils.compare("abc", "abc") = 0
+ * StringUtils.compare("a", "b") < 0
+ * StringUtils.compare("b", "a") > 0
+ * StringUtils.compare("a", "B") > 0
+ * StringUtils.compare("ab", "abc") < 0
+ * }
+ * {@code
+ * StringUtils.compareIgnoreCase(null, null) = 0
+ * StringUtils.compareIgnoreCase(null , "a") < 0
+ * StringUtils.compareIgnoreCase("a", null) > 0
+ * StringUtils.compareIgnoreCase("abc", "abc") = 0
+ * StringUtils.compareIgnoreCase("abc", "ABC") = 0
+ * StringUtils.compareIgnoreCase("a", "b") < 0
+ * StringUtils.compareIgnoreCase("b", "a") > 0
+ * StringUtils.compareIgnoreCase("a", "B") < 0
+ * StringUtils.compareIgnoreCase("A", "b") < 0
+ * StringUtils.compareIgnoreCase("ab", "ABC") < 0
+ * }
+ *
+ * @see String#compareTo(String)
+ * @param str1 the String to compare from
+ * @param str2 the String to compare to
+ * @return < 0, 0, > 0, if {@code str1} is respectively less, equal or greater than {@code str2}
+ */
+ public abstract int compare(String str1, String str2);
/**
* Tests if CharSequence contains a search CharSequence, handling {@code null}. This method uses {@link String#indexOf(String)} if possible.
@@ -465,13 +467,31 @@ public abstract class Strings {
* A {@code null} CharSequence will return {@code false}.
*
+ * Case-sensitive examples + *
+ * *- * Strings.CS.contains(null, *) = false - * Strings.CS.contains(*, null) = false - * Strings.CS.contains("", "") = true - * Strings.CS.contains("abc", "") = true - * Strings.CS.contains("abc", "a") = true - * Strings.CS.contains("abc", "z") = false + * StringUtils.contains(null, *) = false + * StringUtils.contains(*, null) = false + * StringUtils.contains("", "") = true + * StringUtils.contains("abc", "") = true + * StringUtils.contains("abc", "a") = true + * StringUtils.contains("abc", "z") = false + *+ *
+ * Case-insensitive examples + *
+ * + *+ * StringUtils.containsIgnoreCase(null, *) = false + * StringUtils.containsIgnoreCase(*, null) = false + * StringUtils.containsIgnoreCase("", "") = true + * StringUtils.containsIgnoreCase("abc", "") = true + * StringUtils.containsIgnoreCase("abc", "a") = true + * StringUtils.containsIgnoreCase("abc", "z") = false + * StringUtils.containsIgnoreCase("abc", "A") = true + * StringUtils.containsIgnoreCase("abc", "Z") = false ** * @param seq the CharSequence to check, may be null @@ -481,12 +501,29 @@ public abstract class Strings { public abstract boolean contains(CharSequence seq, CharSequence searchSeq); /** - * Tests if the CharSequence contains any of the CharSequences in the given array, ignoring case. + * Tests if the CharSequence contains any of the CharSequences in the given array. * *
* A {@code null} {@code cs} CharSequence will return {@code false}. A {@code null} or zero length search array will return {@code false}. *
* + *+ * Case-sensitive examples + *
+ * + *+ * StringUtils.containsAny(null, *) = false + * StringUtils.containsAny("", *) = false + * StringUtils.containsAny(*, null) = false + * StringUtils.containsAny(*, []) = false + * StringUtils.containsAny("abcd", "ab", null) = true + * StringUtils.containsAny("abcd", "ab", "cd") = true + * StringUtils.containsAny("abc", "d", "abc") = true + *+ *
+ * Case-insensitive examples + *
+ * ** StringUtils.containsAny(null, *) = false * StringUtils.containsAny("", *) = false @@ -508,7 +545,7 @@ public abstract class Strings { } /** - * Tests if a CharSequence ends with a specified suffix (optionally case-insensitive). + * Tests if a CharSequence ends with a specified suffix. * ** Case-sensitive examples @@ -553,27 +590,104 @@ public abstract class Strings { return CharSequenceUtils.regionMatches(str, ignoreCase, str.length() - sufLen, suffix, 0, sufLen); } - public abstract boolean equals(CharSequence s1, CharSequence s2); - /** - * Compares this string to the specified object. The result is {@code - * true} if and only if the argument is not {@code null} and is a {@code - * String} object that represents the same sequence of characters as this object. + * Compares two CharSequences, returning {@code true} if they represent equal sequences of characters. * - * @param s1 The left string to compare this {@code String} against - * @param s2 The right string to compare this {@code String} against + *
+ * {@code null}s are handled without exceptions. Two {@code null} references are considered to be equal. + *
* - * @return {@code true} if the given object represents a {@code String} equivalent to this string, {@code false} otherwise + *+ * Case-sensitive examples + *
* + *+ * StringUtils.equals(null, null) = true + * StringUtils.equals(null, "abc") = false + * StringUtils.equals("abc", null) = false + * StringUtils.equals("abc", "abc") = true + * StringUtils.equals("abc", "ABC") = false + *+ *+ * Case-insensitive examples + *
+ * + *+ * StringUtils.equalsIgnoreCase(null, null) = true + * StringUtils.equalsIgnoreCase(null, "abc") = false + * StringUtils.equalsIgnoreCase("abc", null) = false + * StringUtils.equalsIgnoreCase("abc", "abc") = true + * StringUtils.equalsIgnoreCase("abc", "ABC") = true + *+ * + * @param cs1 the first CharSequence, may be {@code null} + * @param cs2 the second CharSequence, may be {@code null} + * @return {@code true} if the CharSequences are equal (case-sensitive), or both {@code null} + * @see Object#equals(Object) * @see String#compareTo(String) * @see String#equalsIgnoreCase(String) */ - public abstract boolean equals(String s1, String s2); + public abstract boolean equals(CharSequence cs1, CharSequence cs2); + + /** + * Compares two CharSequences, returning {@code true} if they represent equal sequences of characters. + * + *+ * {@code null}s are handled without exceptions. Two {@code null} references are considered to be equal. + *
+ * + *+ * Case-sensitive examples + *
+ * + *+ * StringUtils.equals(null, null) = true + * StringUtils.equals(null, "abc") = false + * StringUtils.equals("abc", null) = false + * StringUtils.equals("abc", "abc") = true + * StringUtils.equals("abc", "ABC") = false + *+ *+ * Case-insensitive examples + *
+ * + *+ * StringUtils.equalsIgnoreCase(null, null) = true + * StringUtils.equalsIgnoreCase(null, "abc") = false + * StringUtils.equalsIgnoreCase("abc", null) = false + * StringUtils.equalsIgnoreCase("abc", "abc") = true + * StringUtils.equalsIgnoreCase("abc", "ABC") = true + *+ * + * @param str1 the first CharSequence, may be {@code null} + * @param str2 the second CharSequence, may be {@code null} + * @return {@code true} if the CharSequences are equal (case-sensitive), or both {@code null} + * @see Object#equals(Object) + * @see String#compareTo(String) + * @see String#equalsIgnoreCase(String) + */ + public abstract boolean equals(String str1, String str2); /** * Compares given {@code string} to a CharSequences vararg of {@code searchStrings}, returning {@code true} if the {@code string} is equal to any of the * {@code searchStrings}. * + *+ * Case-sensitive examples + *
+ * + *+ * StringUtils.equalsAny(null, (CharSequence[]) null) = false + * StringUtils.equalsAny(null, null, null) = true + * StringUtils.equalsAny(null, "abc", "def") = false + * StringUtils.equalsAny("abc", null, "def") = false + * StringUtils.equalsAny("abc", "abc", "def") = true + * StringUtils.equalsAny("abc", "ABC", "DEF") = false + *+ *+ * Case-insensitive examples + *
+ * ** StringUtils.equalsAny(null, (CharSequence[]) null) = false * StringUtils.equalsAny(null, null, null) = true @@ -599,24 +713,154 @@ public abstract class Strings { return false; } - public int indexOf(final CharSequence str, final CharSequence searchStr) { - return indexOf(str, searchStr, 0); + /** + * Finds the first index within a CharSequence, handling {@code null}. This method uses {@link String#indexOf(String, int)} if possible. + * + ** + *+ * A {@code null} CharSequence will return {@code -1}. + *
+ * + *+ * Case-sensitive examples + *
+ * + *+ * StringUtils.indexOf(null, *) = -1 + * StringUtils.indexOf(*, null) = -1 + * StringUtils.indexOf("", "") = 0 + * StringUtils.indexOf("", *) = -1 (except when * = "") + * StringUtils.indexOf("aabaabaa", "a") = 0 + * StringUtils.indexOf("aabaabaa", "b") = 2 + * StringUtils.indexOf("aabaabaa", "ab") = 1 + * StringUtils.indexOf("aabaabaa", "") = 0 + *+ *+ * Case-insensitive examples + *
+ * + *+ * StringUtils.indexOfIgnoreCase(null, *) = -1 + * StringUtils.indexOfIgnoreCase(*, null) = -1 + * StringUtils.indexOfIgnoreCase("", "") = 0 + * StringUtils.indexOfIgnoreCase(" ", " ") = 0 + * StringUtils.indexOfIgnoreCase("aabaabaa", "a") = 0 + * StringUtils.indexOfIgnoreCase("aabaabaa", "b") = 2 + * StringUtils.indexOfIgnoreCase("aabaabaa", "ab") = 1 + *+ * + * @param seq the CharSequence to check, may be null + * @param searchSeq the CharSequence to find, may be null + * @return the first index of the search CharSequence, -1 if no match or {@code null} string input + */ + public int indexOf(final CharSequence seq, final CharSequence searchSeq) { + return indexOf(seq, searchSeq, 0); } - public abstract int indexOf(CharSequence str, CharSequence searchStr, int startPos); + /** + * Finds the first index within a CharSequence, handling {@code null}. This method uses {@link String#indexOf(String, int)} if possible. + * + *+ * A {@code null} CharSequence will return {@code -1}. A negative start position is treated as zero. An empty ("") search CharSequence always matches. A + * start position greater than the string length only matches an empty search CharSequence. + *
+ * + *+ * Case-sensitive examples + *
+ * + *+ * StringUtils.indexOf(null, *, *) = -1 + * StringUtils.indexOf(*, null, *) = -1 + * StringUtils.indexOf("", "", 0) = 0 + * StringUtils.indexOf("", *, 0) = -1 (except when * = "") + * StringUtils.indexOf("aabaabaa", "a", 0) = 0 + * StringUtils.indexOf("aabaabaa", "b", 0) = 2 + * StringUtils.indexOf("aabaabaa", "ab", 0) = 1 + * StringUtils.indexOf("aabaabaa", "b", 3) = 5 + * StringUtils.indexOf("aabaabaa", "b", 9) = -1 + * StringUtils.indexOf("aabaabaa", "b", -1) = 2 + * StringUtils.indexOf("aabaabaa", "", 2) = 2 + * StringUtils.indexOf("abc", "", 9) = 3 + *+ *+ * Case-insensitive examples + *
+ * + *+ * StringUtils.indexOfIgnoreCase(null, *, *) = -1 + * StringUtils.indexOfIgnoreCase(*, null, *) = -1 + * StringUtils.indexOfIgnoreCase("", "", 0) = 0 + * StringUtils.indexOfIgnoreCase("aabaabaa", "A", 0) = 0 + * StringUtils.indexOfIgnoreCase("aabaabaa", "B", 0) = 2 + * StringUtils.indexOfIgnoreCase("aabaabaa", "AB", 0) = 1 + * StringUtils.indexOfIgnoreCase("aabaabaa", "B", 3) = 5 + * StringUtils.indexOfIgnoreCase("aabaabaa", "B", 9) = -1 + * StringUtils.indexOfIgnoreCase("aabaabaa", "B", -1) = 2 + * StringUtils.indexOfIgnoreCase("aabaabaa", "", 2) = 2 + * StringUtils.indexOfIgnoreCase("abc", "", 9) = -1 + *+ * + * @param seq the CharSequence to check, may be null + * @param searchSeq the CharSequence to find, may be null + * @param startPos the start position, negative treated as zero + * @return the first index of the search CharSequence (always ≥ startPos), -1 if no match or {@code null} string input + */ + public abstract int indexOf(CharSequence seq, CharSequence searchSeq, int startPos); + /** + * Tests whether to ignore case. + * + * @return whether to ignore case. + */ public boolean isCaseSensitive() { return !ignoreCase; } - boolean isIgnoreCase() { - return ignoreCase; - } - + /** + * Tests whether null is less when comparing. + * + * @return whether null is less when comparing. + */ boolean isNullIsLess() { return nullIsLess; } + /** + * Finds the last index within a CharSequence, handling {@code null}. This method uses {@link String#lastIndexOf(String)} if possible. + * + *+ * A {@code null} CharSequence will return {@code -1}. + *
+ * + *+ * Case-sensitive examples + *
+ * + *+ * StringUtils.lastIndexOf(null, *) = -1 + * StringUtils.lastIndexOf(*, null) = -1 + * StringUtils.lastIndexOf("", "") = 0 + * StringUtils.lastIndexOf("aabaabaa", "a") = 7 + * StringUtils.lastIndexOf("aabaabaa", "b") = 5 + * StringUtils.lastIndexOf("aabaabaa", "ab") = 4 + * StringUtils.lastIndexOf("aabaabaa", "") = 8 + *+ *+ * Case-insensitive examples + *
+ * + *+ * StringUtils.lastIndexOfIgnoreCase(null, *) = -1 + * StringUtils.lastIndexOfIgnoreCase(*, null) = -1 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "A") = 7 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B") = 5 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "AB") = 4 + *+ * + * @param str the CharSequence to check, may be null + * @param searchStr the CharSequence to find, may be null + * @return the last index of the search String, -1 if no match or {@code null} string input + */ public int lastIndexOf(final CharSequence str, final CharSequence searchStr) { if (str == null) { return INDEX_NOT_FOUND; @@ -624,6 +868,54 @@ public abstract class Strings { return lastIndexOf(str, searchStr, str.length()); } + /** + * Finds the last index within a CharSequence, handling {@code null}. This method uses {@link String#lastIndexOf(String, int)} if possible. + * + *+ * A {@code null} CharSequence will return {@code -1}. A negative start position returns {@code -1}. An empty ("") search CharSequence always matches unless + * the start position is negative. A start position greater than the string length searches the whole string. The search starts at the startPos and works + * backwards; matches starting after the start position are ignored. + *
+ * + *+ * Case-sensitive examples + *
+ * + *+ * StringUtils.lastIndexOf(null, *, *) = -1 + * StringUtils.lastIndexOf(*, null, *) = -1 + * StringUtils.lastIndexOf("aabaabaa", "a", 8) = 7 + * StringUtils.lastIndexOf("aabaabaa", "b", 8) = 5 + * StringUtils.lastIndexOf("aabaabaa", "ab", 8) = 4 + * StringUtils.lastIndexOf("aabaabaa", "b", 9) = 5 + * StringUtils.lastIndexOf("aabaabaa", "b", -1) = -1 + * StringUtils.lastIndexOf("aabaabaa", "a", 0) = 0 + * StringUtils.lastIndexOf("aabaabaa", "b", 0) = -1 + * StringUtils.lastIndexOf("aabaabaa", "b", 1) = -1 + * StringUtils.lastIndexOf("aabaabaa", "b", 2) = 2 + * StringUtils.lastIndexOf("aabaabaa", "ba", 2) = 2 + *+ *+ * Case-insensitive examples + *
+ * + *+ * StringUtils.lastIndexOfIgnoreCase(null, *, *) = -1 + * StringUtils.lastIndexOfIgnoreCase(*, null, *) = -1 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "A", 8) = 7 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B", 8) = 5 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "AB", 8) = 4 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B", 9) = 5 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B", -1) = -1 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "A", 0) = 0 + * StringUtils.lastIndexOfIgnoreCase("aabaabaa", "B", 0) = -1 + *+ * + * @param seq the CharSequence to check, may be null + * @param searchSeq the CharSequence to find, may be null + * @param startPos the start position, negative treated as zero + * @return the last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} string input + */ public abstract int lastIndexOf(CharSequence seq, CharSequence searchSeq, int startPos); /** @@ -766,6 +1058,19 @@ public abstract class Strings { * * *+ * Case-sensitive examples + *
+ * + *+ * StringUtils.removeStart(null, *) = null + * StringUtils.removeStart("", *) = "" + * StringUtils.removeStart(*, null) = * + * StringUtils.removeStart("www.domain.com", "www.") = "domain.com" + * StringUtils.removeStart("domain.com", "www.") = "domain.com" + * StringUtils.removeStart("www.domain.com", "domain") = "www.domain.com" + * StringUtils.removeStart("abc", "") = "abc" + *+ ** Case-insensitive examples *
* @@ -838,27 +1143,47 @@ public abstract class Strings { } /** - * Replaces a String with another String inside a larger String, for the first {@code max} values of the search String, case-sensitively/insensitively based - * on {@code ignoreCase} value. + * Replaces a String with another String inside a larger String, for the first {@code max} values of the search String. * ** A {@code null} reference passed to this method is a no-op. *
* + *+ * Case-sensitive examples + *
+ * *- * StringUtils.replace(null, *, *, *, false) = null - * StringUtils.replace("", *, *, *, false) = "" - * StringUtils.replace("any", null, *, *, false) = "any" - * StringUtils.replace("any", *, null, *, false) = "any" - * StringUtils.replace("any", "", *, *, false) = "any" - * StringUtils.replace("any", *, *, 0, false) = "any" - * StringUtils.replace("abaa", "a", null, -1, false) = "abaa" - * StringUtils.replace("abaa", "a", "", -1, false) = "b" - * StringUtils.replace("abaa", "a", "z", 0, false) = "abaa" - * StringUtils.replace("abaa", "A", "z", 1, false) = "abaa" - * StringUtils.replace("abaa", "A", "z", 1, true) = "zbaa" - * StringUtils.replace("abAa", "a", "z", 2, true) = "zbza" - * StringUtils.replace("abAa", "a", "z", -1, true) = "zbzz" + * StringUtils.replace(null, *, *, *) = null + * StringUtils.replace("", *, *, *) = "" + * StringUtils.replace("any", null, *, *) = "any" + * StringUtils.replace("any", *, null, *) = "any" + * StringUtils.replace("any", "", *, *) = "any" + * StringUtils.replace("any", *, *, 0) = "any" + * StringUtils.replace("abaa", "a", null, -1) = "abaa" + * StringUtils.replace("abaa", "a", "", -1) = "b" + * StringUtils.replace("abaa", "a", "z", 0) = "abaa" + * StringUtils.replace("abaa", "a", "z", 1) = "zbaa" + * StringUtils.replace("abaa", "a", "z", 2) = "zbza" + * StringUtils.replace("abaa", "a", "z", -1) = "zbzz" + *+ *+ * Case-insensitive examples + *
+ * + *+ * StringUtils.replaceIgnoreCase(null, *, *, *) = null + * StringUtils.replaceIgnoreCase("", *, *, *) = "" + * StringUtils.replaceIgnoreCase("any", null, *, *) = "any" + * StringUtils.replaceIgnoreCase("any", *, null, *) = "any" + * StringUtils.replaceIgnoreCase("any", "", *, *) = "any" + * StringUtils.replaceIgnoreCase("any", *, *, 0) = "any" + * StringUtils.replaceIgnoreCase("abaa", "a", null, -1) = "abaa" + * StringUtils.replaceIgnoreCase("abaa", "a", "", -1) = "b" + * StringUtils.replaceIgnoreCase("abaa", "a", "z", 0) = "abaa" + * StringUtils.replaceIgnoreCase("abaa", "A", "z", 1) = "zbaa" + * StringUtils.replaceIgnoreCase("abAa", "a", "z", 2) = "zbza" + * StringUtils.replaceIgnoreCase("abAa", "a", "z", -1) = "zbzz" ** * @param text text to search and replace in, may be null @@ -917,6 +1242,22 @@ public abstract class Strings { * StringUtils.replaceOnce("aba", "a", "z") = "zba" *+ * Case-insensitive examples + *
+ * + *+ * StringUtils.replaceOnceIgnoreCase(null, *, *) = null + * StringUtils.replaceOnceIgnoreCase("", *, *) = "" + * StringUtils.replaceOnceIgnoreCase("any", null, *) = "any" + * StringUtils.replaceOnceIgnoreCase("any", *, null) = "any" + * StringUtils.replaceOnceIgnoreCase("any", "", *) = "any" + * StringUtils.replaceOnceIgnoreCase("aba", "a", null) = "aba" + * StringUtils.replaceOnceIgnoreCase("aba", "a", "") = "ba" + * StringUtils.replaceOnceIgnoreCase("aba", "a", "z") = "zba" + * StringUtils.replaceOnceIgnoreCase("FoOFoofoo", "foo", "") = "Foofoo" + *+ * * @see #replace(String text, String searchString, String replacement, int max) * @param text text to search and replace in, may be null * @param searchString the String to search for, may be null