Save This Page
Home » commons-lang-2.5-src » org.apache.commons » lang » [javadoc | source]
org.apache.commons.lang
public class: StringEscapeUtils [javadoc | source]
java.lang.Object
   org.apache.commons.lang.StringEscapeUtils

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

Constructor:
 public StringEscapeUtils() 
Method from org.apache.commons.lang.StringEscapeUtils Summary:
escapeCsv,   escapeCsv,   escapeHtml,   escapeHtml,   escapeJava,   escapeJava,   escapeJavaScript,   escapeJavaScript,   escapeSql,   escapeXml,   escapeXml,   unescapeCsv,   unescapeCsv,   unescapeHtml,   unescapeHtml,   unescapeJava,   unescapeJava,   unescapeJavaScript,   unescapeJavaScript,   unescapeXml,   unescapeXml
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.lang.StringEscapeUtils Detail:
 public static String escapeCsv(String str) 

    Returns a String value for a CSV column enclosed in double quotes, if required.

    If the value contains a comma, newline or double quote, then the String value is returned enclosed in double quotes.

    Any double quote characters in the value are escaped with another double quote.

    If the value does not contain a comma, newline or double quote, then the String value is returned unchanged.

    see Wikipedia and RFC 4180.
 public static  void escapeCsv(Writer out,
    String str) throws IOException 

    Writes a String value for a CSV column enclosed in double quotes, if required.

    If the value contains a comma, newline or double quote, then the String value is written enclosed in double quotes.

    Any double quote characters in the value are escaped with another double quote.

    If the value does not contain a comma, newline or double quote, then the String value is written unchanged (null values are ignored).

    see Wikipedia and RFC 4180.
 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. Note that the commonly used apostrophe escape character (') is not a legal entity and so is not supported).

 public static  void escapeHtml(Writer writer,
    String string) throws IOException 

    Escapes the characters in a String using HTML entities and writes them to a Writer.

    For example:

    "bread" & "butter"

    becomes:

    "bread" & "butter".

    Supports all known HTML 4.0 entities, including funky accents. Note that the commonly used apostrophe escape character (') is not a legal entity and so is not supported).

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

 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.

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

 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.

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

    Note that unicode characters greater than 0x7f are currently escaped to their numerical \\u equivalent. This may change in future releases.

 public static  void escapeXml(Writer writer,
    String str) throws IOException 

    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.

    Note that unicode characters greater than 0x7f are currently escaped to their numerical \\u equivalent. This may change in future releases.

 public static String unescapeCsv(String str) 

    Returns a String value for an unescaped CSV column.

    If the value is enclosed in double quotes, and contains a comma, newline or double quote, then quotes are removed.

    Any double quote escaped characters (a pair of double quotes) are unescaped to just one double quote.

    If the value is not enclosed in double quotes, or is and does not contain a comma, newline or double quote, then the String value is returned unchanged.

    see Wikipedia and RFC 4180.
 public static  void unescapeCsv(Writer out,
    String str) throws IOException 

    Returns a String value for an unescaped CSV column.

    If the value is enclosed in double quotes, and contains a comma, newline or double quote, then quotes are removed.

    Any double quote escaped characters (a pair of double quotes) are unescaped to just one double quote.

    If the value is not enclosed in double quotes, or is and does not contain a comma, newline or double quote, then the String value is returned unchanged.

    see Wikipedia and RFC 4180.
 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".

 public static  void unescapeHtml(Writer writer,
    String string) throws IOException 

    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".

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

 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.

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

 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.

 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.

    Note that numerical \\u unicode codes are unescaped to their respective unicode characters. This may change in future releases.

 public static  void unescapeXml(Writer writer,
    String str) throws IOException 

    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.

    Note that numerical \\u unicode codes are unescaped to their respective unicode characters. This may change in future releases.