Module com.aoapps.tldparser

Package com.aoapps.tldparser

Class HtmlSnippet

java.lang.Object

com.aoapps.tldparser.HtmlSnippet

public final class HtmlSnippet
extends Object

Extracts summaries from descriptions.

Method Summary

Modifier and Type	Method	Description
static String	getSummary(String summaryClass, String htmlSnippet)	Displays all elements with class="summaryClass" of the provided HTML snippet.

Methods inherited from class java.lang.Object

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

Method Details

getSummary

public static String getSummary(String summaryClass,
 String htmlSnippet)
                         throws XPathExpressionException

Displays all elements with class="summaryClass" of the provided HTML snippet. If there is no elements with this class, the entire snippet is displayed.

This parses the HTML snippet into a DOM each invocation. For higher performance, use another mechanism to compute once and use repeatedly. This is for convenience, not performance.

Parameters:

summaryClass - The CSS class that marks elements to be included in summaries

Throws:

XPathExpressionException