|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.lang.StringEscapeUtils
Escapes and unescapes String
s for
Java, Java Script, HTML, XML, and SQL.
Constructor Summary | |
---|---|
StringEscapeUtils()
StringEscapeUtils instances should NOT be constructed in
standard programming. |
Method Summary | |
---|---|
static java.lang.String |
escapeHtml(java.lang.String str)
Escapes the characters in a String using HTML entities. |
static java.lang.String |
escapeJava(java.lang.String str)
Escapes the characters in a String using Java String rules. |
static void |
escapeJava(java.io.Writer out,
java.lang.String str)
Escapes the characters in a String using Java String rules to
a Writer . |
static java.lang.String |
escapeJavaScript(java.lang.String str)
Escapes the characters in a String using JavaScript String rules. |
static void |
escapeJavaScript(java.io.Writer out,
java.lang.String str)
Escapes the characters in a String using JavaScript String rules
to a Writer . |
static java.lang.String |
escapeSql(java.lang.String str)
Escapes the characters in a String to be suitable to pass to
an SQL query. |
static java.lang.String |
escapeXml(java.lang.String str)
Escapes the characters in a String using XML entities. |
static java.lang.String |
unescapeHtml(java.lang.String str)
Unescapes a string containing entity escapes to a string containing the actual Unicode characters corresponding to the escapes. |
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 String to a
Writer . |
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 String to a
Writer . |
static java.lang.String |
unescapeXml(java.lang.String str)
Unescapes a string containing XML entity escapes to a string containing the actual Unicode characters corresponding to the escapes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
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.
Method Detail |
public static java.lang.String escapeJava(java.lang.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
null
if null string inputpublic static void escapeJava(java.io.Writer out, java.lang.String str) throws java.io.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
java.lang.IllegalArgumentException
- if the Writer is null
java.io.IOException
- if error occurs on undelying WriterescapeJava(java.lang.String)
public static java.lang.String escapeJavaScript(java.lang.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
null
if null string inputpublic static void escapeJavaScript(java.io.Writer out, java.lang.String str) throws java.io.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
java.lang.IllegalArgumentException
- if the Writer is null
java.io.IOException
- if error occurs on undelying WriterescapeJavaScript(java.lang.String)
public static java.lang.String unescapeJava(java.lang.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
String
, 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 null
java.lang.IllegalArgumentException
- if the Writer is null
java.io.IOException
- if error occurs on undelying Writerpublic static java.lang.String unescapeJavaScript(java.lang.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
String
, null
if null string inputunescapeJava(String)
public static void unescapeJavaScript(java.io.Writer out, java.lang.String str) throws java.io.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
java.lang.IllegalArgumentException
- if the Writer is null
java.io.IOException
- if error occurs on undelying WriterunescapeJava(Writer,String)
public static java.lang.String escapeHtml(java.lang.String str)
Escapes the characters in a String
using HTML entities.
For example: "bread" & "butter" => "bread" & "butter".
Supports all known HTML 4.0 entities, including funky accents.
str
- the String
to escape, may be null
String
, null
if null string inputunescapeHtml(String)
,
ISO Entities,
HTML 3.2 Character Entities for ISO Latin-1,
HTML 4.0 Character entity references,
HTML 4.01 Character References,
HTML 4.01 Code positionspublic static java.lang.String unescapeHtml(java.lang.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
String
, null
if null string inputescapeHtml(String)
public static java.lang.String escapeXml(java.lang.String str)
Escapes the characters in a String
using XML entities.
For example: "bread" & "butter" => "bread" & "butter".
Supports only the four basic XML entities (gt, lt, quot, amp). Does not support DTDs or external entities.
str
- the String
to escape, may be null
String
, null
if null string inputunescapeXml(java.lang.String)
public static java.lang.String unescapeXml(java.lang.String str)
Unescapes a string containing XML entity escapes to a string containing the actual Unicode characters corresponding to the escapes.
Supports only the four basic XML entities (gt, lt, quot, amp). Does not support DTDs or external entities.
str
- the String
to unescape, may be null
String
, null
if null string inputescapeXml(String)
public static java.lang.String escapeSql(java.lang.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.
str
- the string to escape, may be null
null
if null string input
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |