[LANG-410] Ambiguous / confusing names in StringUtils replace* methods

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.4
• Component/s: lang.*
• Assignee: Unassigned
• Reporter: Sebb
• Created: 06/Feb/08 19:10
• Updated: 16/Dec/09 08:50
• Resolved: 17/Feb/08 01:27

Description

The recently added replaceEach* methods use "repl" for the original string list, and "with" for the new (replacement) string list.

These names are rather confusing.

RE engines tend to use words such as:

Perl:
searchlist
replacementlist

ORO:
pattern
replacement

Java has String.replace(regex, replacement)

In all cases, "replacement" is used for the NEW string, not the original string which is to be replaced.

Seems to me that searchString/List and replacement[List] would be unambiguous as well as descriptive.
Also useful in IDEs which show possible method completions.

Changing the names of the parameters would not affect the API.

Patch to follow