org.jdom.adapters

Class AbstractDOMAdapter

public abstract class AbstractDOMAdapter extends Object implements DOMAdapter

A DOMAdapter utility abstract base class.

Version: $Revision: 1.20 $, $Date: 2004/02/06 09:28:31 $

Author: Brett McLaughlin Jason Hunter

Method Summary
abstract DocumentcreateDocument()
This creates an empty Document object based on a specific parser implementation.
DocumentcreateDocument(DocType doctype)
This creates an empty Document object based on a specific parser implementation with the given DOCTYPE.
DocumentgetDocument(File filename, boolean validate)
This creates a new {@link Document} from an existing InputStream by letting a DOM parser handle parsing using the supplied stream.
abstract DocumentgetDocument(InputStream in, boolean validate)
This creates a new {@link Document} from an existing InputStream by letting a DOM parser handle parsing using the supplied stream.
protected voidsetInternalSubset(DocumentType dt, String s)
This attempts to change the DocumentType to have the given internal DTD subset value.

Method Detail

createDocument

public abstract Document createDocument()
This creates an empty Document object based on a specific parser implementation.

Returns: Document - created DOM Document.

Throws: JDOMException when errors occur.

createDocument

public Document createDocument(DocType doctype)
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.

Throws: JDOMException when errors occur.

getDocument

public Document getDocument(File filename, boolean validate)
This creates a new {@link 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.

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

getDocument

public abstract Document getDocument(InputStream in, boolean validate)
This creates a new {@link 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.

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

setInternalSubset

protected void setInternalSubset(DocumentType dt, 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

Copyright © 2004 Jason Hunter, Brett McLaughlin. All Rights Reserved.