org::jdom::adapters::AbstractDOMAdapter Class Reference

Inheritance diagram for org::jdom::adapters::AbstractDOMAdapter:

List of all members.

Public Member Functions
Document	getDocument (File filename, boolean validate) throws IOException, JDOMException
abstract Document	getDocument (InputStream in, boolean validate) throws IOException, JDOMException
abstract Document	createDocument () throws JDOMException
Document	createDocument (DocType doctype) throws JDOMException
Protected Member Functions
void	setInternalSubset (DocumentType dt, String s)

---

Detailed Description

AbstractDOMAdapter.

This class defines wrapper behavior for obtaining a DOM Document object from a DOM parser.

Author:

Brett McLaughlin

Jason Hunter

Version:

Revision

1.18

,

Date

2003/04/06 02:00:44

---

Member Function Documentation

Document org::jdom::adapters::AbstractDOMAdapter::getDocument	(	File	filename,
		boolean	validate
	)			throws IOException, JDOMException [inline]

This creates a new Document from an existing InputStream by letting a DOM parser handle parsing using the supplied stream.

Parameters:

	filename	file to parse.
	validate	boolean to indicate if validation should occur.

Returns:

Document - instance ready for use.

Exceptions:

	IOException	when I/O error occurs.
	JDOMException	when errors occur in parsing.

Implements org::jdom::adapters::DOMAdapter.

abstract Document org::jdom::adapters::AbstractDOMAdapter::getDocument	(	InputStream	in,
		boolean	validate
	)			throws IOException, JDOMException [pure virtual]

This creates a new Document from an existing InputStream by letting a DOM parser handle parsing using the supplied stream.

Parameters:

	in	InputStream to parse.
	validate	boolean to indicate if validation should occur.

Returns:

Document - instance ready for use.

Exceptions:

	IOException	when I/O error occurs.
	JDOMException	when errors occur in parsing.

Implements org::jdom::adapters::DOMAdapter.

Implemented in org::jdom::adapters::CrimsonDOMAdapter, org::jdom::adapters::JAXPDOMAdapter, org::jdom::adapters::OracleV1DOMAdapter, org::jdom::adapters::OracleV2DOMAdapter, org::jdom::adapters::XercesDOMAdapter, and org::jdom::adapters::XML4JDOMAdapter.

abstract Document org::jdom::adapters::AbstractDOMAdapter::createDocument

(

)

throws JDOMException [pure virtual]

This creates an empty Document object based on a specific parser implementation.

Returns:

Document - created DOM Document.

Exceptions:

JDOMException

when errors occur.

Implements org::jdom::adapters::DOMAdapter.

Implemented in org::jdom::adapters::CrimsonDOMAdapter, org::jdom::adapters::JAXPDOMAdapter, org::jdom::adapters::OracleV1DOMAdapter, org::jdom::adapters::OracleV2DOMAdapter, org::jdom::adapters::XercesDOMAdapter, and org::jdom::adapters::XML4JDOMAdapter.

Document org::jdom::adapters::AbstractDOMAdapter::createDocument

(

DocType

doctype

)

throws JDOMException [inline]

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().

Parameters:

doctype

Initial DocType of the document.

Returns:

Document - created DOM Document.

Exceptions:

JDOMException

when errors occur.

Implements org::jdom::adapters::DOMAdapter.

void org::jdom::adapters::AbstractDOMAdapter::setInternalSubset	(	DocumentType	dt,
		String	s
	)			[inline, protected]

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

---

The documentation for this class was generated from the following file:

• src/java/org/jdom/adapters/AbstractDOMAdapter.java

---