com.liferay.portal.kernel.util

Class HtmlParserUtil

java.lang.Object

com.liferay.portal.kernel.util.HtmlParserUtil

public class HtmlParserUtil
extends java.lang.Object

Provides utility methods for rendering HTML text. This class uses XSS recommendations from http://www.owasp.org/index.php/Cross_Site_Scripting#How_to_Protect_Yourself when escaping HTML text.

Author:

Brian Wing Shun Chan, Clarence Shen, Harry Mark, Samuel Kong

Constructor Summary

Constructors

Constructor and Description
HtmlParserUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	extractText(java.lang.String html) Extracts the raw text from the HTML input, compressing its whitespace and removing all attributes, scripts, and styles.
static java.lang.String	findAttributeValue(java.util.function.Predicate<java.util.function.Function<java.lang.String,java.lang.String>> findValuePredicate, java.util.function.Function<java.util.function.Function<java.lang.String,java.lang.String>,java.lang.String> returnValueFunction, java.lang.String html, java.lang.String startTagName)
static java.lang.String	render(java.lang.String html) Renders the HTML content into text.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlParserUtil

public HtmlParserUtil()

Method Detail

extractText

public static java.lang.String extractText(java.lang.String html)

Extracts the raw text from the HTML input, compressing its whitespace and removing all attributes, scripts, and styles.

For example, raw text returned by this method can be stored in a search index.

Parameters:

html - the HTML text

Returns:

the raw text from the HTML input, or null if the HTML input is null

findAttributeValue

public static java.lang.String findAttributeValue(java.util.function.Predicate<java.util.function.Function<java.lang.String,java.lang.String>> findValuePredicate,
                                                  java.util.function.Function<java.util.function.Function<java.lang.String,java.lang.String>,java.lang.String> returnValueFunction,
                                                  java.lang.String html,
                                                  java.lang.String startTagName)

render

public static java.lang.String render(java.lang.String html)

Renders the HTML content into text. This provides a human readable version of the segment content that is modeled on the way Mozilla Thunderbird® and other email clients provide an automatic conversion of HTML content to text in their alternative MIME encoding of emails.

Using the default settings, the output complies with the Text/Plain; Format=Flowed (DelSp=No) protocol described in RFC-3676.

Parameters:

html - the HTML text

Returns:

the rendered HTML text, or null if the HTML text is null