com.atlassian.renderer.v2.components

Class HtmlEscaper

java.lang.Object

com.atlassian.renderer.v2.components.HtmlEscaper

public final class HtmlEscaper
extends Object

Method Summary

Modifier and Type	Method and Description
static String	escapeAll(String s, boolean preserveExistingEntities) Replaces the HTML special characters less-than (<), greater-than (>), double-quote ("), single-quote/apostrophe ('), and ampersand (&) with their equivalent entities in HTML 4 and returns the result.
static String	escapeAllExceptQuotes(String s, boolean preserveExistingEntities) Does the same as escapeAll(String, boolean), except doesn't replace the ASCII quotation mark characters double-quote (") and single-quote/apostrophe (').
static String	escapeAmpersands(String s, boolean preserveExistingEntities) Replaces ampersand (&) characters with the equivalent HTML entity (&amp;) and returns the result.

Methods inherited from class java.lang.Object

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

Method Detail

escapeAll

public static String escapeAll(String s,
                               boolean preserveExistingEntities)

Replaces the HTML special characters less-than (<), greater-than (>), double-quote ("), single-quote/apostrophe ('), and ampersand (&) with their equivalent entities in HTML 4 and returns the result. Also maps the Microsoft Windows-1252 "smart quotes" characters (145-148) with their equivalent HTML entities.

Parameters:

s - the String to escape

preserveExistingEntities - if true, will avoid escaping the ampersand in an existing entity like <. If false, the method will do a normal escaping by replace all matched characters.

Returns:

the string with special characters replaced by entities.

escapeAllExceptQuotes

public static String escapeAllExceptQuotes(String s,
                                           boolean preserveExistingEntities)

Does the same as escapeAll(String, boolean), except doesn't replace the ASCII quotation mark characters double-quote (") and single-quote/apostrophe (').

Parameters:

s - the String to escape

preserveExistingEntities - if true, will avoid escaping the ampersand in an existing entity like <. If false, the method will do a normal escaping by replace all matched characters.

Returns:

the string with special characters replaced by entities.

escapeAmpersands

public static String escapeAmpersands(String s,
                                      boolean preserveExistingEntities)

Replaces ampersand (&) characters with the equivalent HTML entity (&) and returns the result.

Parameters:

s - the String to escape

preserveExistingEntities - if true, will avoid escaping the ampersand in an existing entity like <. If false, the method will do a normal escaping by replace all matched characters.

Returns:

the string with special characters replaced by entities.