org.apache.commons.lang

Class StringEscapeUtils

public class StringEscapeUtils extends Object

Escapes and unescapes Strings for Java, Java Script, HTML, XML, and SQL.

Since: 2.0

Version: $Id: StringEscapeUtils.java 165657 2005-05-02 18:31:49Z ggregory $

Author: Apache Jakarta Turbine GenerationJavaCore library Purple Technology Henri Yandell Alexander Day Chaffee Antony Riley Helge Tesgaard Sean Brown Gary Gregory Phil Steitz Pete Gieser

Constructor Summary
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 Summary
static StringescapeHtml(String str)

Escapes the characters in a String using HTML entities.

For example:

"bread" & "butter"

becomes:

"bread" & "butter".

static StringescapeJava(String str)

Escapes the characters in a String using Java String rules.

Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.)

static voidescapeJava(Writer out, String str)

Escapes the characters in a String using Java String rules to a Writer.

A null string input has no effect.

static StringescapeJavaScript(String str)

Escapes the characters in a String using JavaScript String rules.

Escapes any values it finds into their JavaScript String form.

static voidescapeJavaScript(Writer out, String str)

Escapes the characters in a String using JavaScript String rules to a Writer.

A null string input has no effect.

static StringescapeSql(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").

static StringescapeXml(String str)

Escapes the characters in a String using XML entities.

For example: "bread" & "butter" => "bread" & "butter".

static StringunescapeHtml(String str)

Unescapes a string containing entity escapes to a string containing the actual Unicode characters corresponding to the escapes.

static StringunescapeJava(String str)

Unescapes any Java literals found in the String.

static voidunescapeJava(Writer out, String str)

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.

static StringunescapeJavaScript(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 '\'.

static voidunescapeJavaScript(Writer out, String str)

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.

static StringunescapeXml(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).

Constructor Detail

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.

Method Detail

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.

Parameters: str the String to escape, may be null

Returns: a new escaped String, null if null string input

See Also: unescapeHtml
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 positions

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!\"
 

Parameters: str String to escape values in, may be null

Returns: String with escaped values, null if null string input

escapeJava

public static void escapeJava(Writer out, String str)

Escapes the characters in a String using Java String rules to a Writer.

A null string input has no effect.

Parameters: out Writer to write escaped string into str String to escape values in, may be null

Throws: IllegalArgumentException if the Writer is null IOException if error occurs on underlying Writer

See Also: StringEscapeUtils

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!\"
 

Parameters: str String to escape values in, may be null

Returns: String with escaped values, null if null string input

escapeJavaScript

public static void escapeJavaScript(Writer out, String str)

Escapes the characters in a String using JavaScript String rules to a Writer.

A null string input has no effect.

Parameters: out Writer to write escaped string into str String to escape values in, may be null

Throws: IllegalArgumentException if the Writer is null IOException if error occurs on underlying Writer

See Also: StringEscapeUtils

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

Parameters: str the string to escape, may be null

Returns: 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.

Parameters: str the String to escape, may be null

Returns: a new escaped String, null if null string input

See Also:

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 "&lt;Fran&ccedil;ais&gt;" will become "<Français>"

If an entity is unrecognized, it is left alone, and inserted verbatim into the result string. e.g. "&gt;&zzzz;x" will become ">&zzzz;x".

Parameters: str the String to unescape, may be null

Returns: a new unescaped String, null if null string input

See Also:

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 '\'.

Parameters: str the String to unescape, may be null

Returns: a new unescaped String, null if null string input

unescapeJava

public static void unescapeJava(Writer out, String str)

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.

Parameters: out the Writer used to output unescaped characters str the String to unescape, may be null

Throws: IllegalArgumentException if the Writer is null IOException if error occurs on underlying Writer

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 '\'.

Parameters: str the String to unescape, may be null

Returns: A new unescaped String, null if null string input

See Also: unescapeJava

unescapeJavaScript

public static void unescapeJavaScript(Writer out, String str)

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.

Parameters: out the Writer used to output unescaped characters str the String to unescape, may be null

Throws: IllegalArgumentException if the Writer is null IOException if error occurs on underlying Writer

See Also: unescapeJava

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.

Parameters: str the String to unescape, may be null

Returns: a new unescaped String, null if null string input

See Also:

Copyright © 2001-2005 - Apache Software Foundation