org.mdiutil.lang

Class HTMLEscaper

java.lang.Object

org.mdiutil.lang.HTMLEscaper

public class HTMLEscaper
extends Object

Escape String with HTML escape sequences to be usable in XML content. Note that this class works in a multi-thread environment.

Method Summary

Modifier and Type	Method and Description
static String	escapeToHTML(String text) Convert a text by converting XML escaped characters to corresponding HTML entities.
static String	escapeToXML(String text) Convert a text with HTML entities to be usable in XML.
static String	escapeToXML(String text, boolean escapeSpecial) Convert a text with HTML entities to be usable in XML.
static String	escapeToXML(String text, boolean escapeSpecial, boolean toXMLEscape) Convert a text with HTML entities to be usable in XML.
static String	escapeXMLAttribute(String text) Escape a text to be usable in XML attributes.
static String	escapeXMLCDATA(String text) Escape a text to be usable in XML CDATA.
static String	escapeXMLToText(String text) Convert a text with XML escaped characters to non-escaped text.

Methods inherited from class java.lang.Object

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

Method Detail

escapeToXML

public static String escapeToXML(String text)

Convert a text with HTML entities to be usable in XML. HTML entities are converted to the associated XML content. The special XML characters (&, > and <) will not be escaped. For example:

• The é or è text will be converted to The é or è text

Parameters:

text - the text

Returns:

the text usable in XML

escapeToXML

public static String escapeToXML(String text,
                                 boolean escapeSpecial)

Convert a text with HTML entities to be usable in XML. HTML entities are converted to the associated XML content. For example:

• The é or è text will be converted to The é or è text

Parameters:

text - the text

escapeSpecial - true if the special XML characters (&, > and <) must be escaped

Returns:

the text usable in XML

escapeToXML

public static String escapeToXML(String text,
                                 boolean escapeSpecial,
                                 boolean toXMLEscape)

Convert a text with HTML entities to be usable in XML. HTML entities are converted to the associated XML content. For example (if toXMLEscape is true):

• The é or è text will be converted to The é or è text

Parameters:

text - the text

escapeSpecial - true if the special XML characters (&, > and <) must be escaped

toXMLEscape - true if non ASCII characters must be escaped with XML escape sequences

Returns:

the text usable in XML

escapeXMLToText

public static String escapeXMLToText(String text)

Convert a text with XML escaped characters to non-escaped text.

Parameters:

text - the text with XML escaped characters

Returns:

the unescaped text

escapeXMLCDATA

public static String escapeXMLCDATA(String text)

Escape a text to be usable in XML CDATA.

Parameters:

text - the text

Returns:

the escaped text

escapeXMLAttribute

public static String escapeXMLAttribute(String text)

Escape a text to be usable in XML attributes.

Parameters:

text - the text

Returns:

the escaped text

escapeToHTML

public static String escapeToHTML(String text)

Convert a text by converting XML escaped characters to corresponding HTML entities. For example:

• The é; or è; text will be converted to The é or è text

Parameters:

text - the text

Returns:

the text with HTML entities