Add substringBetween() as a replacement for getNestedString()
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137550 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne
parent
4da8084e45
commit
95c2d8bbad
|
|
@ -144,7 +144,7 @@
|
||||||
* @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
|
* @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
|
||||||
* @author Phil Steitz
|
* @author Phil Steitz
|
||||||
* @since 1.0
|
* @since 1.0
|
||||||
* @version $Id: StringUtils.java,v 1.85 2003/08/01 21:02:16 scolebourne Exp $
|
* @version $Id: StringUtils.java,v 1.86 2003/08/01 22:05:43 scolebourne Exp $
|
||||||
*/
|
*/
|
||||||
public class StringUtils {
|
public class StringUtils {
|
||||||
// Performance testing notes (JDK 1.4, Jul03, scolebourne)
|
// Performance testing notes (JDK 1.4, Jul03, scolebourne)
|
||||||
|
|
@ -1691,6 +1691,128 @@ public static String substringAfterLast(String str, String separator) {
|
||||||
return str.substring(pos + separator.length());
|
return str.substring(pos + separator.length());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Substring between
|
||||||
|
//-----------------------------------------------------------------------
|
||||||
|
/**
|
||||||
|
* <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>
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* StringUtils.substringBetween(null, *) = null
|
||||||
|
* StringUtils.substringBetween("", "") = ""
|
||||||
|
* StringUtils.substringBetween("", "tag") = null
|
||||||
|
* StringUtils.substringBetween("tagabctag", null) = null
|
||||||
|
* StringUtils.substringBetween("tagabctag", "") = ""
|
||||||
|
* StringUtils.substringBetween("tagabctag", "tag") = "abc"
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* @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
|
||||||
|
*/
|
||||||
|
public static String substringBetween(String str, String tag) {
|
||||||
|
return substringBetween(str, tag, tag);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <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).
|
||||||
|
* An empty ("") open/close returns an empty string.</p>
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* StringUtils.substringBetween(null, *, *) = null
|
||||||
|
* StringUtils.substringBetween("", "", "") = ""
|
||||||
|
* StringUtils.substringBetween("", "", "tag") = null
|
||||||
|
* StringUtils.substringBetween("", "tag", "tag") = null
|
||||||
|
* StringUtils.substringBetween("yabcz", null, null) = null
|
||||||
|
* StringUtils.substringBetween("yabcz", "", "") = ""
|
||||||
|
* StringUtils.substringBetween("yabcz", "y", "z") = "abc"
|
||||||
|
* StringUtils.substringBetween("yabczyabcz", "y", "z") = "abc"
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* @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
|
||||||
|
*/
|
||||||
|
public static String substringBetween(String str, String open, String close) {
|
||||||
|
if (str == null || open == null || close == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
int start = str.indexOf(open);
|
||||||
|
if (start != -1) {
|
||||||
|
int end = str.indexOf(close, start + open.length());
|
||||||
|
if (end != -1) {
|
||||||
|
return str.substring(start + open.length(), end);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nested extraction
|
||||||
|
//-----------------------------------------------------------------------
|
||||||
|
/**
|
||||||
|
* <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>
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* StringUtils.getNestedString(null, *) = null
|
||||||
|
* StringUtils.getNestedString("", "") = ""
|
||||||
|
* StringUtils.getNestedString("", "tag") = null
|
||||||
|
* StringUtils.getNestedString("tagabctag", null) = null
|
||||||
|
* StringUtils.getNestedString("tagabctag", "") = ""
|
||||||
|
* StringUtils.getNestedString("tagabctag", "tag") = "abc"
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* @param str the String containing nested-string, may be null
|
||||||
|
* @param tag the String before and after nested-string, may be null
|
||||||
|
* @return the nested String, <code>null</code> if no match
|
||||||
|
* @deprecated Use the better named {@link #substringBetween(String, String)}.
|
||||||
|
* Method will be removed in Commons Lang 3.0.
|
||||||
|
*/
|
||||||
|
public static String getNestedString(String str, String tag) {
|
||||||
|
return substringBetween(str, tag, tag);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <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).
|
||||||
|
* An empty ("") open/close returns an empty string.</p>
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* StringUtils.getNestedString(null, *, *) = null
|
||||||
|
* StringUtils.getNestedString("", "", "") = ""
|
||||||
|
* StringUtils.getNestedString("", "", "tag") = null
|
||||||
|
* StringUtils.getNestedString("", "tag", "tag") = null
|
||||||
|
* StringUtils.getNestedString("yabcz", null, null) = null
|
||||||
|
* StringUtils.getNestedString("yabcz", "", "") = ""
|
||||||
|
* StringUtils.getNestedString("yabcz", "y", "z") = "abc"
|
||||||
|
* StringUtils.getNestedString("yabczyabcz", "y", "z") = "abc"
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* @param str the String containing nested-string, may be null
|
||||||
|
* @param open the String before nested-string, may be null
|
||||||
|
* @param close the String after nested-string, may be null
|
||||||
|
* @return the nested String, <code>null</code> if no match
|
||||||
|
* @deprecated Use the better named {@link #substringBetween(String, String, String)}.
|
||||||
|
* Method will be removed in Commons Lang 3.0.
|
||||||
|
*/
|
||||||
|
public static String getNestedString(String str, String open, String close) {
|
||||||
|
return substringBetween(str, open, close);
|
||||||
|
}
|
||||||
|
|
||||||
// Splitting
|
// Splitting
|
||||||
//-----------------------------------------------------------------------
|
//-----------------------------------------------------------------------
|
||||||
/**
|
/**
|
||||||
|
|
@ -3342,70 +3464,6 @@ public static String uncapitaliseAllWords(String str) {
|
||||||
return buffer.toString();
|
return buffer.toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
// Nested extraction
|
|
||||||
//-----------------------------------------------------------------------
|
|
||||||
/**
|
|
||||||
* <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>
|
|
||||||
*
|
|
||||||
* <pre>
|
|
||||||
* StringUtils.getNestedString(null, *) = null
|
|
||||||
* StringUtils.getNestedString("", "") = ""
|
|
||||||
* StringUtils.getNestedString("", "tag") = null
|
|
||||||
* StringUtils.getNestedString("tagabctag", null) = null
|
|
||||||
* StringUtils.getNestedString("tagabctag", "") = ""
|
|
||||||
* StringUtils.getNestedString("tagabctag", "tag") = "abc"
|
|
||||||
* </pre>
|
|
||||||
*
|
|
||||||
* @param str the String containing nested-string, may be null
|
|
||||||
* @param tag the String before and after nested-string, may be null
|
|
||||||
* @return the nested String, <code>null</code> if no match
|
|
||||||
*/
|
|
||||||
public static String getNestedString(String str, String tag) {
|
|
||||||
return getNestedString(str, tag, tag);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* <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).
|
|
||||||
* An empty ("") open/close returns an empty string.</p>
|
|
||||||
*
|
|
||||||
* <pre>
|
|
||||||
* StringUtils.getNestedString(null, *, *) = null
|
|
||||||
* StringUtils.getNestedString("", "", "") = ""
|
|
||||||
* StringUtils.getNestedString("", "", "tag") = null
|
|
||||||
* StringUtils.getNestedString("", "tag", "tag") = null
|
|
||||||
* StringUtils.getNestedString("yabcz", null, null) = null
|
|
||||||
* StringUtils.getNestedString("yabcz", "", "") = ""
|
|
||||||
* StringUtils.getNestedString("yabcz", "y", "z") = "abc"
|
|
||||||
* StringUtils.getNestedString("yabczyabcz", "y", "z") = "abc"
|
|
||||||
* </pre>
|
|
||||||
*
|
|
||||||
* @param str the String containing nested-string, may be null
|
|
||||||
* @param open the String before nested-string, may be null
|
|
||||||
* @param close the String after nested-string, may be null
|
|
||||||
* @return the nested String, <code>null</code> if no match
|
|
||||||
*/
|
|
||||||
public static String getNestedString(String str, String open, String close) {
|
|
||||||
if (str == null || open == null || close == null) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
int start = str.indexOf(open);
|
|
||||||
if (start != -1) {
|
|
||||||
int end = str.indexOf(close, start + open.length());
|
|
||||||
if (end != -1) {
|
|
||||||
return str.substring(start + open.length(), end);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Count matches
|
// Count matches
|
||||||
//-----------------------------------------------------------------------
|
//-----------------------------------------------------------------------
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -64,7 +64,7 @@
|
||||||
* @author <a href="mailto:scolebourne@joda.org">Stephen Colebourne</a>
|
* @author <a href="mailto:scolebourne@joda.org">Stephen Colebourne</a>
|
||||||
* @author <a href="mailto:ridesmet@users.sourceforge.net">Ringo De Smet</a>
|
* @author <a href="mailto:ridesmet@users.sourceforge.net">Ringo De Smet</a>
|
||||||
* @author Phil Steitz
|
* @author Phil Steitz
|
||||||
* @version $Id: StringUtilsSubstringTest.java,v 1.10 2003/07/30 22:21:39 scolebourne Exp $
|
* @version $Id: StringUtilsSubstringTest.java,v 1.11 2003/08/01 22:05:43 scolebourne Exp $
|
||||||
*/
|
*/
|
||||||
public class StringUtilsSubstringTest extends TestCase {
|
public class StringUtilsSubstringTest extends TestCase {
|
||||||
private static final String FOO = "foo";
|
private static final String FOO = "foo";
|
||||||
|
|
@ -268,6 +268,27 @@ public void testSubstringAfterLast_StringString() {
|
||||||
assertEquals("", StringUtils.substringAfterLast("abc", ""));
|
assertEquals("", StringUtils.substringAfterLast("abc", ""));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//-----------------------------------------------------------------------
|
||||||
|
public void testSubstringBetween_StringString() {
|
||||||
|
assertEquals(null, StringUtils.substringBetween(null, "tag"));
|
||||||
|
assertEquals("", StringUtils.substringBetween("", ""));
|
||||||
|
assertEquals(null, StringUtils.substringBetween("", "abc"));
|
||||||
|
assertEquals("", StringUtils.substringBetween(" ", " "));
|
||||||
|
assertEquals(null, StringUtils.substringBetween("abc", null));
|
||||||
|
assertEquals("", StringUtils.substringBetween("abc", ""));
|
||||||
|
assertEquals(null, StringUtils.substringBetween("abc", "a"));
|
||||||
|
assertEquals("bc", StringUtils.substringBetween("abca", "a"));
|
||||||
|
assertEquals("bc", StringUtils.substringBetween("abcabca", "a"));
|
||||||
|
assertEquals("bar", StringUtils.substringBetween("\nbar\n", "\n"));
|
||||||
|
}
|
||||||
|
|
||||||
|
public void testSubstringBetween_StringStringString() {
|
||||||
|
assertEquals(null, StringUtils.substringBetween(null, "", ""));
|
||||||
|
assertEquals("", StringUtils.substringBetween("", "", ""));
|
||||||
|
assertEquals("", StringUtils.substringBetween(" ", " ", " "));
|
||||||
|
assertEquals("bar", StringUtils.substringBetween("<foo>bar</foo>", "<foo>", "</foo>") );
|
||||||
|
}
|
||||||
|
|
||||||
//-----------------------------------------------------------------------
|
//-----------------------------------------------------------------------
|
||||||
public void testCountMatches_String() {
|
public void testCountMatches_String() {
|
||||||
assertEquals(0, StringUtils.countMatches(null, null));
|
assertEquals(0, StringUtils.countMatches(null, null));
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue