public class StringEscapeUtils extends Object
Escapes and unescapes 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()
StringEscapeUtils instances should NOT be constructed in
standard programming. |
| Modifier and Type | Method and Description |
|---|---|
static String |
escapeJava(String str)
Escapes the characters in a
String using Java String rules. |
static void |
escapeJava(Writer out,
String str)
Escapes the characters in a
String using Java String rules to
a Writer. |
static String |
escapeJavaScript(String str)
Escapes the characters in a
String using JavaScript String rules. |
static void |
escapeJavaScript(Writer out,
String str)
Escapes the characters in a
String using JavaScript String rules
to a Writer. |
static String |
unescapeJava(String str)
Unescapes any Java literals found in the
String. |
static void |
unescapeJava(Writer out,
String str)
Unescapes any Java literals found in the
String to a
Writer. |
static String |
unescapeJavaScript(String str)
Unescapes any JavaScript literals found in the
String. |
static void |
unescapeJavaScript(Writer out,
String str)
Unescapes any JavaScript literals found in the
String to a
Writer. |
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 String escapeJava(String str)
Escapes the characters in a 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(Writer out, String str) throws IOException
Escapes the characters in a 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 nullIllegalArgumentException - if the Writer is nullIOException - if error occurs on underlying WriterescapeJava(java.lang.String)public static String escapeJavaScript(String str)
Escapes the characters in a 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(Writer out, String str) throws IOException
Escapes the characters in a 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 nullIllegalArgumentException - if the Writer is nullIOException - if error occurs on underlying WriterescapeJavaScript(java.lang.String)public static String unescapeJava(String str)
Unescapes any Java literals found in the 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(Writer out, String str) throws 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 nullIllegalArgumentException - if the Writer is nullIOException - if error occurs on underlying Writerpublic static String unescapeJavaScript(String str)
Unescapes any JavaScript literals found in the 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(Writer out, String str) throws IOException
Unescapes any JavaScript 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 nullIllegalArgumentException - if the Writer is nullIOException - if error occurs on underlying WriterunescapeJava(Writer,String)