javax.xml.parsers
Class DocumentBuilderFactory

java.lang.Object
  javax.xml.parsers.DocumentBuilderFactory

public abstract class DocumentBuilderFactory
extends Object

Provides a factory for DocumentBuilder instances. The class first needs to be instantiated using the newInstance() method. The instance can be configured as desired. A call to newDocumentBuilder () then provides a DocumentBuilder instance matching this configuration (if possible).

Constructor Summary

protected

DocumentBuilderFactory() Do-nothing constructor.

Method Summary

abstract Object	getAttribute(String name) Queries an attribute from the underlying implementation.
abstract boolean	getFeature(String name) Queries a feature from the underlying implementation.
boolean	isCoalescing() Queries whether the factory is configured to deliver parsers that convert CDATA nodes to text nodes and melt them with neighbouring nodes.
boolean	isExpandEntityReferences() Queries whether the factory is configured to deliver parsers that expand entity references.
boolean	isIgnoringComments() Queries whether the factory is configured to deliver parsers that ignore comments.
boolean	isIgnoringElementContentWhitespace() Queries whether the factory is configured to deliver parsers that ignore whitespace in elements.
boolean	isNamespaceAware() Queries whether the factory is configured to deliver parsers that are namespace-aware.
boolean	isValidating() Queries whether the factory is configured to deliver parsers that are validating.
boolean	isXIncludeAware() Queries whether the factory is configured to deliver parsers that are XInclude-aware.
abstract DocumentBuilder	newDocumentBuilder() Creates a new DocumentBuilder that matches the current configuration.
static DocumentBuilderFactory	newInstance() Creates a new DocumentBuilderFactory that can be configured and then be used for creating DocumentBuilder objects.
abstract void	setAttribute(String name, Object value) Sets an attribute in the underlying implementation.
void	setCoalescing(boolean value) Determines whether the factory is configured to deliver parsers that convert CDATA nodes to text nodes and melt them with neighbouring nodes.
void	setExpandEntityReferences(boolean value) Determines whether the factory is configured to deliver parsers that expands entity references.
abstract void	setFeature(String name, boolean value) Sets a feature in the underlying implementation.
void	setIgnoringComments(boolean value) Determines whether the factory is configured to deliver parsers that ignore comments.
void	setIgnoringElementContentWhitespace(boolean value) Determines whether the factory is configured to deliver parsers that ignores element whitespace.
void	setNamespaceAware(boolean value) Determines whether the factory is configured to deliver parsers that are namespace-aware.
void	setValidating(boolean value) Determines whether the factory is configured to deliver parsers that are validating.
void	setXIncludeAware(boolean value) Determines whether the factory is configured to deliver parsers that are XInclude-aware.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentBuilderFactory

protected DocumentBuilderFactory()

Do-nothing constructor. To be overridden by concrete document builders.

Method Detail

getAttribute

public abstract Object getAttribute(String name)
                             throws IllegalArgumentException

Queries an attribute from the underlying implementation.

Parameters:

name - The name of the attribute.

Returns:

The value of the attribute.

Throws:

IllegalArgumentException - if the argument is unknown to the underlying implementation.

getFeature

public abstract boolean getFeature(String name)
                            throws ParserConfigurationException

Queries a feature from the underlying implementation.

Parameters:

name - The name of the feature. The default Android implementation of DocumentBuilder supports only the following three features:

http://xml.org/sax/features/namespaces

Queries the state of namespace-awareness.

http://xml.org/sax/features/namespace-prefixes

Queries the state of namespace prefix processing

http://xml.org/sax/features/validation

Queries the state of validation.

Note that despite the ability to query the validation feature, there is currently no validating parser available. Also note that currently either namespaces or namespace prefixes can be enabled, but not both at the same time.

Returns:

The status of the feature.

Throws:

IllegalArgumentException - if the feature is unknown to the underlying implementation.

ParserConfigurationException - if the feature is known, but not supported.

isCoalescing

public boolean isCoalescing()

Queries whether the factory is configured to deliver parsers that convert CDATA nodes to text nodes and melt them with neighbouring nodes.

Returns:

true if coalescing is desired, false otherwise.

isExpandEntityReferences

