Class StringEscapeUtils
Strings for
Java, Java Script, HTML, XML, and SQL.
#ThreadSafe#
Note that this version is a stripped down version from Commons Lang 2.6 with only necessary methods for JSON builder
- Since:
- 2.0
-
Constructor Summary
ConstructorsConstructorDescriptionStringEscapeUtilsinstances should NOT be constructed in standard programming. -
Method Summary
Modifier and TypeMethodDescriptionstatic voidescapeJava(Writer out, String str) Escapes the characters in aStringusing Java String rules to aWriter.static StringescapeJava(String str) Escapes the characters in aStringusing Java String rules.static voidescapeJavaScript(Writer out, String str) Escapes the characters in aStringusing JavaScript String rules to aWriter.static StringescapeJavaScript(String str) Escapes the characters in aStringusing JavaScript String rules.static voidunescapeJava(Writer out, String str) Unescapes any Java literals found in theStringto aWriter.static StringunescapeJava(String str) Unescapes any Java literals found in theString.static voidunescapeJavaScript(Writer out, String str) Unescapes any JavaScript literals found in theStringto aWriter.static StringunescapeJavaScript(String str) Unescapes any JavaScript literals found in theString.
-
Constructor Details
-
StringEscapeUtils
public StringEscapeUtils()StringEscapeUtilsinstances should NOT be constructed in standard programming.Instead, the class should be used as:
StringEscapeUtils.escapeJava("foo");This constructor is public to permit tools that require a JavaBean instance to operate.
-
-
Method Details
-
escapeJava
Escapes the characters in aStringusing Java String rules.Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.)
So a tab becomes the characters
'\\'and't'.The only difference between Java strings and JavaScript strings is that in JavaScript, a single quote must be escaped.
Example:
input string: They didn't say, "Stop!" output string: They didn't say, \"Stop!\"
- Parameters:
str- String to escape values in, may be null- Returns:
- String with escaped values,
nullif null string input
-
escapeJava
Escapes the characters in aStringusing Java String rules to aWriter.A
nullstring input has no effect.- Parameters:
out- Writer to write escaped string intostr- String to escape values in, may be null- Throws:
IllegalArgumentException- if the Writer isnullIOException- if error occurs on underlying Writer- See Also:
-
escapeJavaScript
Escapes the characters in aStringusing JavaScript String rules.Escapes any values it finds into their JavaScript String form. Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.)
So a tab becomes the characters
'\\'and't'.The only difference between Java strings and JavaScript strings is that in JavaScript, a single quote must be escaped.
Example:
input string: They didn't say, "Stop!" output string: They didn\'t say, \"Stop!\"
- Parameters:
str- String to escape values in, may be null- Returns:
- String with escaped values,
nullif null string input
-
escapeJavaScript
Escapes the characters in aStringusing JavaScript String rules to aWriter.A
nullstring input has no effect.- Parameters:
out- Writer to write escaped string intostr- String to escape values in, may be null- Throws:
IllegalArgumentException- if the Writer isnullIOException- if error occurs on underlying Writer- See Also:
-
unescapeJava
Unescapes any Java literals found in theString. For example, it will turn a sequence of'\'and'n'into a newline character, unless the'\'is preceded by another'\'.- Parameters:
str- theStringto unescape, may be null- Returns:
- a new unescaped
String,nullif null string input
-
unescapeJava
Unescapes any Java literals found in the
Stringto aWriter.For example, it will turn a sequence of
'\'and'n'into a newline character, unless the'\'is preceded by another'\'.A
nullstring input has no effect.- Parameters:
out- theWriterused to output unescaped charactersstr- theStringto unescape, may be null- Throws:
IllegalArgumentException- if the Writer isnullIOException- if error occurs on underlying Writer
-
unescapeJavaScript
Unescapes any JavaScript literals found in theString.For example, it will turn a sequence of
'\'and'n'into a newline character, unless the'\'is preceded by another'\'.- Parameters:
str- theStringto unescape, may be null- Returns:
- A new unescaped
String,nullif null string input - See Also:
-
unescapeJavaScript
Unescapes any JavaScript literals found in theStringto aWriter.For example, it will turn a sequence of
'\'and'n'into a newline character, unless the'\'is preceded by another'\'.A
nullstring input has no effect.- Parameters:
out- theWriterused to output unescaped charactersstr- theStringto unescape, may be null- Throws:
IllegalArgumentException- if the Writer isnullIOException- if error occurs on underlying Writer- See Also:
-