javax.xml.parsers

Class DocumentBuilderFactory

Known Direct Subclasses:
DomDocumentBuilderFactory, GnomeDocumentBuilderFactory, JAXPFactory

public abstract class DocumentBuilderFactory
extends Object

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

Constructor Summary

DocumentBuilderFactory()
The basic constructor.

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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentBuilderFactory

protected DocumentBuilderFactory()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

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

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

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

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.

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

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.
Since:
1.5
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.5

DocumentBuilderFactory.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.