org.jdom.input
Class DOMBuilder

public class DOMBuilder

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
Version: 1.0
Constructor Summary
DOMBuilder()
           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.
DOMBuilder(boolean validate)
           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.
DOMBuilder(String adapterClass)
           This creates a new DOMBuilder using the specified DOMAdapter implementation as a way to choose the underlying parser.
DOMBuilder(String adapterClass, boolean validate)
           This creates a new DOMBuilder using the specified DOMAdapter implementation as a way to choose the underlying parser.

Method Summary
 Documentbuild(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.
 Documentbuild(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.
 Documentbuild(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.
 Documentbuild(org.w3c.dom.Document domDocument)
           This will build a JDOM tree from an existing DOM tree.
 org.jdom.Elementbuild(org.w3c.dom.Element domElement)
           This will build a JDOM Element from an existing DOM Element
 voidsetValidation(boolean validate)
           This sets validation for the builder.

Constructor Detail

DOMBuilder

public DOMBuilder()

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.

DOMBuilder

public DOMBuilder(boolean validate)

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.

DOMBuilder

public DOMBuilder(String adapterClass)

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.

DOMBuilder

public DOMBuilder(String adapterClass, boolean validate)

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.
Method Detail

build

public Document build(InputStream in)
                throws org.jdom.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(File file)
                throws org.jdom.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(URL url)
                throws org.jdom.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 org.jdom.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

setValidation

public void setValidation(boolean validate)

This sets validation for the builder.

Parameters:
validate - boolean indicating whether validation should occur.

Association Links

to Class java.lang.String

Default adapter class to use. This is used when no other parser is given and JAXP isn't available.

to Class java.lang.String

Adapter class to use