org.jdom.input
Class DOMBuilder

java.lang.Object
  |
  +--org.jdom.input.DOMBuilder

public class DOMBuilder

extends java.lang.Object

DOMBuilder builds a JDOM tree using DOM.

Version:

1.0

Author:

Brett McLaughlin, Jason Hunter, Philip Nelson, Kevin Regan, Yusuf Goolamabbas, Dan Schaffer

Constructor Summary

DOMBuilder()
This creates a DOMBuilder with the default parser and no validation.

DOMBuilder(boolean validate)
This sets validation for the Builder.

DOMBuilder(java.lang.String adapterClass)
This sets the DOM Adapter class to use, and leaves validation off.

DOMBuilder(java.lang.String adapterClass, boolean validate)
This allows the validation features to be turned on/off in the builder at creation, as well as set the DOM Adapter class to use.

Method Summary

Document	build(org.w3c.dom.Document domDocument) This will build a JDOM tree from an existing DOM tree.
Element	build(org.w3c.dom.Element domElement) This will build a JDOM Element from an existing DOM Element
Document	build(java.io.File file) 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.
Document	build(java.io.InputStream in) 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.
Document	build(java.net.URL url) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMBuilder

public DOMBuilder(java.lang.String adapterClass,
                  boolean validate)

This allows the validation features to be turned on/off in the builder at creation, as well as set the DOM Adapter class to use.

Parameters:

adapterClass - String name of class to use for DOM building.

validate - boolean indicating if validation should occur.

DOMBuilder

public DOMBuilder(java.lang.String adapterClass)

This sets the DOM Adapter class to use, and leaves validation off.

Parameters:

validate - boolean indicating if validation should occur.

DOMBuilder

public DOMBuilder(boolean validate)

This sets validation for the Builder.

Parameters:

validate - boolean indicating if validation should occur.

DOMBuilder

public DOMBuilder()

This creates a DOMBuilder with the default parser and no validation.

Method Detail

build

public Document build(java.io.InputStream in)
               throws JDOMException

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.

Throws:

JDOMException - when errors occur in parsing.

build

public Document build(java.io.File file)
               throws JDOMException

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.

Throws:

JDOMException - when errors occur in parsing.

build

public Document build(java.net.URL url)
               throws JDOMException

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.

Throws:

JDOMException - when errors occur in parsing.

build

public Document build(org.w3c.dom.Document domDocument)

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

Parameters:

domDocument - org.w3c.dom.Document object

Returns:

Document - JDOM document object.

build

public Element build(org.w3c.dom.Element domElement)

This will build a JDOM Element from an existing DOM Element

Parameters:

domElement - org.w3c.dom.Element object

Returns:

Element - JDOM Element object