Java String replaceAll Recursive behavior

Question

Yesterday I was working on customized letters and memos. And I have made mapping keywords, like: [Dateofbirth], [Email], [Employee], [Salary] etc, which will be replace at the time of generation.

Example: dear [Employee], your Current Salary is [Salary].

expected output:

Output: dear John, your Current Salary is 12000.

I am using replaceAll() method here is a code.

   String str = "dear [Employee], your Current Salary is [Salary].";
        Map<String,String> vals = new HashMap<String,String>();
        vals.put("[Employee]","John");
        vals.put("[Salary]","12000");
        for(String key:vals.keySet()){
            str=str.replaceAll(key,vals.get(key));
        }
        System.out.println(str);

but the out is:

dJohn1200012000 [JohnJohnJohnJohnJohnJohnJohnJohn], JohnJohnu12000 Cu1200012000Johnnt 1200012000John1200012000John is [1200012000John1200012000John].

I was confused and Googled it and tried to make it correct, after that I changed replaceAll() with replace()

EX: str=str.replace(key,vals.get(key));

Now it is working fine. The question is Why replace all is doing such kind of behavior what is the core concept of replaceAll() and When to use replace() when to use replaceAll(). Thanks

Suresh Atta · Accepted Answer · 2018-01-31 05:50:08Z

3

Before going to your problem, I hope you know about String#format that Java API have. With that you could simply write

String formattedString = String.format("dear %s, your Current Salary is %.2f", "John", 12000.45);
System.out.println(formattedString);

If you are doing that yourself for unavoidable situations, replaceAll treats the first parameter as a regex and not normal string to replace.

From docs of replaceAll.

Replaces each substring of this string that matches the given regular expression with the given replacement.

Since your parameter consists of [and] and they are matching with each character inside them.

It will work if you get rid of that [] and use any other special characters that are not meta characters for ex #.

    String str = "dear #Employee#, your Current Salary is #Salary#.";
    Map<String, String> vals = new HashMap<String, String>();
    vals.put("#Employee#", "John");
    vals.put("#Salary#", "12000");
    for (String key : vals.keySet()) {
        str = str.replaceAll(key, vals.get(key));
    }
    System.out.println(str);

gives you

dear John, your Current Salary is 12000.

Or simply use replace() as you said in the end.

edited Jan 31, 2018 at 5:50

answered Jan 31, 2018 at 5:38

Suresh Atta

122k38 gold badges206 silver badges315 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Hulk Over a year ago

+1, although it is worth mentioning that named placeholders are preferable to numbered or unnamed, position dependent placeholders like %s in many situations - e.g. messages intended to be translated to several languages.

Junejo · Accepted Answer · 2018-01-31 06:40:51Z

Let us have a look at javadocs of replace and replaceAll methods. Go to javadocs

replace

public String replace(CharSequence target, CharSequence replacement)

Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence. The replacement proceeds from the beginning of the string to the end, for example, replacing "aa" with "b" in the string "aaa" will result in "ba" rather than "ab".

So in simple words it replaces all the target words with replacement words.

replaceAll

public String replaceAll(String regex, String replacement)

Replaces each substring of this string that matches the given regular expression with the given replacement.

To understand the given behavior, it is important to understand how regex works. Regex is a world in its own, however, we can discuss the given regex here.

Square brackets group a set of characters together. When invoked any character in that set gets matched.

For example: [abc] will match all the a, b and c. Since replaceAll uses regex to match, it would replace all a, b and c with replacement string.

Bohemian · Accepted Answer · 2018-01-31 05:39:41Z

1

replaceAll() matches using a regular expression.
replace() matches using plain text.

The regex [Employee] is a character class that matches any single character that is either E, m, p, l, o, y or e.

edited Jan 31, 2018 at 5:39

answered Jan 31, 2018 at 5:33

Bohemian♦

427k103 gold badges603 silver badges750 bronze badges

Comments

Divya Mamgai · Accepted Answer · 2018-01-31 05:41:51Z

1

replaceAll treats the first parameter as regex. So you need to escape the regex specific characters which in your case is [ and ]. They signify a set of characters hence the replaceAll is matching every character in that set and replacing with the value you provided. Try this instead to get the output you desire -

vals.put("\\[Employee\\]","John");
vals.put("\\[Salary\\]","12000");

Here we have escaped the special symbol [ and ] thus it no longer treats it as a set.

Working program - https://www.ideone.com/2hCbIM

answered Jan 31, 2018 at 5:41

Divya Mamgai

14810 bronze badges

2 Comments

Suresh Atta Over a year ago

Better, just avoid the char '[' and use something else instead of escaping it 1000 times.

Divya Mamgai Over a year ago

I agree, but OP wanted to use that character.

CGS · Accepted Answer · 2018-01-31 05:35:50Z

0

ReplaceAll compiles a regular expression and applies to the string. In this case, since your Key has '[' , it would match any of the characters present inside that. Hence, for each occurrence, it has replaced with the value

answered Jan 31, 2018 at 5:35

CGS

2,91020 silver badges25 bronze badges

Comments

Loganathan · Accepted Answer · 2018-01-31 05:36:00Z

0

replaceAll() expects a regular expression but replace() expects the exact string (char sequence). Regular expression requires its special characters escaped. So when it is required to simply replace a string use replace() method, and when it is required to match a regular expression and need to replace it, use replaceAll().

answered Jan 31, 2018 at 5:36

Loganathan

9212 gold badges11 silver badges23 bronze badges

Comments

Mitul Gedeeya · Accepted Answer · 2018-01-31 05:37:42Z

0

This link may be useful for you to understand it. Basically, there is only difference is replaceAll replaces all that strings which match regex provided as an argument and replace() replaces based on chars.

answered Jan 31, 2018 at 5:37

Mitul Gedeeya

9061 gold badge10 silver badges21 bronze badges

Collectives™ on Stack Overflow

Java String replaceAll Recursive behavior

7 Answers 7

1 Comment

replace

replaceAll

Comments

Comments

2 Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

1 Comment

replace

replaceAll

Comments

Comments

2 Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related