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

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

  throws:

  IllegalArgumentException if the Writer is null

  throws:

  IOException if error occurs on underlying Writer

  Parameters:

  out - Writer to write escaped string into

  str - String to escape values in, may be null

  See Also:

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

  Parameters:

  str - String to escape values in, may be null

  Returns:

  String with escaped values, null if null string input

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

  throws:

  IllegalArgumentException if the Writer is null

  throws:

  IOException if error occurs on underlying Writer

  Parameters:

  out - Writer to write escaped string into

  str - String to escape values in, may be null

  See Also:

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

  Parameters:

  str - the String to unescape, may be null

  Returns:

  a new unescaped String, null if null string input

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

  throws:

  IllegalArgumentException if the Writer is null

  throws:

  IOException if error occurs on underlying Writer

  Parameters:

  out - the Writer used to output unescaped characters

  str - the String to unescape, may be null

• 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(String)

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

  throws:

  IllegalArgumentException if the Writer is null

  throws:

  IOException if error occurs on underlying Writer

  Parameters:

  out - the Writer used to output unescaped characters

  str - the String to unescape, may be null

  See Also:

  unescapeJava(Writer,String)