Index: libadblockplus-android/src/org/apache/commons/lang/StringEscapeUtils.java |
diff --git a/libadblockplus-android/src/org/apache/commons/lang/StringEscapeUtils.java b/libadblockplus-android/src/org/apache/commons/lang/StringEscapeUtils.java |
index 80a420d2fbdb325f9f554a4e5810df8e10428520..27cc9fba34e30abd2d3ed6b40039d61d22ddc376 100644 |
--- a/libadblockplus-android/src/org/apache/commons/lang/StringEscapeUtils.java |
+++ b/libadblockplus-android/src/org/apache/commons/lang/StringEscapeUtils.java |
@@ -40,575 +40,641 @@ import java.io.Writer; |
* @since 2.0 |
* @version $Id: StringEscapeUtils.java 612880 2008-01-17 17:34:43Z ggregory $ |
*/ |
-public class StringEscapeUtils { |
+public class StringEscapeUtils |
+{ |
+ private static final char CSV_DELIMITER = ','; |
+ private static final char CSV_QUOTE = '"'; |
+ private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE); |
+ private static final char[] CSV_SEARCH_CHARS = new char[]{CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF}; |
- private static final char CSV_DELIMITER = ','; |
- private static final char CSV_QUOTE = '"'; |
- private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE); |
- private static final char[] CSV_SEARCH_CHARS = new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF}; |
+ /** |
+ * <p><code>StringEscapeUtils</code> instances should NOT be constructed in |
+ * standard programming.</p> |
+ * |
+ * <p>Instead, the class should be used as: |
+ * <pre>StringEscapeUtils.escapeJava("foo");</pre></p> |
+ * |
+ * <p>This constructor is public to permit tools that require a JavaBean |
+ * instance to operate.</p> |
+ */ |
+ public StringEscapeUtils() |
+ { |
+ super(); |
+ } |
- /** |
- * <p><code>StringEscapeUtils</code> instances should NOT be constructed in |
- * standard programming.</p> |
- * |
- * <p>Instead, the class should be used as: |
- * <pre>StringEscapeUtils.escapeJava("foo");</pre></p> |
- * |
- * <p>This constructor is public to permit tools that require a JavaBean |
- * instance to operate.</p> |
- */ |
- public StringEscapeUtils() { |
- super(); |
- } |
+ // Java and JavaScript |
+ //-------------------------------------------------------------------------- |
- // Java and JavaScript |
- //-------------------------------------------------------------------------- |
- /** |
- * <p>Escapes the characters in a <code>String</code> using Java String rules.</p> |
- * |
- * <p>Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) </p> |
- * |
- * <p>So a tab becomes the characters <code>'\\'</code> and |
- * <code>'t'</code>.</p> |
- * |
- * <p>The only difference between Java strings and JavaScript strings |
- * is that in JavaScript, a single quote must be escaped.</p> |
- * |
- * <p>Example: |
- * <pre> |
- * input string: He didn't say, "Stop!" |
- * output string: He didn't say, \"Stop!\" |
- * </pre> |
- * </p> |
- * |
- * @param str String to escape values in, may be null |
- * @return String with escaped values, <code>null</code> if null string input |
- */ |
- public static String escapeJava(String str) { |
- return escapeJavaStyleString(str, false); |
- } |
+ /** |
+ * <p>Escapes the characters in a <code>String</code> using Java String rules.</p> |
+ * |
+ * <p>Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) </p> |
+ * |
+ * <p>So a tab becomes the characters <code>'\\'</code> and |
+ * <code>'t'</code>.</p> |
+ * |
+ * <p>The only difference between Java strings and JavaScript strings |
+ * is that in JavaScript, a single quote must be escaped.</p> |
+ * |
+ * <p>Example: |
+ * <pre> |
+ * input string: He didn't say, "Stop!" |
+ * output string: He didn't say, \"Stop!\" |
+ * </pre> |
+ * </p> |
+ * |
+ * @param str String to escape values in, may be null |
+ * @return String with escaped values, <code>null</code> if null string input |
+ */ |
+ public static String escapeJava(String str) |
+ { |
+ return escapeJavaStyleString(str, false); |
+ } |
- /** |
- * <p>Escapes the characters in a <code>String</code> using Java String rules to |
- * a <code>Writer</code>.</p> |
- * |
- * <p>A <code>null</code> string input has no effect.</p> |
- * |
- * @see #escapeJava(java.lang.String) |
- * @param out Writer to write escaped string into |
- * @param str String to escape values in, may be null |
- * @throws IllegalArgumentException if the Writer is <code>null</code> |
- * @throws IOException if error occurs on underlying Writer |
- */ |
- public static void escapeJava(Writer out, String str) throws IOException { |
- escapeJavaStyleString(out, str, false); |
- } |
+ /** |
+ * <p>Escapes the characters in a <code>String</code> using Java String rules to |
+ * a <code>Writer</code>.</p> |
+ * |
+ * <p>A <code>null</code> string input has no effect.</p> |
+ * |
+ * @see #escapeJava(java.lang.String) |
+ * @param out Writer to write escaped string into |
+ * @param str String to escape values in, may be null |
+ * @throws IllegalArgumentException if the Writer is <code>null</code> |
+ * @throws IOException if error occurs on underlying Writer |
+ */ |
+ public static void escapeJava(Writer out, String str) throws IOException |
+ { |
+ escapeJavaStyleString(out, str, false); |
+ } |
- /** |
- * <p>Escapes the characters in a <code>String</code> using JavaScript String rules.</p> |
- * <p>Escapes any values it finds into their JavaScript String form. |
- * Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) </p> |
- * |
- * <p>So a tab becomes the characters <code>'\\'</code> and |
- * <code>'t'</code>.</p> |
- * |
- * <p>The only difference between Java strings and JavaScript strings |
- * is that in JavaScript, a single quote must be escaped.</p> |
- * |
- * <p>Example: |
- * <pre> |
- * input string: He didn't say, "Stop!" |
- * output string: He didn\'t say, \"Stop!\" |
- * </pre> |
- * </p> |
- * |
- * @param str String to escape values in, may be null |
- * @return String with escaped values, <code>null</code> if null string input |
- */ |
- public static String escapeJavaScript(String str) { |
- return escapeJavaStyleString(str, true); |
- } |
+ /** |
+ * <p>Escapes the characters in a <code>String</code> using JavaScript String rules.</p> |
+ * <p>Escapes any values it finds into their JavaScript String form. |
+ * Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) </p> |
+ * |
+ * <p>So a tab becomes the characters <code>'\\'</code> and |
+ * <code>'t'</code>.</p> |
+ * |
+ * <p>The only difference between Java strings and JavaScript strings |
+ * is that in JavaScript, a single quote must be escaped.</p> |
+ * |
+ * <p>Example: |
+ * <pre> |
+ * input string: He didn't say, "Stop!" |
+ * output string: He didn\'t say, \"Stop!\" |
+ * </pre> |
+ * </p> |
+ * |
+ * @param str String to escape values in, may be null |
+ * @return String with escaped values, <code>null</code> if null string input |
+ */ |
+ public static String escapeJavaScript(String str) |
+ { |
+ return escapeJavaStyleString(str, true); |
+ } |
- /** |
- * <p>Escapes the characters in a <code>String</code> using JavaScript String rules |
- * to a <code>Writer</code>.</p> |
- * |
- * <p>A <code>null</code> string input has no effect.</p> |
- * |
- * @see #escapeJavaScript(java.lang.String) |
- * @param out Writer to write escaped string into |
- * @param str String to escape values in, may be null |
- * @throws IllegalArgumentException if the Writer is <code>null</code> |
- * @throws IOException if error occurs on underlying Writer |
- **/ |
- public static void escapeJavaScript(Writer out, String str) throws IOException { |
- escapeJavaStyleString(out, str, true); |
+ /** |
+ * <p>Escapes the characters in a <code>String</code> using JavaScript String rules |
+ * to a <code>Writer</code>.</p> |
+ * |
+ * <p>A <code>null</code> string input has no effect.</p> |
+ * |
+ * @see #escapeJavaScript(java.lang.String) |
+ * @param out Writer to write escaped string into |
+ * @param str String to escape values in, may be null |
+ * @throws IllegalArgumentException if the Writer is <code>null</code> |
+ * @throws IOException if error occurs on underlying Writer |
+ */ |
+ public static void escapeJavaScript(Writer out, String str) throws IOException |
+ { |
+ escapeJavaStyleString(out, str, true); |
+ } |
+ |
+ /** |
+ * <p>Worker method for the {@link #escapeJavaScript(String)} method.</p> |
+ * |
+ * @param str String to escape values in, may be null |
+ * @param escapeSingleQuotes escapes single quotes if <code>true</code> |
+ * @return the escaped string |
+ */ |
+ private static String escapeJavaStyleString(String str, boolean escapeSingleQuotes) |
+ { |
+ if (str == null) |
+ { |
+ return null; |
+ } |
+ try |
+ { |
+ StringWriter writer = new StringWriter(str.length() * 2); |
+ escapeJavaStyleString(writer, str, escapeSingleQuotes); |
+ return writer.toString(); |
} |
+ catch (IOException ioe) |
+ { |
+ // this should never ever happen while writing to a StringWriter |
+ ioe.printStackTrace(); |
+ return null; |
+ } |
+ } |
- /** |
- * <p>Worker method for the {@link #escapeJavaScript(String)} method.</p> |
- * |
- * @param str String to escape values in, may be null |
- * @param escapeSingleQuotes escapes single quotes if <code>true</code> |
- * @return the escaped string |
- */ |
- private static String escapeJavaStyleString(String str, boolean escapeSingleQuotes) { |
- if (str == null) { |
- return null; |
- } |
- try { |
- StringWriter writer = new StringWriter(str.length() * 2); |
- escapeJavaStyleString(writer, str, escapeSingleQuotes); |
- return writer.toString(); |
- } catch (IOException ioe) { |
- // this should never ever happen while writing to a StringWriter |
- ioe.printStackTrace(); |
- return null; |
- } |
+ /** |
+ * <p>Worker method for the {@link #escapeJavaScript(String)} method.</p> |
+ * |
+ * @param out write to receieve the escaped string |
+ * @param str String to escape values in, may be null |
+ * @param escapeSingleQuote escapes single quotes if <code>true</code> |
+ * @throws IOException if an IOException occurs |
+ */ |
+ private static void escapeJavaStyleString(Writer out, String str, boolean escapeSingleQuote) throws IOException |
+ { |
+ if (out == null) |
+ { |
+ throw new IllegalArgumentException("The Writer must not be null"); |
+ } |
+ if (str == null) |
+ { |
+ return; |
} |
+ int sz; |
+ sz = str.length(); |
+ for (int i = 0; i < sz; i++) |
+ { |
+ char ch = str.charAt(i); |
- /** |
- * <p>Worker method for the {@link #escapeJavaScript(String)} method.</p> |
- * |
- * @param out write to receieve the escaped string |
- * @param str String to escape values in, may be null |
- * @param escapeSingleQuote escapes single quotes if <code>true</code> |
- * @throws IOException if an IOException occurs |
- */ |
- private static void escapeJavaStyleString(Writer out, String str, boolean escapeSingleQuote) throws IOException { |
- if (out == null) { |
- throw new IllegalArgumentException("The Writer must not be null"); |
- } |
- if (str == null) { |
- return; |
+ // handle unicode |
+ if (ch > 0xfff) |
+ { |
+ out.write("\\u" + hex(ch)); |
+ } else if (ch > 0xff) |
+ { |
+ out.write("\\u0" + hex(ch)); |
+ } else if (ch > 0x7f) |
+ { |
+ out.write("\\u00" + hex(ch)); |
+ } else if (ch < 32) |
+ { |
+ switch (ch) |
+ { |
+ case '\b': |
+ out.write('\\'); |
+ out.write('b'); |
+ break; |
+ case '\n': |
+ out.write('\\'); |
+ out.write('n'); |
+ break; |
+ case '\t': |
+ out.write('\\'); |
+ out.write('t'); |
+ break; |
+ case '\f': |
+ out.write('\\'); |
+ out.write('f'); |
+ break; |
+ case '\r': |
+ out.write('\\'); |
+ out.write('r'); |
+ break; |
+ default: |
+ if (ch > 0xf) |
+ { |
+ out.write("\\u00" + hex(ch)); |
+ } else |
+ { |
+ out.write("\\u000" + hex(ch)); |
+ } |
+ break; |
} |
- int sz; |
- sz = str.length(); |
- for (int i = 0; i < sz; i++) { |
- char ch = str.charAt(i); |
- |
- // handle unicode |
- if (ch > 0xfff) { |
- out.write("\\u" + hex(ch)); |
- } else if (ch > 0xff) { |
- out.write("\\u0" + hex(ch)); |
- } else if (ch > 0x7f) { |
- out.write("\\u00" + hex(ch)); |
- } else if (ch < 32) { |
- switch (ch) { |
- case '\b': |
- out.write('\\'); |
- out.write('b'); |
- break; |
- case '\n': |
- out.write('\\'); |
- out.write('n'); |
- break; |
- case '\t': |
- out.write('\\'); |
- out.write('t'); |
- break; |
- case '\f': |
- out.write('\\'); |
- out.write('f'); |
- break; |
- case '\r': |
- out.write('\\'); |
- out.write('r'); |
- break; |
- default : |
- if (ch > 0xf) { |
- out.write("\\u00" + hex(ch)); |
- } else { |
- out.write("\\u000" + hex(ch)); |
- } |
- break; |
- } |
- } else { |
- switch (ch) { |
- case '\'': |
- if (escapeSingleQuote) { |
- out.write('\\'); |
- } |
- out.write('\''); |
- break; |
- case '"': |
- out.write('\\'); |
- out.write('"'); |
- break; |
- case '\\': |
- out.write('\\'); |
- out.write('\\'); |
- break; |
- case '/': |
- out.write('\\'); |
- out.write('/'); |
- break; |
- default : |
- out.write(ch); |
- break; |
- } |
+ } else |
+ { |
+ switch (ch) |
+ { |
+ case '\'': |
+ if (escapeSingleQuote) |
+ { |
+ out.write('\\'); |
} |
+ out.write('\''); |
+ break; |
+ case '"': |
+ out.write('\\'); |
+ out.write('"'); |
+ break; |
+ case '\\': |
+ out.write('\\'); |
+ out.write('\\'); |
+ break; |
+ case '/': |
+ out.write('\\'); |
+ out.write('/'); |
+ break; |
+ default: |
+ out.write(ch); |
+ break; |
} |
+ } |
} |
+ } |
- /** |
- * <p>Returns an upper case hexadecimal <code>String</code> for the given |
- * character.</p> |
- * |
- * @param ch The character to convert. |
- * @return An upper case hexadecimal <code>String</code> |
- */ |
- private static String hex(char ch) { |
- return Integer.toHexString(ch).toUpperCase(); |
- } |
+ /** |
+ * <p>Returns an upper case hexadecimal <code>String</code> for the given |
+ * character.</p> |
+ * |
+ * @param ch The character to convert. |
+ * @return An upper case hexadecimal <code>String</code> |
+ */ |
+ private static String hex(char ch) |
+ { |
+ return Integer.toHexString(ch).toUpperCase(); |
+ } |
- /** |
- * <p>Unescapes any Java literals found in the <code>String</code>. |
- * For example, it will turn a sequence of <code>'\'</code> and |
- * <code>'n'</code> into a newline character, unless the <code>'\'</code> |
- * is preceded by another <code>'\'</code>.</p> |
- * |
- * @param str the <code>String</code> to unescape, may be null |
- * @return a new unescaped <code>String</code>, <code>null</code> if null string input |
- */ |
- public static String unescapeJava(String str) { |
- if (str == null) { |
- return null; |
- } |
- try { |
- StringWriter writer = new StringWriter(str.length()); |
- unescapeJava(writer, str); |
- return writer.toString(); |
- } catch (IOException ioe) { |
- // this should never ever happen while writing to a StringWriter |
- ioe.printStackTrace(); |
- return null; |
- } |
+ /** |
+ * <p>Unescapes any Java literals found in the <code>String</code>. |
+ * For example, it will turn a sequence of <code>'\'</code> and |
+ * <code>'n'</code> into a newline character, unless the <code>'\'</code> |
+ * is preceded by another <code>'\'</code>.</p> |
+ * |
+ * @param str the <code>String</code> to unescape, may be null |
+ * @return a new unescaped <code>String</code>, <code>null</code> if null string input |
+ */ |
+ public static String unescapeJava(String str) |
+ { |
+ if (str == null) |
+ { |
+ return null; |
} |
+ try |
+ { |
+ StringWriter writer = new StringWriter(str.length()); |
+ unescapeJava(writer, str); |
+ return writer.toString(); |
+ } catch (IOException ioe) |
+ { |
+ // this should never ever happen while writing to a StringWriter |
+ ioe.printStackTrace(); |
+ return null; |
+ } |
+ } |
- /** |
- * <p>Unescapes any Java literals found in the <code>String</code> to a |
- * <code>Writer</code>.</p> |
- * |
- * <p>For example, it will turn a sequence of <code>'\'</code> and |
- * <code>'n'</code> into a newline character, unless the <code>'\'</code> |
- * is preceded by another <code>'\'</code>.</p> |
- * |
- * <p>A <code>null</code> string input has no effect.</p> |
- * |
- * @param out the <code>Writer</code> used to output unescaped characters |
- * @param str the <code>String</code> to unescape, may be null |
- * @throws IllegalArgumentException if the Writer is <code>null</code> |
- * @throws IOException if error occurs on underlying Writer |
- */ |
- public static void unescapeJava(Writer out, String str) throws IOException { |
- if (out == null) { |
- throw new IllegalArgumentException("The Writer must not be null"); |
- } |
- if (str == null) { |
- return; |
- } |
- int sz = str.length(); |
- StringBuffer unicode = new StringBuffer(4); |
- boolean hadSlash = false; |
- boolean inUnicode = false; |
- for (int i = 0; i < sz; i++) { |
- char ch = str.charAt(i); |
- if (inUnicode) { |
- // if in unicode, then we're reading unicode |
- // values in somehow |
- unicode.append(ch); |
- if (unicode.length() == 4) { |
- // unicode now contains the four hex digits |
- // which represents our unicode character |
- try { |
- int value = Integer.parseInt(unicode.toString(), 16); |
- out.write((char) value); |
- unicode.setLength(0); |
- inUnicode = false; |
- hadSlash = false; |
- } catch (NumberFormatException nfe) { |
- throw (IOException) new IOException("Unable to parse unicode value: " + unicode).initCause(nfe); |
- } |
- } |
- continue; |
- } |
- if (hadSlash) { |
- // handle an escaped value |
- hadSlash = false; |
- switch (ch) { |
- case '\\': |
- out.write('\\'); |
- break; |
- case '\'': |
- out.write('\''); |
- break; |
- case '\"': |
- out.write('"'); |
- break; |
- case 'r': |
- out.write('\r'); |
- break; |
- case 'f': |
- out.write('\f'); |
- break; |
- case 't': |
- out.write('\t'); |
- break; |
- case 'n': |
- out.write('\n'); |
- break; |
- case 'b': |
- out.write('\b'); |
- break; |
- case 'u': |
- { |
- // uh-oh, we're in unicode country.... |
- inUnicode = true; |
- break; |
- } |
- default : |
- out.write(ch); |
- break; |
- } |
- continue; |
- } else if (ch == '\\') { |
- hadSlash = true; |
- continue; |
- } |
- out.write(ch); |
+ /** |
+ * <p>Unescapes any Java literals found in the <code>String</code> to a |
+ * <code>Writer</code>.</p> |
+ * |
+ * <p>For example, it will turn a sequence of <code>'\'</code> and |
+ * <code>'n'</code> into a newline character, unless the <code>'\'</code> |
+ * is preceded by another <code>'\'</code>.</p> |
+ * |
+ * <p>A <code>null</code> string input has no effect.</p> |
+ * |
+ * @param out the <code>Writer</code> used to output unescaped characters |
+ * @param str the <code>String</code> to unescape, may be null |
+ * @throws IllegalArgumentException if the Writer is <code>null</code> |
+ * @throws IOException if error occurs on underlying Writer |
+ */ |
+ public static void unescapeJava(Writer out, String str) throws IOException |
+ { |
+ if (out == null) |
+ { |
+ throw new IllegalArgumentException("The Writer must not be null"); |
+ } |
+ if (str == null) |
+ { |
+ return; |
+ } |
+ int sz = str.length(); |
+ StringBuffer unicode = new StringBuffer(4); |
+ boolean hadSlash = false; |
+ boolean inUnicode = false; |
+ for (int i = 0; i < sz; i++) |
+ { |
+ char ch = str.charAt(i); |
+ if (inUnicode) |
+ { |
+ // if in unicode, then we're reading unicode |
+ // values in somehow |
+ unicode.append(ch); |
+ if (unicode.length() == 4) |
+ { |
+ // unicode now contains the four hex digits |
+ // which represents our unicode character |
+ try |
+ { |
+ int value = Integer.parseInt(unicode.toString(), 16); |
+ out.write((char) value); |
+ unicode.setLength(0); |
+ inUnicode = false; |
+ hadSlash = false; |
+ } catch (NumberFormatException nfe) |
+ { |
+ throw (IOException) new IOException("Unable to parse unicode value: " + unicode).initCause(nfe); |
+ } |
} |
- if (hadSlash) { |
- // then we're in the weird case of a \ at the end of the |
- // string, let's output it anyway. |
+ continue; |
+ } |
+ if (hadSlash) |
+ { |
+ // handle an escaped value |
+ hadSlash = false; |
+ switch (ch) |
+ { |
+ case '\\': |
out.write('\\'); |
+ break; |
+ case '\'': |
+ out.write('\''); |
+ break; |
+ case '\"': |
+ out.write('"'); |
+ break; |
+ case 'r': |
+ out.write('\r'); |
+ break; |
+ case 'f': |
+ out.write('\f'); |
+ break; |
+ case 't': |
+ out.write('\t'); |
+ break; |
+ case 'n': |
+ out.write('\n'); |
+ break; |
+ case 'b': |
+ out.write('\b'); |
+ break; |
+ case 'u': |
+ { |
+ // uh-oh, we're in unicode country.... |
+ inUnicode = true; |
+ break; |
+ } |
+ default: |
+ out.write(ch); |
+ break; |
} |
+ continue; |
+ } else if (ch == '\\') |
+ { |
+ hadSlash = true; |
+ continue; |
+ } |
+ out.write(ch); |
} |
- |
- /** |
- * <p>Unescapes any JavaScript literals found in the <code>String</code>.</p> |
- * |
- * <p>For example, it will turn a sequence of <code>'\'</code> and <code>'n'</code> |
- * into a newline character, unless the <code>'\'</code> is preceded by another |
- * <code>'\'</code>.</p> |
- * |
- * @see #unescapeJava(String) |
- * @param str the <code>String</code> to unescape, may be null |
- * @return A new unescaped <code>String</code>, <code>null</code> if null string input |
- */ |
- public static String unescapeJavaScript(String str) { |
- return unescapeJava(str); |
+ if (hadSlash) |
+ { |
+ // then we're in the weird case of a \ at the end of the |
+ // string, let's output it anyway. |
+ out.write('\\'); |
} |
+ } |
- /** |
- * <p>Unescapes any JavaScript literals found in the <code>String</code> to a |
- * <code>Writer</code>.</p> |
- * |
- * <p>For example, it will turn a sequence of <code>'\'</code> and <code>'n'</code> |
- * into a newline character, unless the <code>'\'</code> is preceded by another |
- * <code>'\'</code>.</p> |
- * |
- * <p>A <code>null</code> string input has no effect.</p> |
- * |
- * @see #unescapeJava(Writer,String) |
- * @param out the <code>Writer</code> used to output unescaped characters |
- * @param str the <code>String</code> to unescape, may be null |
- * @throws IllegalArgumentException if the Writer is <code>null</code> |
- * @throws IOException if error occurs on underlying Writer |
- */ |
- public static void unescapeJavaScript(Writer out, String str) throws IOException { |
- unescapeJava(out, str); |
- } |
+ /** |
+ * <p>Unescapes any JavaScript literals found in the <code>String</code>.</p> |
+ * |
+ * <p>For example, it will turn a sequence of <code>'\'</code> and <code>'n'</code> |
+ * into a newline character, unless the <code>'\'</code> is preceded by another |
+ * <code>'\'</code>.</p> |
+ * |
+ * @see #unescapeJava(String) |
+ * @param str the <code>String</code> to unescape, may be null |
+ * @return A new unescaped <code>String</code>, <code>null</code> if null string input |
+ */ |
+ public static String unescapeJavaScript(String str) |
+ { |
+ return unescapeJava(str); |
+ } |
- //----------------------------------------------------------------------- |
- /** |
- * <p>Escapes the characters in a <code>String</code> to be suitable to pass to |
- * an SQL query.</p> |
- * |
- * <p>For example, |
- * <pre>statement.executeQuery("SELECT * FROM MOVIES WHERE TITLE='" + |
- * StringEscapeUtils.escapeSql("McHale's Navy") + |
- * "'");</pre> |
- * </p> |
- * |
- * <p>At present, this method only turns single-quotes into doubled single-quotes |
- * (<code>"McHale's Navy"</code> => <code>"McHale''s Navy"</code>). It does not |
- * handle the cases of percent (%) or underscore (_) for use in LIKE clauses.</p> |
- * |
- * see http://www.jguru.com/faq/view.jsp?EID=8881 |
- * @param str the string to escape, may be null |
- * @return a new String, escaped for SQL, <code>null</code> if null string input |
- */ |
- public static String escapeSql(String str) { |
- if (str == null) { |
- return null; |
- } |
- return StringUtils.replace(str, "'", "''"); |
- } |
+ /** |
+ * <p>Unescapes any JavaScript literals found in the <code>String</code> to a |
+ * <code>Writer</code>.</p> |
+ * |
+ * <p>For example, it will turn a sequence of <code>'\'</code> and <code>'n'</code> |
+ * into a newline character, unless the <code>'\'</code> is preceded by another |
+ * <code>'\'</code>.</p> |
+ * |
+ * <p>A <code>null</code> string input has no effect.</p> |
+ * |
+ * @see #unescapeJava(Writer, String) |
+ * @param out the <code>Writer</code> used to output unescaped characters |
+ * @param str the <code>String</code> to unescape, may be null |
+ * @throws IllegalArgumentException if the Writer is <code>null</code> |
+ * @throws IOException if error occurs on underlying Writer |
+ */ |
+ public static void unescapeJavaScript(Writer out, String str) throws IOException |
+ { |
+ unescapeJava(out, str); |
+ } |
- //----------------------------------------------------------------------- |
+ //----------------------------------------------------------------------- |
- /** |
- * <p>Returns a <code>String</code> value for a CSV column enclosed in double quotes, |
- * if required.</p> |
- * |
- * <p>If the value contains a comma, newline or double quote, then the |
- * String value is returned enclosed in double quotes.</p> |
- * </p> |
- * |
- * <p>Any double quote characters in the value are escaped with another double quote.</p> |
- * |
- * <p>If the value does not contain a comma, newline or double quote, then the |
- * String value is returned unchanged.</p> |
- * </p> |
- * |
- * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values">Wikipedia</a> and |
- * <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. |
- * |
- * @param str the input CSV column String, may be null |
- * @return the input String, enclosed in double quotes if the value contains a comma, |
- * newline or double quote, <code>null</code> if null string input |
- * @since 2.4 |
- */ |
- public static String escapeCsv(String str) { |
- if (StringUtils.containsNone(str, CSV_SEARCH_CHARS)) { |
- return str; |
- } |
- try { |
- StringWriter writer = new StringWriter(); |
- escapeCsv(writer, str); |
- return writer.toString(); |
- } catch (IOException ioe) { |
- // this should never ever happen while writing to a StringWriter |
- ioe.printStackTrace(); |
- return null; |
- } |
+ /** |
+ * <p>Escapes the characters in a <code>String</code> to be suitable to pass to |
+ * an SQL query.</p> |
+ * |
+ * <p>For example, |
+ * <pre>statement.executeQuery("SELECT * FROM MOVIES WHERE TITLE='" + |
+ * StringEscapeUtils.escapeSql("McHale's Navy") + |
+ * "'");</pre> |
+ * </p> |
+ * |
+ * <p>At present, this method only turns single-quotes into doubled single-quotes |
+ * (<code>"McHale's Navy"</code> => <code>"McHale''s Navy"</code>). It does not |
+ * handle the cases of percent (%) or underscore (_) for use in LIKE clauses.</p> |
+ * |
+ * see http://www.jguru.com/faq/view.jsp?EID=8881 |
+ * |
+ * @param str the string to escape, may be null |
+ * @return a new String, escaped for SQL, <code>null</code> if null string input |
+ */ |
+ public static String escapeSql(String str) |
+ { |
+ if (str == null) |
+ { |
+ return null; |
} |
+ return StringUtils.replace(str, "'", "''"); |
+ } |
- /** |
- * <p>Writes a <code>String</code> value for a CSV column enclosed in double quotes, |
- * if required.</p> |
- * |
- * <p>If the value contains a comma, newline or double quote, then the |
- * String value is written enclosed in double quotes.</p> |
- * </p> |
- * |
- * <p>Any double quote characters in the value are escaped with another double quote.</p> |
- * |
- * <p>If the value does not contain a comma, newline or double quote, then the |
- * String value is written unchanged (null values are ignored).</p> |
- * </p> |
- * |
- * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values">Wikipedia</a> and |
- * <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. |
- * |
- * @param str the input CSV column String, may be null |
- * @param out Writer to write input string to, enclosed in double quotes if it contains |
- * a comma, newline or double quote |
- * @throws IOException if error occurs on underlying Writer |
- * @since 2.4 |
- */ |
- public static void escapeCsv(Writer out, String str) throws IOException { |
- if (StringUtils.containsNone(str, CSV_SEARCH_CHARS)) { |
- if (str != null) { |
- out.write(str); |
- } |
- return; |
- } |
- out.write(CSV_QUOTE); |
- for (int i = 0; i < str.length(); i++) { |
- char c = str.charAt(i); |
- if (c == CSV_QUOTE) { |
- out.write(CSV_QUOTE); // escape double quote |
- } |
- out.write(c); |
- } |
- out.write(CSV_QUOTE); |
+ //----------------------------------------------------------------------- |
+ |
+ /** |
+ * <p>Returns a <code>String</code> value for a CSV column enclosed in double quotes, |
+ * if required.</p> |
+ * |
+ * <p>If the value contains a comma, newline or double quote, then the |
+ * String value is returned enclosed in double quotes.</p> |
+ * </p> |
+ * |
+ * <p>Any double quote characters in the value are escaped with another double quote.</p> |
+ * |
+ * <p>If the value does not contain a comma, newline or double quote, then the |
+ * String value is returned unchanged.</p> |
+ * </p> |
+ * |
+ * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values">Wikipedia</a> and |
+ * <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. |
+ * |
+ * @param str the input CSV column String, may be null |
+ * @return the input String, enclosed in double quotes if the value contains a comma, |
+ * newline or double quote, <code>null</code> if null string input |
+ * @since 2.4 |
+ */ |
+ public static String escapeCsv(String str) |
+ { |
+ if (StringUtils.containsNone(str, CSV_SEARCH_CHARS)) |
+ { |
+ return str; |
+ } |
+ try |
+ { |
+ StringWriter writer = new StringWriter(); |
+ escapeCsv(writer, str); |
+ return writer.toString(); |
+ } catch (IOException ioe) |
+ { |
+ // this should never ever happen while writing to a StringWriter |
+ ioe.printStackTrace(); |
+ return null; |
} |
+ } |
- /** |
- * <p>Returns a <code>String</code> value for an unescaped CSV column. </p> |
- * |
- * <p>If the value is enclosed in double quotes, and contains a comma, newline |
- * or double quote, then quotes are removed. |
- * </p> |
- * |
- * <p>Any double quote escaped characters (a pair of double quotes) are unescaped |
- * to just one double quote. </p> |
- * |
- * <p>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.</p> |
- * </p> |
- * |
- * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values">Wikipedia</a> and |
- * <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. |
- * |
- * @param str the input CSV column String, may be null |
- * @return the input String, with enclosing double quotes removed and embedded double |
- * quotes unescaped, <code>null</code> if null string input |
- * @since 2.4 |
- */ |
- public static String unescapeCsv(String str) { |
- if (str == null) { |
- return null; |
- } |
- try { |
- StringWriter writer = new StringWriter(); |
- unescapeCsv(writer, str); |
- return writer.toString(); |
- } catch (IOException ioe) { |
- // this should never ever happen while writing to a StringWriter |
- ioe.printStackTrace(); |
- return null; |
- } |
+ /** |
+ * <p>Writes a <code>String</code> value for a CSV column enclosed in double quotes, |
+ * if required.</p> |
+ * |
+ * <p>If the value contains a comma, newline or double quote, then the |
+ * String value is written enclosed in double quotes.</p> |
+ * </p> |
+ * |
+ * <p>Any double quote characters in the value are escaped with another double quote.</p> |
+ * |
+ * <p>If the value does not contain a comma, newline or double quote, then the |
+ * String value is written unchanged (null values are ignored).</p> |
+ * </p> |
+ * |
+ * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values">Wikipedia</a> and |
+ * <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. |
+ * |
+ * @param str the input CSV column String, may be null |
+ * @param out Writer to write input string to, enclosed in double quotes if it contains |
+ * a comma, newline or double quote |
+ * @throws IOException if error occurs on underlying Writer |
+ * @since 2.4 |
+ */ |
+ public static void escapeCsv(Writer out, String str) throws IOException |
+ { |
+ if (StringUtils.containsNone(str, CSV_SEARCH_CHARS)) |
+ { |
+ if (str != null) |
+ { |
+ out.write(str); |
+ } |
+ return; |
+ } |
+ out.write(CSV_QUOTE); |
+ for (int i = 0; i < str.length(); i++) |
+ { |
+ char c = str.charAt(i); |
+ if (c == CSV_QUOTE) |
+ { |
+ out.write(CSV_QUOTE); // escape double quote |
+ } |
+ out.write(c); |
} |
+ out.write(CSV_QUOTE); |
+ } |
- /** |
- * <p>Returns a <code>String</code> value for an unescaped CSV column. </p> |
- * |
- * <p>If the value is enclosed in double quotes, and contains a comma, newline |
- * or double quote, then quotes are removed. |
- * </p> |
- * |
- * <p>Any double quote escaped characters (a pair of double quotes) are unescaped |
- * to just one double quote. </p> |
- * |
- * <p>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.</p> |
- * </p> |
- * |
- * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values">Wikipedia</a> and |
- * <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. |
- * |
- * @param str the input CSV column String, may be null |
- * @param out Writer to write the input String to, with enclosing double quotes |
- * removed and embedded double quotes unescaped, <code>null</code> if null string input |
- * @throws IOException if error occurs on underlying Writer |
- * @since 2.4 |
- */ |
- public static void unescapeCsv(Writer out, String str) throws IOException { |
- if (str == null) { |
- return; |
- } |
- if (str.length() < 2) { |
- out.write(str); |
- return; |
- } |
- if ( str.charAt(0) != CSV_QUOTE || str.charAt(str.length() - 1) != CSV_QUOTE ) { |
- out.write(str); |
- return; |
- } |
+ /** |
+ * <p>Returns a <code>String</code> value for an unescaped CSV column. </p> |
+ * |
+ * <p>If the value is enclosed in double quotes, and contains a comma, newline |
+ * or double quote, then quotes are removed. |
+ * </p> |
+ * |
+ * <p>Any double quote escaped characters (a pair of double quotes) are unescaped |
+ * to just one double quote. </p> |
+ * |
+ * <p>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.</p> |
+ * </p> |
+ * |
+ * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values">Wikipedia</a> and |
+ * <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. |
+ * |
+ * @param str the input CSV column String, may be null |
+ * @return the input String, with enclosing double quotes removed and embedded double |
+ * quotes unescaped, <code>null</code> if null string input |
+ * @since 2.4 |
+ */ |
+ public static String unescapeCsv(String str) |
+ { |
+ if (str == null) |
+ { |
+ return null; |
+ } |
+ try |
+ { |
+ StringWriter writer = new StringWriter(); |
+ unescapeCsv(writer, str); |
+ return writer.toString(); |
+ } catch (IOException ioe) |
+ { |
+ // this should never ever happen while writing to a StringWriter |
+ ioe.printStackTrace(); |
+ return null; |
+ } |
+ } |
- // strip quotes |
- String quoteless = str.substring(1, str.length() - 1); |
+ /** |
+ * <p>Returns a <code>String</code> value for an unescaped CSV column. </p> |
+ * |
+ * <p>If the value is enclosed in double quotes, and contains a comma, newline |
+ * or double quote, then quotes are removed. |
+ * </p> |
+ * |
+ * <p>Any double quote escaped characters (a pair of double quotes) are unescaped |
+ * to just one double quote. </p> |
+ * |
+ * <p>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.</p> |
+ * </p> |
+ * |
+ * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values">Wikipedia</a> and |
+ * <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>. |
+ * |
+ * @param str the input CSV column String, may be null |
+ * @param out Writer to write the input String to, with enclosing double quotes |
+ * removed and embedded double quotes unescaped, <code>null</code> if null string input |
+ * @throws IOException if error occurs on underlying Writer |
+ * @since 2.4 |
+ */ |
+ public static void unescapeCsv(Writer out, String str) throws IOException |
+ { |
+ if (str == null) |
+ { |
+ return; |
+ } |
+ if (str.length() < 2) |
+ { |
+ out.write(str); |
+ return; |
+ } |
+ if (str.charAt(0) != CSV_QUOTE || str.charAt(str.length() - 1) != CSV_QUOTE) |
+ { |
+ out.write(str); |
+ return; |
+ } |
- if ( StringUtils.containsAny(quoteless, CSV_SEARCH_CHARS) ) { |
- // deal with escaped quotes; ie) "" |
- str = StringUtils.replace(quoteless, CSV_QUOTE_STR + CSV_QUOTE_STR, CSV_QUOTE_STR); |
- } |
+ // strip quotes |
+ String quoteless = str.substring(1, str.length() - 1); |
- out.write(str); |
+ if (StringUtils.containsAny(quoteless, CSV_SEARCH_CHARS)) |
+ { |
+ // deal with escaped quotes; ie) "" |
+ str = StringUtils.replace(quoteless, CSV_QUOTE_STR + CSV_QUOTE_STR, CSV_QUOTE_STR); |
} |
+ out.write(str); |
+ } |
+ |
} |