com.communote.common.string

Class StringEscapeHelper

java.lang.Object

com.communote.common.string.StringEscapeHelper

public final class StringEscapeHelper
extends Object

Helper class for escaping/unescaping strings

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static String	escapeJavaScript(String str) Escapes backslash, single and double quotes with a backslash.
static String	escapeJavaScriptInlineHtml(String str) Escapes strings which should be used as string literals in JavaScript code that is rendered in HTML inline event handler attributes like onclick or inside a script tag.
static String	escapeJsonInlineHtml(String str) Escapes serialized JSON which should be used in JavaScript code that is rendered inside a script tag.
static String	escapeNonWordCharacters(String str) Escape characters that are not in the slightly extended word regex character class with an underscore.
static String	escapeXml(String buffer) Performs the following substring replacements (to facilitate output to XML/HTML pages): & with &amp; < with &lt; > with &gt; " with &#034; ' with &#039;
static String	getSingleLineTextFromXML(String html) get the text of the xml content and replace linebreaks with a whitespace
static String	removeHtmlMarkup(String str) Removes all tags from a string and replaces HTML 4.0 entities with the corresponding Unicode character.
static String	removeXmlMarkup(String str) Removes XML markup from a string and unescapes XML entities (only gt, lt, quot, amp, apos).

Methods inherited from class java.lang.Object

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

Method Detail

escapeJavaScript

public static String escapeJavaScript(String str)

Escapes backslash, single and double quotes with a backslash.

Parameters:

str - the string to escape

Returns:

the escaped string

escapeJavaScriptInlineHtml

public static String escapeJavaScriptInlineHtml(String str)

Escapes strings which should be used as string literals in JavaScript code that is rendered in HTML inline event handler attributes like onclick or inside a script tag. The characters '<\">& are escaped with hex notation. This method should only be used in pages that are UTF-8 encoded.

Parameters:

str - the string to escape

Returns:

the escaped string

escapeJsonInlineHtml

public static String escapeJsonInlineHtml(String str)

Escapes serialized JSON which should be used in JavaScript code that is rendered inside a script tag. The characters <>& are escaped with hex notation. Other characters are not modified and it is assumed that they were already escaped correctly by the JSON serializer. This method should only be used in pages that are UTF-8 encoded and have an HTML DOCTYPE.

Parameters:

str - the serialized JSON to escape

Returns:

the escaped string

escapeNonWordCharacters

public static String escapeNonWordCharacters(String str)

Escape characters that are not in the slightly extended word regex character class with an underscore. That is all characters that are not in [A-Za-z0-9_.-] will be replaced with an underscore.

Parameters:

str - the string to escape

Returns:

the escaped string

escapeXml

public static String escapeXml(String buffer)

Performs the following substring replacements (to facilitate output to XML/HTML pages):
& with &amp;
< with &lt;
> with &gt;
" with &#034;
' with &#039;

Parameters:

buffer - the string to escape XML entities

Returns:

the escaped string

getSingleLineTextFromXML

public static String getSingleLineTextFromXML(String html)

get the text of the xml content and replace linebreaks with a whitespace

Parameters:

html - the html text to anal

Returns:

the text of the html

removeHtmlMarkup

public static String removeHtmlMarkup(String str)

Removes all tags from a string and replaces HTML 4.0 entities with the corresponding Unicode character.

Parameters:

str - the string to modify

Returns:

the input string with all markup (tags) removed and HTML 4.0 entities unescaped

removeXmlMarkup

public static String removeXmlMarkup(String str)

Removes XML markup from a string and unescapes XML entities (only gt, lt, quot, amp, apos).

Parameters:

str - the string to modify

Returns:

the input string with all markup (tags) removed and XML entities unescaped