javax.xml.parsers

Class DocumentBuilderFactory

public abstract class DocumentBuilderFactory extends Object

Factory for obtaining document builders. Instances of this class are not guaranteed to be thread safe.

Constructor Summary
protected	DocumentBuilderFactory()

Method Summary
abstract Object	getAttribute(String name) Retrieves the named attribute value from the underlying implementation.
abstract boolean	getFeature(String name) Returns the value of the specified feature.
Schema	getSchema() Returns the schema.
boolean	isCoalescing() Indicates whether document builders obtained from this factory will convert CDATA sections to text nodes and normalize adjacent text nodes into a single text node.
boolean	isExpandEntityReferences() Indicates whether document builders obtained from this factory will expand entity reference nodes.
boolean	isIgnoringComments() Indicates whether document builders obtained from this factory will discard comment nodes.
boolean	isIgnoringElementContentWhitespace() Indicates whether document builders obtained from this factory will eliminate whitespace within elements that have an element-only content model.
boolean	isNamespaceAware() Indicates whether document builders obtained from this factory will be XML Namespace aware.
boolean	isValidating() Indicates whether document builders obtained from this factory will validate their input.
boolean	isXIncludeAware() Indicates whether parsers obtained from this factory will be XInclude aware.
abstract DocumentBuilder	newDocumentBuilder() Creates a new document builder instance using the currently specified factory configuration.
static DocumentBuilderFactory	newInstance() Creates a new factory instance.
abstract void	setAttribute(String name, Object value) Set the named attribute on the underlying implementation.
void	setCoalescing(boolean coalescing) Sets whether document builders obtained from this factory will convert CDATA sections to text nodes and normalize adjacent text nodes into a single text node.
void	setExpandEntityReferences(boolean expandEntityRef) Sets whether document builders obtained from this factory will expand entity reference nodes.
abstract void	setFeature(String name, boolean value) Sets the value of the specified feature.
void	setIgnoringComments(boolean ignoreComments) Sets whether document builders obtained from this factory will discard comment nodes.
void	setIgnoringElementContentWhitespace(boolean whitespace) Sets whether document builders obtained from this factory will eliminate whitespace within elements that have an element-only content model.
void	setNamespaceAware(boolean awareness) Sets whether document builders obtained from this factory will be XML Namespace aware.
void	setSchema(Schema schema) Sets the schema.
void	setValidating(boolean validating) Sets whether document builders obtained from this factory will validate their input.
void	setXIncludeAware(boolean state) Sets whether parsers obtained from this factory will be XInclude aware.

Constructor Detail

DocumentBuilderFactory

protected DocumentBuilderFactory()

Method Detail

getAttribute

public abstract Object getAttribute(String name)

Retrieves the named attribute value from the underlying implementation.

Parameters: name the name of the attribute

Throws: IllegalArgumentException if the attribute is not recognized

getFeature

public abstract boolean getFeature(String name)

Returns the value of the specified feature.

Parameters: name the feature name (URI)

Throws: ParserConfigurationException if the feature is not supported.

Since: 1.5

getSchema

public Schema getSchema()

Returns the schema.

Since: 1.5

isCoalescing

public boolean isCoalescing()

Indicates whether document builders obtained from this factory will convert CDATA sections to text nodes and normalize adjacent text nodes into a single text node.

isExpandEntityReferences

public boolean isExpandEntityReferences()

Indicates whether document builders obtained from this factory will expand entity reference nodes.

isIgnoringComments

public boolean isIgnoringComments()

Indicates whether document builders obtained from this factory will discard comment nodes.

isIgnoringElementContentWhitespace

public boolean isIgnoringElementContentWhitespace()

Indicates whether document builders obtained from this factory will eliminate whitespace within elements that have an element-only content model.

isNamespaceAware

public boolean isNamespaceAware()

Indicates whether document builders obtained from this factory will be XML Namespace aware.

isValidating

public boolean isValidating()

Indicates whether document builders obtained from this factory will validate their input.

isXIncludeAware

public boolean isXIncludeAware()

Indicates whether parsers obtained from this factory will be XInclude aware.

Since: 1.5

newDocumentBuilder

public abstract DocumentBuilder newDocumentBuilder()

Creates a new document builder instance using the currently specified factory configuration.

Throws: ParserConfigurationException if the specified configuration is not supported

newInstance

public static DocumentBuilderFactory newInstance()

Creates a new factory instance. The implementation class to load is the first found in the following locations:

the javax.xml.parsers.DocumentBuilderFactory system property
the above named property value in the $JAVA_HOME/lib/jaxp.properties file
the class name specified in the META-INF/services/javax.xml.parsers.DocumentBuilderFactory system resource
the default factory class

setAttribute

public abstract void setAttribute(String name, Object value)

Set the named attribute on the underlying implementation.

Parameters: name the name of the attribute value the new value

Throws: IllegalArgumentException if the attribute is not recognized

Parameters: name the feature name (URI) value whether to enable the feature or not

Throws: ParserConfigurationException if the feature is not supported.

Since: 1.5

setValidating

public void setValidating(boolean validating)

Sets whether document builders obtained from this factory will validate their input.

setXIncludeAware

public void setXIncludeAware(boolean state)

Sets whether parsers obtained from this factory will be XInclude aware.

Since: 1.5