public abstract class

DocumentBuilderFactory

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

Class Overview

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).

Summary

Protected Constructors
DocumentBuilderFactory()
Do-nothing constructor.
Public Methods
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 neighboring 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 of the factory.
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 neighboring 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.
[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected DocumentBuilderFactory ()

Since: API Level 1

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

Public Methods

public abstract Object getAttribute (String name)

Since: API Level 1

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.

public abstract boolean getFeature (String name)

Since: API Level 1

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.

public boolean isCoalescing ()

Since: API Level 1

Queries whether the factory is configured to deliver parsers that convert CDATA nodes to text nodes and melt them with neighboring nodes. This is called "coalescing".

Returns
  • true if coalescing is desired, false otherwise.

public boolean isExpandEntityReferences ()

Since: API Level 1

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

Returns
  • true if entity expansion is desired, false otherwise.

public boolean isIgnoringComments ()

Since: API Level 1

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

Returns
  • true if comment ignorance is desired, false otherwise.

public boolean isIgnoringElementContentWhitespace ()

Since: API Level 1

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

Returns
  • true if whitespace ignorance is desired, false otherwise.

public boolean isNamespaceAware ()

Since: API Level 1

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

Returns
  • true if namespace-awareness is desired, false otherwise.

public boolean isValidating ()

Since: API Level 1

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

Returns
  • true if validating is desired, false otherwise.

public boolean isXIncludeAware ()

Since: API Level 1

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

Returns
  • true if XInclude-awareness is desired, false otherwise.

public abstract DocumentBuilder newDocumentBuilder ()

Since: API Level 1

Creates a new DocumentBuilder that matches the current configuration of the factory.

Returns
  • the DocumentBuilder.
Throws
ParserConfigurationException if no matching DocumentBuilder could be found.

public static DocumentBuilderFactory newInstance ()

Since: API Level 1

Creates a new DocumentBuilderFactory that can be configured and then be used for creating DocumentBuilder objects. The method first checks the value of the DocumentBuilderFactory property. If this is non-null, it is assumed to be the name of a class that serves as the factory. The class is instantiated, and the instance is returned. If the property value is null, the system's default factory implementation is returned.

Returns
  • the DocumentBuilderFactory.
Throws
FactoryConfigurationError if no DocumentBuilderFactory can be created.

public abstract void setAttribute (String name, Object value)

Since: API Level 1

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.

public void setCoalescing (boolean value)

Since: API Level 1

Determines whether the factory is configured to deliver parsers that convert CDATA nodes to text nodes and melt them with neighboring nodes. This is called "coalescing".

Parameters
value turns coalescing on or off.

public void setExpandEntityReferences (boolean value)

Since: API Level 1

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

Parameters
value turns entity reference expansion on or off.

public abstract void setFeature (String name, boolean value)

Since: API Level 1

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
Sets the state of namespace-awareness.
http://xml.org/sax/features/namespace-prefixes
Sets the state of namespace prefix processing
http://xml.org/sax/features/validation
Sets the state of validation.
Note that despite the ability to set 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.

public void setIgnoringComments (boolean value)

Since: API Level 1

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

Parameters
value turns comment ignorance on or off.

public void setIgnoringElementContentWhitespace (boolean value)

Since: API Level 1

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

Parameters
value turns element whitespace ignorance on or off.

public void setNamespaceAware (boolean value)

Since: API Level 1

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

Parameters
value turns namespace-awareness on or off.

public void setValidating (boolean value)

Since: API Level 1

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

Parameters
value turns validation on or off.

public void setXIncludeAware (boolean value)

Since: API Level 1

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

Parameters
value turns XInclude-awareness on or off.