org.jdom2.adapters

Class AbstractDOMAdapter

java.lang.Object

org.jdom2.adapters.AbstractDOMAdapter

All Implemented Interfaces:

DOMAdapter

Direct Known Subclasses:

JAXPDOMAdapter

public abstract class AbstractDOMAdapter
extends java.lang.Object
implements DOMAdapter

A DOMAdapter utility abstract base class. Uses the concrete implementation to build a org.w3c.dom.Document instance, which in turn is used to apply the DocType.

Special attention should be paid to the setInternalSubset protected method, which may, or may not be supported by your actual DOM implementation.

Author:

Brett McLaughlin, Jason Hunter

Constructor Summary

Constructors

Constructor and Description
AbstractDOMAdapter()

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document	createDocument(DocType doctype) This creates an empty Document object based on a specific parser implementation with the given DOCTYPE.
protected void	setInternalSubset(org.w3c.dom.DocumentType dt, java.lang.String s) This attempts to change the DocumentType to have the given internal DTD subset value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jdom2.adapters.DOMAdapter

createDocument

Constructor Detail

AbstractDOMAdapter

public AbstractDOMAdapter()

Method Detail

createDocument

public org.w3c.dom.Document createDocument(DocType doctype)
                                    throws JDOMException

This creates an empty Document object based on a specific parser implementation with the given DOCTYPE. If the doctype parameter is null, the behavior is the same as calling createDocument().

Specified by:

createDocument in interface DOMAdapter

Parameters:

doctype - Initial DocType of the document.

Returns:

Document - created DOM Document.

Throws:

JDOMException - when errors occur.

setInternalSubset

protected void setInternalSubset(org.w3c.dom.DocumentType dt,
                                 java.lang.String s)

This attempts to change the DocumentType to have the given internal DTD subset value. This is not a standard ability in DOM, so it's only available with some parsers. Subclasses can alter the mechanism by which the attempt is made to set the value.

Parameters:

dt - DocumentType to be altered

s - String to use as the internal DTD subset