org.htmlcleaner

Class XWikiDOMSerializer

java.lang.Object

org.htmlcleaner.XWikiDOMSerializer

public class XWikiDOMSerializer
extends Object

Generate a W3C Document from a SF's HTML Cleaner TagNode. Some code has been copy-pasted from SF's HTML Cleaner code (which is under a BDS license, see http://htmlcleaner.sourceforge.net/license.php). Our goal is to remove this class completely if we can get SF's HTML Cleaner to support the CDATA-related use cases that force us to have this class. Remove when the following issues have been fixed:

• https://sourceforge.net/p/htmlcleaner/bugs/169/

Note: Even though in a public package this code is not meant to be a public API. We've had to put in under the org.htmlcleaner package because of https://sourceforge.net/p/htmlcleaner/bugs/167/.

Since:

1.8.2

Version:

$Id: 124eceb29fd098c392e9dcffa5c21bfef5cecb8e $

Constructor Summary

Constructors

Constructor and Description
XWikiDOMSerializer(org.htmlcleaner.CleanerProperties props, boolean escapeXml)

Method Summary

Modifier and Type	Method and Description
Document	createDOM(DocumentBuilder documentDocumentBuilder, org.htmlcleaner.TagNode rootNode)
protected boolean	isScriptOrStyle(Element element)

Methods inherited from class java.lang.Object

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

Constructor Detail

XWikiDOMSerializer

public XWikiDOMSerializer(org.htmlcleaner.CleanerProperties props,
                          boolean escapeXml)

Parameters:

props - the HTML Cleaner properties set by the user to control the HTML cleaning.

escapeXml - if true then escape XML entities

Method Detail

createDOM

public Document createDOM(DocumentBuilder documentDocumentBuilder,
                          org.htmlcleaner.TagNode rootNode)
                   throws ParserConfigurationException

Parameters:

documentDocumentBuilder - the DocumentBuilder instance to use, DocumentBuilder is not garantied to be thread safe so at most the safe instance should be used only in the same thread

rootNode - the HTML Cleaner root node to serialize

Returns:

the W3C Document object

Throws:

ParserConfigurationException - if there's an error during serialization

isScriptOrStyle

protected boolean isScriptOrStyle(Element element)

Parameters:

element - the element to check

Returns:

true if the passed element is a script or style element