org.apache.commons.lang
Class StringEscapeUtils
public class StringEscapeUtils
Escapes and unescapes String
s for
Java, Java Script, HTML, XML, and SQL.
$Id: StringEscapeUtils.java 165657 2005-05-02 18:31:49Z ggregory $StringEscapeUtils() -
StringEscapeUtils instances should NOT be constructed in
standard programming.
|
static String | escapeHtml(String str) - Escapes the characters in a
String using HTML entities.
|
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 | escapeSql(String str) - Escapes the characters in a
String to be suitable to pass to
an SQL query.
|
static String | escapeXml(String str) - Escapes the characters in a
String using XML entities.
|
static String | unescapeHtml(String str) - Unescapes a string containing entity escapes to a string
containing the actual Unicode characters corresponding to the
escapes.
|
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 .
|
static String | unescapeXml(String str) - Unescapes a string containing XML entity escapes to a string
containing the actual Unicode characters corresponding to the
escapes.
|
StringEscapeUtils
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.
escapeHtml
public static String escapeHtml(String str)
Escapes the characters in a
String
using HTML entities.
For example:
"bread" & "butter"
becomes:
"bread" & "butter"
.
Supports all known HTML 4.0 entities, including funky accents.
str
- the String
to escape, may be null
- a new escaped
String
, null
if null string input
escapeJava
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 null
- String with escaped values,
null
if null string input
escapeJava
public 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 null
escapeJava(java.lang.String)
escapeJavaScript
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 null
- String with escaped values,
null
if null string input
escapeJavaScript
public 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 null
escapeJavaScript(java.lang.String)
escapeSql
public static String escapeSql(String str)
Escapes the characters in a
String
to be suitable to pass to
an SQL query.
For example,
statement.executeQuery("SELECT * FROM MOVIES WHERE TITLE='" +
StringEscapeUtils.escapeSql("McHale's Navy") +
"'");
At present, this method only turns single-quotes into doubled single-quotes
(
"McHale's Navy"
=>
"McHale''s Navy"
). It does not
handle the cases of percent (%) or underscore (_) for use in LIKE clauses.
see http://www.jguru.com/faq/view.jsp?EID=8881
str
- the string to escape, may be null
- a new String, escaped for SQL,
null
if null string input
escapeXml
public static String escapeXml(String str)
Escapes the characters in a
String
using XML entities.
For example:
"bread" & "butter" =>
"bread" & "butter".
Supports only the five basic XML entities (gt, lt, quot, amp, apos).
Does not support DTDs or external entities.
str
- the String
to escape, may be null
- a new escaped
String
, null
if null string input
unescapeXml(java.lang.String)
unescapeHtml
public static String unescapeHtml(String str)
Unescapes a string containing entity escapes to a string
containing the actual Unicode characters corresponding to the
escapes. Supports HTML 4.0 entities.
For example, the string "<Français>"
will become "<Français>"
If an entity is unrecognized, it is left alone, and inserted
verbatim into the result string. e.g. ">&zzzz;x" will
become ">&zzzz;x".
str
- the String
to unescape, may be null
- a new unescaped
String
, null
if null string input
unescapeJava
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 null
- a new unescaped
String
, null
if null string input
unescapeJava
public 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 null
unescapeJavaScript
public 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 null
- A new unescaped
String
, null
if null string input
unescapeJavaScript
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 null
unescapeXml
public static String unescapeXml(String str)
Unescapes a string containing XML entity escapes to a string
containing the actual Unicode characters corresponding to the
escapes.
Supports only the five basic XML entities (gt, lt, quot, amp, apos).
Does not support DTDs or external entities.
str
- the String
to unescape, may be null
- a new unescaped
String
, null
if null string input
Copyright © 2001-2005 - Apache Software Foundation