javax.xml.parsers
Class DocumentBuilderFactory

java.lang.Object
  extended by javax.xml.parsers.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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentBuilderFactory

protected DocumentBuilderFactory()
Method Detail

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


newDocumentBuilder

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

setNamespaceAware

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


setValidating

public void setValidating(boolean validating)
Sets whether document builders obtained from this factory will validate their input.


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.


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.


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.


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.


isIgnoringElementContentWhitespace

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


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.


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.


setAttribute

public abstract 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
Throws:
IllegalArgumentException - if the attribute is not recognized

getAttribute

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

Parameters:
name - the name of the attribute
Throws:
IllegalArgumentException - if the attribute is not recognized

getSchema

public Schema getSchema()
Returns the schema.

Since:
1.5
See Also:
setSchema(javax.xml.validation.Schema)

setSchema

public void setSchema(Schema schema)
Sets the schema.

Since:
1.5
See Also:
getSchema()

isXIncludeAware

public boolean isXIncludeAware()
Indicates whether parsers obtained from this factory will be XInclude aware.

Since:
1.5

setXIncludeAware

public void setXIncludeAware(boolean state)
Sets whether parsers obtained from this factory will be XInclude aware.

Since:
1.5

setFeature

public abstract void setFeature(String name,
                                boolean value)
                         throws ParserConfigurationException
Sets the value of the specified feature.

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

getFeature

public abstract boolean getFeature(String name)
                            throws ParserConfigurationException
Returns the value of the specified feature.

Parameters:
name - the feature name (URI)
Throws:
ParserConfigurationException - if the feature is not supported.
Since:
1.5