Package org.jdesktop.dom

Class SimpleDocumentBuilder

java.lang.Object

javax.xml.parsers.DocumentBuilder

org.jdesktop.dom.SimpleDocumentBuilder

public class SimpleDocumentBuilder
extends DocumentBuilder

A DOM DocumentBuilder implementation that does not require the factory pattern for creation. Most of the time calling one of the static simpleParse methods is all that is required. Occasionally you may need to create an instance of SimpleDocumentBuilder to tweak some of the builder settings (such as setting an ErrorHandler or EntityResolver).

Constructor Summary

Constructors

Constructor	Description
SimpleDocumentBuilder()	Create a new SimpleDocumentBuilder.
SimpleDocumentBuilder(boolean namespaceAware)
SimpleDocumentBuilder(DocumentBuilderFactory factory)	Create a SimpleDocumentBuilder that will wrap builders created from the given factory.

Method Summary

Modifier and Type	Method	Description
DOMImplementation	getDOMImplementation()
Schema	getSchema()
boolean	isNamespaceAware()
boolean	isValidating()
boolean	isXIncludeAware()
SimpleDocument	newDocument()
SimpleDocument	parse(File f)
SimpleDocument	parse(InputStream is)
SimpleDocument	parse(InputStream is, String systemId)
SimpleDocument	parse(String uri)
SimpleDocument	parse(InputSource is)
SimpleDocument	parseString(String xml)	Parse the content of the given String as an XML document and return a new DOM SimpleDocument object.
void	reset()
void	setEntityResolver(EntityResolver er)
void	setErrorHandler(ErrorHandler eh)
static SimpleDocument	simpleParse(InputStream in)	Parse the content of the given InputStream as an XML document and return a new DOM SimpleDocument object.
static SimpleDocument	simpleParse(InputStream in, boolean namespaceAware)	Parse the content of the given InputStream as an XML document and return a new DOM SimpleDocument object.
static SimpleDocument	simpleParse(String xml)	Parse the content of the given String as an XML document and return a new DOM SimpleDocument object.
static SimpleDocument	simpleParse(String xml, boolean namespaceAware)	Parse the content of the given String as an XML document and return a new DOM SimpleDocument object.
static SimpleDocument	simpleParse(URL url)	Parse the content of the given URL as an XML document and return a new DOM SimpleDocument object.
static SimpleDocument	simpleParse(URL url, boolean namespaceAware)	Parse the content of the given URL as an XML document and return a new DOM SimpleDocument object.
static SimpleDocument	simpleParse(InputSource is)	Parse the content of the given input source as an XML document and return a new DOM SimpleDocument object.
static SimpleDocument	simpleParse(InputSource is, boolean namespaceAware)	Parse the content of the given input source as an XML document and return a new DOM SimpleDocument object.

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleDocumentBuilder

public SimpleDocumentBuilder()

Create a new SimpleDocumentBuilder. SimpleDocumentBuilder will delegate parsing to the default DocumentBuilder constructed via the default DocumentBuilderFactory. This builder factory will be constructed to be namespace aware by default, unlike the traditional Document builders.

SimpleDocumentBuilder

public SimpleDocumentBuilder(boolean namespaceAware)

SimpleDocumentBuilder

public SimpleDocumentBuilder(DocumentBuilderFactory factory)

Create a SimpleDocumentBuilder that will wrap builders created from the given factory. This can be used to construct non-namespace aware documents, for example.

Method Details

parseString

public SimpleDocument parseString(String xml)
                           throws SAXException,
IOException

Parse the content of the given String as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the String is null.

Parameters:

xml - String containing the content to be parsed.

Returns:

SimpleDocument result of parsing the String

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When xml is null

See Also:

DocumentHandler

parse

public SimpleDocument parse(InputSource is)
                     throws SAXException,
IOException

Specified by:

parse in class DocumentBuilder

Throws:

SAXException

IOException

parse

public SimpleDocument parse(InputStream is)
                     throws SAXException,
IOException

Overrides:

parse in class DocumentBuilder

Throws:

SAXException

IOException

parse

public SimpleDocument parse(InputStream is,
 String systemId)
                     throws SAXException,
IOException

Overrides:

parse in class DocumentBuilder

