Package org.jsoup.helper

Class W3CDom

java.lang.Object

org.jsoup.helper.W3CDom

public class W3CDom
extends Object

Helper class to transform a Document to a org.w3c.dom.Document, for integration with toolsets that use the W3C DOM.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	W3CDom.W3CBuilder	Implements the conversion by walking the input.

Field Summary

Fields

Modifier and Type	Field	Description
protected DocumentBuilderFactory	factory
static String	SourceProperty	For W3C Documents created by this class, this property is set on each node to link back to the original jsoup node.
static String	XPathFactoryProperty	To get support for XPath versions > 1, set this property to the classname of an alternate XPathFactory implementation (e.g.

Constructor Summary

Constructors

Constructor	Description
W3CDom()

Method Summary

Modifier and Type	Method	Description
String	asString(Document doc)	Serialize a W3C document to a String.
static String	asString(Document doc, Map<String,String> properties)	Serialize a W3C document to a String.
static Document	convert(Document in)	Converts a jsoup DOM to a W3C DOM.
void	convert(Document in, Document out)	Converts a jsoup document into the provided W3C Document.
void	convert(Element in, Document out)	Converts a jsoup element into the provided W3C Document.
Document	fromJsoup(Document in)	Convert a jsoup Document to a W3C Document.
Document	fromJsoup(Element in)	Convert a jsoup Element to a W3C Document.
static HashMap<String,String>	OutputHtml()	Canned default for HTML output.
static HashMap<String,String>	OutputXml()	Canned default for XML output.
NodeList	selectXpath(String xpath, Document doc)
<T extends Node> List<T>	sourceNodes(NodeList nodeList, Class<T> nodeType)

Methods inherited from class java.lang.Object

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

Field Details

SourceProperty

public static final String SourceProperty

For W3C Documents created by this class, this property is set on each node to link back to the original jsoup node.

See Also:

Constant Field Values

XPathFactoryProperty

public static final String XPathFactoryProperty

To get support for XPath versions > 1, set this property to the classname of an alternate XPathFactory implementation (e.g. net.sf.saxon.xpath.XPathFactoryImpl).

See Also:

Constant Field Values

factory

protected DocumentBuilderFactory factory

Constructor Details

W3CDom

public W3CDom()

Method Details

convert

public static Document convert(Document in)

Converts a jsoup DOM to a W3C DOM.

Parameters:

in - jsoup Document

Returns:

W3C Document

asString

public static String asString(Document doc,
@Nullable
Map<String,String> properties)

Serialize a W3C document to a String. Provide Properties to define output settings including if HTML or XML. If you don't provide the properties (null), the output will be auto-detected based on the content of the document.

Parameters:

doc - Document

properties - (optional/nullable) the output properties to use. See Transformer.setOutputProperties(Properties) and OutputKeys

Returns:

Document as string

See Also:

OutputHtml(), OutputXml(), OutputKeys.ENCODING, OutputKeys.OMIT_XML_DECLARATION, OutputKeys.STANDALONE, OutputKeys.STANDALONE, OutputKeys.DOCTYPE_PUBLIC, OutputKeys.DOCTYPE_PUBLIC, OutputKeys.CDATA_SECTION_ELEMENTS, OutputKeys.INDENT, OutputKeys.MEDIA_TYPE

OutputHtml

public static HashMap<String,String> OutputHtml()

Canned default for HTML output.

OutputXml

public static HashMap<String,String> OutputXml()

Canned default for XML output.

fromJsoup

public Document fromJsoup(Document in)

Convert a jsoup Document to a W3C Document. The created nodes will link back to the original jsoup nodes in the user property SourceProperty (but after conversion, changes on one side will not flow to the other).

Parameters:

in - jsoup doc

Returns:

a W3C DOM Document representing the jsoup Document or Element contents.

fromJsoup

public Document fromJsoup(Element in)

Convert a jsoup Element to a W3C Document. The created nodes will link back to the original jsoup nodes in the user property SourceProperty (but after conversion, changes on one side will not flow to the other).

Parameters:

in - jsoup element or doc

Returns:

a W3C DOM Document representing the jsoup Document or Element contents.

convert

public void convert(Document in,
Document out)

Converts a jsoup document into the provided W3C Document. If required, you can set options on the output document before converting.

Parameters:

in - jsoup doc

out - w3c doc

See Also:

fromJsoup(org.jsoup.nodes.Element)

convert

public void convert(Element in,
Document out)

Converts a jsoup element into the provided W3C Document. If required, you can set options on the output document before converting.

Parameters:

in - jsoup element

out - w3c doc

See Also:

fromJsoup(org.jsoup.nodes.Element)

selectXpath

public NodeList selectXpath(String xpath,
Document doc)

sourceNodes

public <T extends Node> List<T> sourceNodes(NodeList nodeList,
Class<T> nodeType)

asString

public String asString(Document doc)

Serialize a W3C document to a String. The output format will be XML or HTML depending on the content of the doc.

Parameters:

doc - Document

Returns:

Document as string

See Also:

asString(Document, Map)