Add RegExUtils.removePattern(CharSequence, String) and deprecate

RegExUtils.removePattern(String, String)

Author: garydgregory

src/changes/changes.xml

@@ -91,6 +91,7 @@ The <action> type attribute can be add,update,fix,remove.
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add Predicates.</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add RegExUtils.dotAllMatcher(String, CharSequence) and deprecate RegExUtils.dotAllMatcher(String, String).</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add RegExUtils.replacePattern(CharSequence, String, String) and deprecate RegExUtils.replacePattern(String, String, String).</action>
+    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add RegExUtils.removePattern(CharSequence, String) and deprecate RegExUtils.removePattern(String, String).</action>
     <!-- UPDATE -->
     <action                   type="update" dev="ggregory" due-to="Gary Gregory, Dependabot">Bump org.apache.commons:commons-parent from 73 to 79 #1267, #1277, #1283, #1288, #1302.</action>
     <action                   type="update" dev="ggregory" due-to="Gary Gregory, Dependabot">[site] Bump org.codehaus.mojo:taglist-maven-plugin from 3.1.0 to 3.2.1 #1300.</action>

src/main/java/org/apache/commons/lang3/RegExUtils.java

@@ -113,7 +113,7 @@ public static String removeAll(final String text, final Pattern regex) {
      *
      * <p>A {@code null} reference passed to this method is a no-op.</p>
      *
-     * <p>Unlike in the {@link #removePattern(String, String)} method, the {@link Pattern#DOTALL} option
+     * <p>Unlike in the {@link #removePattern(CharSequence, String)} method, the {@link Pattern#DOTALL} option
      * is NOT automatically added.
      * To use the DOTALL option prepend {@code "(?s)"} to the regex.
      * DOTALL is also known as single-line mode in Perl.</p>
@@ -139,7 +139,7 @@ public static String removeAll(final String text, final Pattern regex) {
      *              if the regular expression's syntax is invalid
      *
      * @see #replaceAll(String, String, String)
-     * @see #removePattern(String, String)
+     * @see #removePattern(CharSequence, String)
      * @see String#replaceAll(String, String)
      * @see java.util.regex.Pattern
      * @see java.util.regex.Pattern#DOTALL
@@ -256,6 +256,39 @@ public static String removeFirst(final String text, final String regex) {
      * @see String#replaceAll(String, String)
      * @see Pattern#DOTALL
      */
+    public static CharSequence removePattern(final CharSequence text, final String regex) {
+        return replacePattern(text, regex, StringUtils.EMPTY);
+    }
+
+    /**
+     * Removes each substring of the source String that matches the given regular expression using the DOTALL option.
+     *
+     * This call is a {@code null} safe equivalent to:
+     * <ul>
+     * <li>{@code text.replaceAll(&quot;(?s)&quot; + regex, StringUtils.EMPTY)}</li>
+     * <li>{@code Pattern.compile(regex, Pattern.DOTALL).matcher(text).replaceAll(StringUtils.EMPTY)}</li>
+     * </ul>
+     *
+     * <p>A {@code null} reference passed to this method is a no-op.</p>
+     *
+     * <pre>{@code
+     * StringUtils.removePattern(null, *)       = null
+     * StringUtils.removePattern("any", (String) null)   = "any"
+     * StringUtils.removePattern("A<__>\n<__>B", "<.*>")  = "AB"
+     * StringUtils.removePattern("ABCabc123", "[a-z]")    = "ABC123"
+     * }</pre>
+     *
+     * @param text
+     *            the source string
+     * @param regex
+     *            the regular expression to which this string is to be matched
+     * @return The resulting {@link String}
+     * @see #replacePattern(CharSequence, String, String)
+     * @see String#replaceAll(String, String)
+     * @see Pattern#DOTALL
+     * @deprecated use {@link #removePattern(CharSequence, String)}.
+     */
+    @Deprecated
     public static String removePattern(final String text, final String regex) {
         return replacePattern(text, regex, StringUtils.EMPTY);
     }

src/test/java/org/apache/commons/lang3/RegExUtilsTest.java

@@ -125,7 +125,24 @@ public void testRemoveFirst_StringString() {
     }
 
     @Test
-    public void testRemovePattern_StringString() {
+    public void testRemovePattern() {
+        assertNull(RegExUtils.removePattern((CharSequence) null, ""));
+        assertEquals("any", RegExUtils.removePattern((CharSequence) "any", (String) null));
+
+        assertEquals("", RegExUtils.removePattern((CharSequence) "", ""));
+        assertEquals("", RegExUtils.removePattern((CharSequence) "", ".*"));
+        assertEquals("", RegExUtils.removePattern((CharSequence) "", ".+"));
+
+        assertEquals("AB", RegExUtils.removePattern((CharSequence) "A<__>\n<__>B", "<.*>"));
+        assertEquals("AB", RegExUtils.removePattern((CharSequence) "A<__>\\n<__>B", "<.*>"));
+        assertEquals("", RegExUtils.removePattern((CharSequence) "<A>x\\ny</A>", "<A>.*</A>"));
+        assertEquals("", RegExUtils.removePattern((CharSequence) "<A>\nxy\n</A>", "<A>.*</A>"));
+
+        assertEquals("ABC123", RegExUtils.removePattern((CharSequence) "ABCabc123", "[a-z]"));
+    }
+
+    @Test
+    public void testRemovePatternDeprecated() {
         assertNull(RegExUtils.removePattern(null, ""));
         assertEquals("any", RegExUtils.removePattern("any", (String) null));