Throws:

SAXException

IOException

parse

public SimpleDocument parse(String uri)
                     throws SAXException,
IOException

Overrides:

parse in class DocumentBuilder

Throws:

SAXException

IOException

parse

public SimpleDocument parse(File f)
                     throws SAXException,
IOException

Overrides:

parse in class DocumentBuilder

Throws:

SAXException

IOException

isNamespaceAware

public boolean isNamespaceAware()

Specified by:

isNamespaceAware in class DocumentBuilder

isValidating

public boolean isValidating()

Specified by:

isValidating in class DocumentBuilder

setEntityResolver

public void setEntityResolver(EntityResolver er)

Specified by:

setEntityResolver in class DocumentBuilder

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Specified by:

setErrorHandler in class DocumentBuilder

newDocument

public SimpleDocument newDocument()

Specified by:

newDocument in class DocumentBuilder

getDOMImplementation

public DOMImplementation getDOMImplementation()

Specified by:

getDOMImplementation in class DocumentBuilder

reset

public void reset()

Overrides:

reset in class DocumentBuilder

getSchema

public Schema getSchema()

Overrides:

getSchema in class DocumentBuilder

isXIncludeAware

public boolean isXIncludeAware()

Overrides:

isXIncludeAware in class DocumentBuilder

simpleParse

public static SimpleDocument simpleParse(InputSource is)
                                  throws SAXException,
IOException

Parse the content of the given input source as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the InputSource is null null.

Parameters:

is - InputSource containing the content to be parsed.

Returns:

A new DOM SimpleDocument object.

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When is is null

See Also:

DocumentHandler

simpleParse

public static SimpleDocument simpleParse(InputStream in)
                                  throws SAXException,
IOException

Parse the content of the given InputStream as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the InputStream is null.

Parameters:

is - InputStream containing the content to be parsed.

Returns:

SimpleDocument result of parsing the InputStream

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When is is null

See Also:

DocumentHandler

simpleParse

public static SimpleDocument simpleParse(URL url)
                                  throws SAXException,
IOException

Parse the content of the given URL as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the URI is null null.

Parameters:

uri - The location of the content to be parsed.

Returns:

A new DOM SimpleDocument object.

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When url is null

See Also:

DocumentHandler

simpleParse

public static SimpleDocument simpleParse(String xml)
                                  throws SAXException,
IOException

Parse the content of the given String as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the String is null.

Parameters:

xml - String containing the content to be parsed.

Returns:

SimpleDocument result of parsing the String

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When xml is null

See Also:

DocumentHandler

simpleParse

public static SimpleDocument simpleParse(InputSource is,
 boolean namespaceAware)
                                  throws SAXException,
IOException

Parse the content of the given input source as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the InputSource is null null.

Parameters:

is - InputSource containing the content to be parsed.

namespaceAware - whether the parser should be namespace aware

Returns:

A new DOM SimpleDocument object.

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When is is null

See Also:

DocumentHandler

simpleParse

public static SimpleDocument simpleParse(InputStream in,
 boolean namespaceAware)
                                  throws SAXException,
IOException

Parse the content of the given InputStream as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the InputStream is null.

Parameters:

in - InputStream containing the content to be parsed.

namespaceAware - whether the parser should be namespace aware

Returns:

SimpleDocument result of parsing the InputStream

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When is is null

See Also:

DocumentHandler

simpleParse

public static SimpleDocument simpleParse(URL url,
 boolean namespaceAware)
                                  throws SAXException,
IOException

Parse the content of the given URL as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the URI is null null.

Parameters:

url - The location of the content to be parsed.

namespaceAware - whether the parser should be namespace aware

Returns:

A new DOM SimpleDocument object.

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When url is null

See Also:

DocumentHandler

simpleParse

public static SimpleDocument simpleParse(String xml,
 boolean namespaceAware)
                                  throws SAXException,
IOException

Parse the content of the given String as an XML document and return a new DOM SimpleDocument object. An IllegalArgumentException is thrown if the String is null.

Parameters:

xml - String containing the content to be parsed.

namespaceAware - whether the parser should be namespace aware

Returns:

SimpleDocument result of parsing the String

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When xml is null

See Also:

DocumentHandler