org::jdom::input::DOMBuilder Class Reference

List of all members.

Public Member Functions

 DOMBuilder ()
 DOMBuilder (boolean validate)
 DOMBuilder (String adapterClass)
 DOMBuilder (String adapterClass, boolean validate)
void setFactory (JDOMFactory factory)
void setValidation (boolean validate)
Document build (InputStream in) throws JDOMException
Document build (File file) throws JDOMException
Document build (URL url) throws JDOMException
Document build (org.w3c.dom.Document domDocument)
org.jdom.Element build (org.w3c.dom.Element domElement)

Detailed Description

DOMBuilder builds a JDOM tree using DOM. Note that this class should only be used for building from a pre-existing DOM tree. The class can be used to build from files, streams, etc but other builders like SAXBuilder can perform the task faster because they don't create a DOM tree first.

Author:
Brett McLaughlin

Jason Hunter

Philip Nelson

Kevin Regan

Yusuf Goolamabbas

Dan Schaffer

Bradley S. Huffman

Version:
Revision
1.50
,
Date
2003/04/06 02:00:44


Constructor & Destructor Documentation

org::jdom::input::DOMBuilder::DOMBuilder  )  [inline]
 

This creates a new DOMBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default parsers. The underlying parser will not validate.

org::jdom::input::DOMBuilder::DOMBuilder boolean  validate  )  [inline]
 

This creates a new DOMBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default parsers. The underlying parser will validate or not according to the given parameter.

Parameters:
validate boolean indicating if validation should occur.
Deprecated:
Deprecated in Beta 9, DOMBuilder shouldn't be used for building from files and that's the only time validation matters

org::jdom::input::DOMBuilder::DOMBuilder String  adapterClass  )  [inline]
 

This creates a new DOMBuilder using the specified DOMAdapter implementation as a way to choose the underlying parser. The underlying parser will not validate.

Parameters:
adapterClass String name of class to use for DOM building.

org::jdom::input::DOMBuilder::DOMBuilder String  adapterClass,
boolean  validate
[inline]
 

This creates a new DOMBuilder using the specified DOMAdapter implementation as a way to choose the underlying parser. The underlying parser will validate or not according to the given parameter.

Parameters:
adapterClass String name of class to use for DOM building.
validate boolean indicating if validation should occur.
Deprecated:
Deprecated in Beta 9, DOMBuilder shouldn't be used for building from files and that's the only time validation matters


Member Function Documentation

org.jdom.Element org::jdom::input::DOMBuilder::build org.w3c.dom.Element  domElement  )  [inline]
 

This will build a JDOM Element from an existing DOM Element

Parameters:
domElement  org.w3c.dom.Element object
Returns:
Element - JDOM Element object

Document org::jdom::input::DOMBuilder::build org.w3c.dom.Document  domDocument  )  [inline]
 

This will build a JDOM tree from an existing DOM tree.

Parameters:
domDocument org.w3c.dom.Document object
Returns:
Document - JDOM document object.

Document org::jdom::input::DOMBuilder::build URL  url  )  throws JDOMException [inline]
 

This builds a document from the supplied URL by constructing a DOM tree and reading information from the DOM to create a JDOM document, a slower approach than SAXBuilder but useful for debugging.

Parameters:
url URL to read from.
Returns:
Document - resultant Document object.
Exceptions:
JDOMException when errors occur in parsing.
Deprecated:
Deprecated in Beta 7, SAXBuilder should be used for building from any input other than a DOM tree

Document org::jdom::input::DOMBuilder::build File  file  )  throws JDOMException [inline]
 

This builds a document from the supplied filename by constructing a DOM tree and reading information from the DOM to create a JDOM document, a slower approach than SAXBuilder but useful for debugging.

Parameters:
file File to read from.
Returns:
Document - resultant Document object.
Exceptions:
JDOMException when errors occur in parsing.
Deprecated:
Deprecated in Beta 7, SAXBuilder should be used for building from any input other than a DOM tree

Document org::jdom::input::DOMBuilder::build InputStream  in  )  throws JDOMException [inline]
 

This builds a document from the supplied input stream by constructing a DOM tree and reading information from the DOM to create a JDOM document, a slower approach than SAXBuilder but useful for debugging.

Parameters:
in InputStream to read from.
Returns:
Document - resultant Document object.
Exceptions:
JDOMException when errors occur in parsing.
Deprecated:
Deprecated in Beta 7, SAXBuilder should be used for building from any input other than a DOM tree

void org::jdom::input::DOMBuilder::setValidation boolean  validate  )  [inline]
 

This sets validation for the builder.

Parameters:
validate boolean indicating whether validation should occur.
Deprecated:
Deprecated in Beta 9, DOMBuilder shouldn't be used for building from files and that's the only time validation matters


The documentation for this class was generated from the following file:
Generated on Tue Jan 17 02:53:57 2006 for JDOM by  doxygen 1.4.6