io.vertx.core.impl

Class StringEscapeUtils

java.lang.Object

io.vertx.core.impl.StringEscapeUtils

public class StringEscapeUtils
extends Object

Adapted from Apache Commons code

<p>Escapes and unescapes <code>String</code>s for Java, Java Script, HTML, XML, and SQL.</p> <p></p> <p>#ThreadSafe#</p>

Since:

2.0

Version:

$Id: StringEscapeUtils.java 1057072 2011-01-10 01:55:57Z niallp $

Author:

Apache Software Foundation, Apache Jakarta Turbine, Purple Technology, <a href="mailto:[email protected]">Alexander Day Chaffee</a>, Antony Riley, Helge Tesgaard, <a href="[email protected]">Sean Brown</a>, <a href="mailto:[email protected]">Gary Gregory</a>, Phil Steitz, Pete Gieser

Constructor Summary

Constructors

Constructor and Description
StringEscapeUtils() <p><code>StringEscapeUtils</code> instances should NOT be constructed in standard programming.</p> <p></p> <p>Instead, the class should be used as:</p> <pre>StringEscapeUtils.escapeJava("foo");</pre> <p></p> <p>This constructor is public to permit tools that require a JavaBean instance to operate.</p>

Method Summary

Modifier and Type	Method and Description
static String	escapeJava(String str) <p>Escapes the characters in a <code>String</code> using Java String rules.</p> <p></p> <p>Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) </p> <p></p> <p>So a tab becomes the characters <code>'\\'</code> and <code>'t'</code>.</p> <p></p> <p>The only difference between Java strings and JavaScript strings is that in JavaScript, a single quote must be escaped.</p> <p></p> <p>Example:</p> <pre> input string: He didn’t say, "Stop!" output string: He didn’t say, \"Stop!\" </pre>
static void	escapeJava(Writer out, String str) <p>Escapes the characters in a <code>String</code> using Java String rules to a <code>Writer</code>.</p> <p></p> <p>A <code>null</code> string input has no effect.</p>
static String	escapeJavaScript(String str) <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.
static void	escapeJavaScript(Writer out, String str) <p>Escapes the characters in a <code>String</code> using JavaScript String rules to a <code>Writer</code>.</p> <p></p> <p>A <code>null</code> string input has no effect.</p>
static String	unescapeJava(String str) <p>Unescapes any Java literals found in the <code>String</code>.
static void	unescapeJava(Writer out, String str) <p>Unescapes any Java literals found in the <code>String</code> to a <code>Writer</code>.</p> <p></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></p> <p>A <code>null</code> string input has no effect.</p>
static String	unescapeJavaScript(String str) <p>Unescapes any JavaScript literals found in the <code>String</code>.</p> <p></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>
static void	unescapeJavaScript(Writer out, String str) <p>Unescapes any JavaScript literals found in the <code>String</code> to a <code>Writer</code>.</p> <p></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></p> <p>A <code>null</code> string input has no effect.</p>

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringEscapeUtils

public StringEscapeUtils()

<p><code>StringEscapeUtils</code> instances should NOT be constructed in standard programming.</p> <p></p> <p>Instead, the class should be used as:</p> <pre>StringEscapeUtils.escapeJava("foo");</pre> <p></p> <p>This constructor is public to permit tools that require a JavaBean instance to operate.</p>

Method Detail

escapeJava

public static String escapeJava(String str)
                         throws Exception

<p>Escapes the characters in a <code>String</code> using Java String rules.</p> <p></p> <p>Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) </p> <p></p> <p>So a tab becomes the characters <code>'\\'</code> and <code>'t'</code>.</p> <p></p> <p>The only difference between Java strings and JavaScript strings is that in JavaScript, a single quote must be escaped.</p> <p></p> <p>Example:</p> <pre> input string: He didn’t say, "Stop!" output string: He didn’t say, \"Stop!\" </pre>

Parameters:

str - String to escape values in, may be null

Returns:

String with escaped values, <code>null</code> if null string input

Throws:

Exception

escapeJava

public static void escapeJava(Writer out,
                              String str)
                       throws IOException

<p>Escapes the characters in a <code>String</code> using Java String rules to a <code>Writer</code>.</p> <p></p> <p>A <code>null</code> string input has no effect.</p>

Parameters:

out - Writer to write escaped string into

str - String to escape values in, may be null

Throws:

IllegalArgumentException - if the Writer is <code>null</code>

IOException - if error occurs on underlying Writer

See Also:

escapeJava(String)

escapeJavaScript

public static String escapeJavaScript(String str)
                               throws Exception

<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></p> <p>So a tab becomes the characters <code>'\\'</code> and <code>'t'</code>.</p> <p></p> <p>The only difference between Java strings and JavaScript strings is that in JavaScript, a single quote must be escaped.</p> <p></p> <p>Example:</p> <pre> input string: He didn’t say, "Stop!" output string: He didn't say, \"Stop!\" </pre>

Parameters:

str - String to escape values in, may be null

Returns:

String with escaped values, <code>null</code> if null string input

Throws:

Exception

escapeJavaScript

public static void escapeJavaScript(Writer out,
                                    String str)
                             throws Exception

<p>Escapes the characters in a <code>String</code> using JavaScript String rules to a <code>Writer</code>.</p> <p></p> <p>A <code>null</code> string input has no effect.</p>

Parameters:

out - Writer to write escaped string into

str - String to escape values in, may be null

Throws:

IllegalArgumentException - if the Writer is <code>null</code>

IOException - if error occurs on underlying Writer

Exception

See Also:

escapeJavaScript(String)

unescapeJava

public static String unescapeJava(String str)
                           throws Exception

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

Parameters:

str - the <code>String</code> to unescape, may be null

Returns:

a new unescaped <code>String</code>, <code>null</code> if null string input

Throws:

Exception

unescapeJava

public static void unescapeJava(Writer out,
                                String str)
                         throws Exception

<p>Unescapes any Java literals found in the <code>String</code> to a <code>Writer</code>.</p> <p></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></p> <p>A <code>null</code> string input has no effect.</p>

Parameters:

out - the <code>Writer</code> used to output unescaped characters

str - the <code>String</code> to unescape, may be null

Throws:

IllegalArgumentException - if the Writer is <code>null</code>

IOException - if error occurs on underlying Writer

Exception

unescapeJavaScript

public static String unescapeJavaScript(String str)
                                 throws Exception

<p>Unescapes any JavaScript literals found in the <code>String</code>.</p> <p></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>

Parameters:

str - the <code>String</code> to unescape, may be null

Returns:

A new unescaped <code>String</code>, <code>null</code> if null string input

Throws:

Exception

See Also:

unescapeJava(String)

unescapeJavaScript

public static void unescapeJavaScript(Writer out,
                                      String str)
                               throws Exception

<p>Unescapes any JavaScript literals found in the <code>String</code> to a <code>Writer</code>.</p> <p></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></p> <p>A <code>null</code> string input has no effect.</p>

Parameters:

out - the <code>Writer</code> used to output unescaped characters

str - the <code>String</code> to unescape, may be null

Throws:

IllegalArgumentException - if the Writer is <code>null</code>

IOException - if error occurs on underlying Writer

Exception

See Also:

unescapeJava(java.io.Writer, String)