public class StringEscapeUtils
extends java.lang.Object
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
| Constructor and Description | 
|---|
| StringEscapeUtils()StringEscapeUtilsinstances should NOT be constructed in
 standard programming. | 
| Modifier and Type | Method and Description | 
|---|---|
| static java.lang.String | escapeJava(java.lang.String str)Escapes the characters in a  Stringusing Java String rules. | 
| static void | escapeJava(java.io.Writer out,
          java.lang.String str)Escapes the characters in a  Stringusing Java String rules to
 aWriter. | 
| static java.lang.String | escapeJavaScript(java.lang.String str)Escapes the characters in a  Stringusing JavaScript String rules. | 
| static void | escapeJavaScript(java.io.Writer out,
                java.lang.String str)Escapes the characters in a  Stringusing JavaScript String rules
 to aWriter. | 
| static java.lang.String | unescapeJava(java.lang.String str)Unescapes any Java literals found in the  String. | 
| static void | unescapeJava(java.io.Writer out,
            java.lang.String str)Unescapes any Java literals found in the  Stringto aWriter. | 
| static java.lang.String | unescapeJavaScript(java.lang.String str)Unescapes any JavaScript literals found in the  String. | 
| static void | unescapeJavaScript(java.io.Writer out,
                  java.lang.String str)Unescapes any JavaScript literals found in the  Stringto aWriter. | 
public StringEscapeUtils()
StringEscapeUtils instances 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.
public static java.lang.String escapeJava(java.lang.String str)
String using 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: He didn't say, "Stop!" output string: He didn't say, \"Stop!\"
str - String to escape values in, may be nullnull if null string inputpublic static void escapeJava(java.io.Writer out,
                              java.lang.String str)
                       throws java.io.IOException
String using Java String rules to
 a Writer.
 
 A null string input has no effect.
out - Writer to write escaped string intostr - String to escape values in, may be nulljava.lang.IllegalArgumentException - if the Writer is nulljava.io.IOException - if error occurs on underlying WriterescapeJava(java.lang.String)public static java.lang.String escapeJavaScript(java.lang.String str)
String using 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: He didn't say, "Stop!" output string: He didn\'t say, \"Stop!\"
str - String to escape values in, may be nullnull if null string inputpublic static void escapeJavaScript(java.io.Writer out,
                                    java.lang.String str)
                             throws java.io.IOException
String using JavaScript String rules
 to a Writer.
 
 A null string input has no effect.
out - Writer to write escaped string intostr - String to escape values in, may be nulljava.lang.IllegalArgumentException - if the Writer is nulljava.io.IOException - if error occurs on underlying WriterescapeJavaScript(java.lang.String)public static java.lang.String unescapeJava(java.lang.String str)
String.
 For example, it will turn a sequence of '\' and
 'n' into a newline character, unless the '\'
 is preceded by another '\'.str - the String to unescape, may be nullString, null if null string inputpublic static void unescapeJava(java.io.Writer out,
                                java.lang.String str)
                         throws java.io.IOException
Unescapes any Java literals found in the String to a
 Writer.
 
 For example, it will turn a sequence of '\' and
 'n' into a newline character, unless the '\'
 is preceded by another '\'.
 
 A null string input has no effect.
out - the Writer used to output unescaped charactersstr - the String to unescape, may be nulljava.lang.IllegalArgumentException - if the Writer is nulljava.io.IOException - if error occurs on underlying Writerpublic static java.lang.String unescapeJavaScript(java.lang.String str)
String.
 
 For example, it will turn a sequence of '\' and 'n'
 into a newline character, unless the '\' is preceded by another
 '\'.
str - the String to unescape, may be nullString, null if null string inputunescapeJava(String)public static void unescapeJavaScript(java.io.Writer out,
                                      java.lang.String str)
                               throws java.io.IOException
String to a
 Writer.
 
 For example, it will turn a sequence of '\' and 'n'
 into a newline character, unless the '\' is preceded by another
 '\'.
 
 A null string input has no effect.
out - the Writer used to output unescaped charactersstr - the String to unescape, may be nulljava.lang.IllegalArgumentException - if the Writer is nulljava.io.IOException - if error occurs on underlying WriterunescapeJava(Writer,String)