[LANG-505] Rewrite StringEscapeUtils

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0
• Component/s: lang.*
• Assignee: Unassigned
• Reporter: Henri Yandell
• Created: 18/May/09 06:18
• Updated: 17/Dec/09 03:41
• Resolved: 19/Jul/09 18:30

Description

I think StringEscapeUtils needs a strong rewrite. For each escape method (and unescape) there tend to be three or four types of escaping happening. So not being able to define which set of three or four apply is a pain point (and cause of bug reports due to different desired features).

We should be offering basic functionality, but also allowing people to say "escape(Escapers.BASIC_XML, Escapers.LOW_UNICODE, Escapers.HIGH_UNICODE)".

Also should delete escapeSql; it's a bad one imo. Dangerous in that it will lead people to not use PreparedStatement and given it only escapes ', it's not much use. Especially as different dialects escape that in different ways.

Opening this ticket for discussion.

Issue Links

• is related to: LANG-66 [lang] StringEscaper.escapeXml() escapes characters > 0x7f
• is related to: LANG-339 StringEscapeUtils.escapeHtml() escapes multibyte characters like Chinese, Japanese, etc.
• is related to: LANG-439 StringEscapeUtils.escapeHTML() does not escape chars (0x00-0x20)
• is related to: LANG-448 Lower Ascii Characters don't get encoded by Entities.java
• is related to: LANG-506 Entities - missing final modifiers; thread-safety issues
• is related to: LANG-498 Add StringEscapeUtils.escapeText() methods
• is related to: LANG-293 StringEscapeUtils.unescape* can be faster
• is related to: LANG-204 [lang] org.apache.commons.lang.Entities multithreaded init.
• is related to: LANG-507 StringEscapeUtils.unescapeJava should support \u+ notation
• relates to: LANG-515 Define standard escape/unescape behaviours