public boolean isExpandEntityReferences()

Queries whether the factory is configured to deliver parsers that expand entity references.

Returns:

true if entity expansion is desired, false otherwise.

isIgnoringComments

public boolean isIgnoringComments()

Queries whether the factory is configured to deliver parsers that ignore comments.

Returns:

true if comment ignorance is desired, false otherwise.

isIgnoringElementContentWhitespace

public boolean isIgnoringElementContentWhitespace()

Queries whether the factory is configured to deliver parsers that ignore whitespace in elements.

Returns:

true if whitespace ignorance is desired, false otherwise.

isNamespaceAware

public boolean isNamespaceAware()

Queries whether the factory is configured to deliver parsers that are namespace-aware.

Returns:

true if namespace-awareness is desired, false otherwise.

isValidating

public boolean isValidating()

Queries whether the factory is configured to deliver parsers that are validating.

Returns:

true if validating is desired, false otherwise.

isXIncludeAware

public boolean isXIncludeAware()

Queries whether the factory is configured to deliver parsers that are XInclude-aware.

Returns:

true if XInclude-awareness is desired, false otherwise.

newDocumentBuilder

public abstract DocumentBuilder newDocumentBuilder()
                                            throws ParserConfigurationException

Creates a new DocumentBuilder that matches the current configuration.

Returns:

The DocumentBuilder.

Throws:

ParserConfigurationException - if no matching DocumentBuilder could be found.

newInstance

public static DocumentBuilderFactory newInstance()
                                          throws FactoryConfigurationError

Creates a new DocumentBuilderFactory that can be configured and then be used for creating DocumentBuilder objects.

Returns:

The DocumentBuilderFactory.

Throws:

FactoryConfigurationError - If no DocumentBuilderFactory can be created.

setAttribute

public abstract void setAttribute(String name,
                                  Object value)
                           throws IllegalArgumentException

Sets an attribute in the underlying implementation.

Parameters:

name - The name of the attribute.

value - The value of the attribute.

Throws:

IllegalArgumentException - if the argument is unknown to the underlying implementation.

setCoalescing

public void setCoalescing(boolean value)

Determines whether the factory is configured to deliver parsers that convert CDATA nodes to text nodes and melt them with neighbouring nodes.

Parameters:

value - Turns coalescing on or off.

setExpandEntityReferences

public void setExpandEntityReferences(boolean value)

Determines whether the factory is configured to deliver parsers that expands entity references.

Parameters:

value - Turns entity reference expansion on or off.

setFeature

public abstract void setFeature(String name,
                                boolean value)
                         throws ParserConfigurationException

Sets a feature in the underlying implementation.

Parameters:

name - The name of the feature. The default Android implementation of DocumentBuilder supports only the following three features:

http://xml.org/sax/features/namespaces

Queries the state of namespace-awareness.

http://xml.org/sax/features/namespace-prefixes

Queries the state of namespace prefix processing

http://xml.org/sax/features/validation

Queries the state of validation.

Note that despite the ability to query the validation feature, there is currently no validating parser available. Also note that currently either namespaces or namespace prefixes can be enabled, but not both at the same time.

value - The value of the feature.

Throws:

ParserConfigurationException - if the feature is unknown to the underlying implementation.

setIgnoringComments

public void setIgnoringComments(boolean value)

Determines whether the factory is configured to deliver parsers that ignore comments.

Parameters:

value - Turns comment ignorance on or off.

setIgnoringElementContentWhitespace

public void setIgnoringElementContentWhitespace(boolean value)

Determines whether the factory is configured to deliver parsers that ignores element whitespace.

Parameters:

value - Turns element whitespace ignorance on or off.

setNamespaceAware

public void setNamespaceAware(boolean value)

Determines whether the factory is configured to deliver parsers that are namespace-aware.

Parameters:

value - Turns namespace-awareness on or off.

setValidating

public void setValidating(boolean value)

Determines whether the factory is configured to deliver parsers that are validating.

Parameters:

value - Turns validation on or off.

setXIncludeAware

public void setXIncludeAware(boolean value)

Determines whether the factory is configured to deliver parsers that are XInclude-aware.

Parameters:

value - Turns XInclude-awareness on or off.