Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.xml.parsers

Class DocumentBuilderFactory

Known Direct Subclasses:
DomDocumentBuilderFactory, GnomeDocumentBuilderFactory, JAXPFactory
public abstract class DocumentBuilderFactory
extends java.lang.Object
Factory for obtaining document builders. Instances of this class are not guaranteed to be thread safe.

Constructor Summary

DocumentBuilderFactory()

Method Summary

Object
getAttribute(String name)
Retrieves the named attribute value from the underlying implementation.
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.
DocumentBuilder
newDocumentBuilder()
Creates a new document builder instance using the currently specified factory configuration.
static DocumentBuilderFactory
newInstance()
Creates a new factory instance.
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.
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 Details

DocumentBuilderFactory

protected DocumentBuilderFactory()

Method Details

getAttribute

public Object getAttribute(String name)
            throws IllegalArgumentException
Retrieves the named attribute value from the underlying implementation.

Parameters:
name - the name of the attribute

getSchema

public Schema getSchema()
Returns the schema.

See Also:
setSchema(Schema)

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

newDocumentBuilder

public DocumentBuilder newDocumentBuilder()
            throws ParserConfigurationException
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:
  1. the javax.xml.parsers.DocumentBuilderFactory system property
  2. the above named property value in the $JAVA_HOME/lib/jaxp.properties file
  3. the class name specified in the META-INF/services/javax.xml.parsers.DocumentBuilderFactory system resource
  4. the default factory class

setAttribute

public void setAttribute(String name,
                         Object value)
            throws IllegalArgumentException
Set the named attribute on the underlying implementation.

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

setCoalescing

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

setExpandEntityReferences

public void setExpandEntityReferences(boolean expandEntityRef)
Sets whether document builders obtained from this factory will expand entity reference nodes.

setIgnoringComments

public void setIgnoringComments(boolean ignoreComments)
Sets whether document builders obtained from this factory will discard comment nodes.

setIgnoringElementContentWhitespace

public void setIgnoringElementContentWhitespace(boolean whitespace)
Sets whether document builders obtained from this factory will eliminate whitespace within elements that have an element-only content model.

setNamespaceAware

public void setNamespaceAware(boolean awareness)
Sets whether document builders obtained from this factory will be XML Namespace aware.

setSchema

public void setSchema(Schema schema)
Sets the schema.

See Also:
getSchema()

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

Overview Package Tree Index Deprecated About