A null input String returns null.
* A null open/close returns null (no match).
- * An empty ("") open/close returns an empty string.
+ * StringUtils.substringBetween("wx[b]yz", "[", "]") = "b"
* StringUtils.substringBetween(null, *, *) = null
+ * StringUtils.substringBetween(*, null, *) = null
+ * StringUtils.substringBetween(*, *, null) = null
* StringUtils.substringBetween("", "", "") = ""
- * StringUtils.substringBetween("", "", "tag") = null
- * StringUtils.substringBetween("", "tag", "tag") = null
- * StringUtils.substringBetween("yabcz", null, null) = null
+ * StringUtils.substringBetween("", "", "]") = null
+ * StringUtils.substringBetween("", "[", "]") = null
* StringUtils.substringBetween("yabcz", "", "") = ""
* StringUtils.substringBetween("yabcz", "y", "z") = "abc"
* StringUtils.substringBetween("yabczyabcz", "y", "z") = "abc"
@@ -1892,6 +1894,60 @@ public class StringUtils {
return null;
}
+ /**
+ * Searches a String for substrings delimited by a start and end tag,
+ * returning all matching substrings in an array.
+ *
+ * A null input String returns null.
+ * A null open/close returns null (no match).
+ * An empty ("") open/close returns null (no match).
+ *
+ *
+ * StringUtils.substringsBetween("[a][b][c]", "[", "]") = ["a","b","c"]
+ * StringUtils.substringsBetween(null, *, *) = null
+ * StringUtils.substringsBetween(*, null, *) = null
+ * StringUtils.substringsBetween(*, *, null) = null
+ * StringUtils.substringsBetween("", "[", "]") = []
+ *
+ *
+ * @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 null if no match
+ * @since 2.3
+ */
+ public static String[] substringsBetween(String str, String open, String close) {
+ if (str == null || isEmpty(open) || isEmpty(close)) {
+ return null;
+ }
+ int strLen = str.length();
+ if (strLen == 0) {
+ return ArrayUtils.EMPTY_STRING_ARRAY;
+ }
+ int closeLen = close.length();
+ int openLen = open.length();
+ List list = new ArrayList();
+ int pos = 0;
+ while (pos < (strLen - closeLen)) {
+ int start = str.indexOf(open, pos);
+ if (start < 0) {
+ break;
+ }
+ start += openLen;
+ int end = str.indexOf(close, start);
+ if (end < 0) {
+ break;
+ }
+ list.add(str.substring(start, end));
+ pos = end + closeLen;
+ }
+ if (list.size() > 0) {
+ return (String[]) list.toArray(new String [list.size()]);
+ } else {
+ return null;
+ }
+ }
+
// Nested extraction
//-----------------------------------------------------------------------
/**
diff --git a/src/test/org/apache/commons/lang/StringUtilsSubstringTest.java b/src/test/org/apache/commons/lang/StringUtilsSubstringTest.java
index bf20a39e4..746cf0d10 100644
--- a/src/test/org/apache/commons/lang/StringUtilsSubstringTest.java
+++ b/src/test/org/apache/commons/lang/StringUtilsSubstringTest.java
@@ -248,10 +248,73 @@ public class StringUtilsSubstringTest extends TestCase {
public void testSubstringBetween_StringStringString() {
assertEquals(null, StringUtils.substringBetween(null, "", ""));
assertEquals("", StringUtils.substringBetween("", "", ""));
+ assertEquals("", StringUtils.substringBetween("foo", "", ""));
+ assertEquals(null, StringUtils.substringBetween("foo", "", "]"));
+ assertEquals(null, StringUtils.substringBetween("foo", "[", "]"));
assertEquals("", StringUtils.substringBetween(" ", " ", " "));
assertEquals("bar", StringUtils.substringBetween("bar ", "", " ") );
}
+ /**
+ * Tests the substringsBetween method that returns an String Array of substrings.
+ */
+ public void testSubstringsBetween_StringStringString() {
+
+ String[] results = StringUtils.substringsBetween("[one], [two], [three]", "[", "]");
+ assertEquals(3, results.length);
+ assertEquals("one", results[0]);
+ assertEquals("two", results[1]);
+ assertEquals("three", results[2]);
+
+ results = StringUtils.substringsBetween("[one], [two], three", "[", "]");
+ assertEquals(2, results.length);
+ assertEquals("one", results[0]);
+ assertEquals("two", results[1]);
+
+ results = StringUtils.substringsBetween("[one], [two], three]", "[", "]");
+ assertEquals(2, results.length);
+ assertEquals("one", results[0]);
+ assertEquals("two", results[1]);
+
+ results = StringUtils.substringsBetween("[one], two], three]", "[", "]");
+ assertEquals(1, results.length);
+ assertEquals("one", results[0]);
+
+ results = StringUtils.substringsBetween("one], two], [three]", "[", "]");
+ assertEquals(1, results.length);
+ assertEquals("three", results[0]);
+
+ // 'ab hello ba' will match, but 'ab non ba' won't
+ // this is because the 'a' is shared between the two and can't be matched twice
+ results = StringUtils.substringsBetween("aabhellobabnonba", "ab", "ba");
+ assertEquals(1, results.length);
+ assertEquals("hello", results[0]);
+
+ results = StringUtils.substringsBetween("one, two, three", "[", "]");
+ assertNull(results);
+
+ results = StringUtils.substringsBetween("[one, two, three", "[", "]");
+ assertNull(results);
+
+ results = StringUtils.substringsBetween("one, two, three]", "[", "]");
+ assertNull(results);
+
+ results = StringUtils.substringsBetween("[one], [two], [three]", "[", null);
+ assertNull(results);
+
+ results = StringUtils.substringsBetween("[one], [two], [three]", null, "]");
+ assertNull(results);
+
+ results = StringUtils.substringsBetween("[one], [two], [three]", "", "");
+ assertNull(results);
+
+ results = StringUtils.substringsBetween(null, "[", "]");
+ assertNull(results);
+
+ results = StringUtils.substringsBetween("", "[", "]");
+ assertEquals(0, results.length);
+ }
+
//-----------------------------------------------------------------------
public void testCountMatches_String() {
assertEquals(0, StringUtils.countMatches(null, null));