commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LANG-1139) Add replace by regular expression methods in StringUtils
Date Thu, 28 May 2015 12:29:23 GMT

    [ https://issues.apache.org/jira/browse/LANG-1139?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14562808#comment-14562808
] 

ASF GitHub Bot commented on LANG-1139:
--------------------------------------

GitHub user rikles opened a pull request:

    https://github.com/apache/commons-lang/pull/92

    LANG-1139: Add null safe methods in StringUtils to replace by regular…

    Add null safe methods in StringUtils to replace by regular expression : 
    ```java
    public static String replaceAll(final String text, final String regex, final String replacement);
    public static String replaceFirst(final String text, final String regex, final String
replacement);
    ```
    The `replacePattern(final String source, final String regex, final String replacement)`
method adds `Pattern#DOTALL` option by default which may be undesired. Moreover, this methods
is not null safe.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/rikles/commons-lang fix-LANG-1139

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/commons-lang/pull/92.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #92
    
----
commit 3acffccf15027bcf87e25a432f085c45e103b0ec
Author: Loic Guibert <lfdummy-apache@yahoo.fr>
Date:   2015-05-28T12:20:14Z

    LANG-1139: Add null safe methods in StringUtils to replace by regular expression :
      - StringUtils.replaceAll(String, String, String)
      - StringUtils.replaceFirst(String, String, String)

----


> Add replace by regular expression methods in StringUtils
> --------------------------------------------------------
>
>                 Key: LANG-1139
>                 URL: https://issues.apache.org/jira/browse/LANG-1139
>             Project: Commons Lang
>          Issue Type: New Feature
>          Components: lang.*
>            Reporter: Loic Guibert
>
> Add null safe methods in {{StringUtils}} to replace by regular expression :
> {code:java}
> public static String replaceAll(final String text, final String regex, final String replacement);
> public static String replaceFirst(final String text, final String regex, final String
replacement);
> {code}
> Those methods are null safe equivalent to :
> {code:java}
> String.replaceAll(String, String);
> String.replaceFirst(String, String);
> {code}
> The {{replacePattern(final String source, final String regex, final String replacement)}}
method adds {{Pattern#DOTALL}} option by default which may be undesired. Moreover, this methods
is not null safe.
> More details :
> {code:java}
> /**
>  * <p>Replaces each substring of the text String that matches the given regular
expression
>  * with the given replacement.</p>
>  *
>  * This method is a {@code null} safe equivalent to:
>  * <ul>
>  *  <li>{@code text.replaceAll(regex, replacement)}</li>
>  *  <li>{@code Pattern.compile(regex).matcher(text).replaceAll(replacement)}</li>
>  * </ul>
>  *
>  * <p>A {@code null} reference passed to this method is a no-op.</p>
>  *
>  * <p>Unlike in the {@link #replacePattern(String, String, String)} method, the
{@link Pattern#DOTALL} option
>  * is NOT automatically added.
>  * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
>  * DOTALL is also know as single-line mode in Perl.</p>
>  *
>  * <pre>
>  * StringUtils.replaceAll(null, *, *)      = null
>  * StringUtils.replaceAll("any", null, *)  = "any"
>  * StringUtils.replaceAll("any", *, null)  = "any"
>  * StringUtils.replaceAll("", "", "zzz")   = "zzz"
>  * StringUtils.replaceAll("", ".*", "zzz") = "zzz"
>  * StringUtils.replaceAll("", ".+", "zzz") = ""
>  * StringUtils.replaceAll("<__>\n<__>", "<.*>", "z") = "z\nz"
>  * StringUtils.replaceAll("<__>\n<__>", "(?s)<.*>", "z") = "z"
>  * StringUtils.replaceAll("ABCabc123", "[a-z]", "_")       = "ABC___123"
>  * StringUtils.replaceAll("ABCabc123", "[^A-Z0-9]+", "_")  = "ABC_123"
>  * StringUtils.replaceAll("ABCabc123", "[^A-Z0-9]+", "")   = "ABC123"
>  * StringUtils.replaceAll("Lorem ipsum  dolor   sit", "( +)([a-z]+)", "_$2") = "Lorem_ipsum_dolor_sit"
>  * </pre>
>  *
>  * @param text  text to search and replace in, may be null
>  * @param regex  the regular expression to which this string is to be matched
>  * @param replacement  the string to be substituted for each match
>  * @return  the text with any replacements processed,
>  *              {@code null} if null String input
>  *
>  * @throws  PatternSyntaxException
>  *              if the regular expression's syntax is invalid
>  *
>  * @see String#replaceAll(String, String)
>  * @see java.util.regex.Pattern
>  * @see java.util.regex.Pattern#DOTALL
>  */
> public static String replaceAll(final String text, final String regex, final String replacement);
> /**
>  * <p>Replaces the first substring of the text string that matches the given regular
expression
>  * with the given replacement.</p>
>  *
>  * This method is a {@code null} safe equivalent to:
>  * <ul>
>  *  <li>{@code text.replaceFirst(regex, replacement)}</li>
>  *  <li>{@code Pattern.compile(regex).matcher(text).replaceFirst(replacement)}</li>
>  * </ul>
>  *
>  * <p>A {@code null} reference passed to this method is a no-op.</p>
>  *
>  * <p>The {@link Pattern#DOTALL} option is NOT automatically added.
>  * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
>  * DOTALL is also know as single-line mode in Perl.</p>
>  *
>  * <pre>
>  * StringUtils.replaceFirst(null, *, *)      = null
>  * StringUtils.replaceFirst("any", null, *)  = "any"
>  * StringUtils.replaceFirst("any", *, null)  = "any"
>  * StringUtils.replaceFirst("", "", "zzz")   = "zzz"
>  * StringUtils.replaceFirst("", ".*", "zzz") = "zzz"
>  * StringUtils.replaceFirst("", ".+", "zzz") = ""
>  * StringUtils.replaceFirst("<__>\n<__>", "<.*>", "z") = "z\n<__>"
>  * StringUtils.replaceFirst("<__>\n<__>", "(?s)<.*>", "z") = "z"
>  * StringUtils.replaceFirst("ABCabc123", "[a-z]", "_") = "ABC_bc123"
>  * StringUtils.replaceFirst("ABCabc123abc", "[^A-Z0-9]+", "_") = "ABC_123abc"
>  * StringUtils.replaceFirst("ABCabc123abc", "[^A-Z0-9]+", "") = "ABC123abc"
>  * StringUtils.replaceFirst("Lorem ipsum  dolor   sit", "( +)([a-z]+)", "_$2") = "Lorem_ipsum
 dolor   sit"
>  * </pre>
>  *
>  * @param text  text to search and replace in, may be null
>  * @param regex  the regular expression to which this string is to be matched
>  * @param replacement  the string to be substituted for the first match
>  * @return  the text with the first replacement processed,
>  *              {@code null} if null String input
>  *
>  * @throws  PatternSyntaxException
>  *              if the regular expression's syntax is invalid
>  *
>  * @see String#replaceFirst(String, String)
>  * @see java.util.regex.Pattern
>  * @see java.util.regex.Pattern#DOTALL
>  */
> public static String replaceFirst(final String text, final String regex, final String
replacement);
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message