Skip to content

Most visited

Recently visited

navigation

DocumentBuilderFactory

public abstract class DocumentBuilderFactory
extends Object

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


Defines a factory API that enables applications to obtain a parser that produces DOM object trees from XML documents.

Summary

Protected constructors

DocumentBuilderFactory()

Public methods

abstract Object getAttribute(String name)

Allows the user to retrieve specific attributes on the underlying implementation.

abstract boolean getFeature(String name)

Get the state of the named feature.

Schema getSchema()

Gets the Schema object specified through the setSchema(Schema) method.

boolean isCoalescing()

Indicates whether or not the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node.

boolean isExpandEntityReferences()

Indicates whether or not the factory is configured to produce parsers which expand entity reference nodes.

boolean isIgnoringComments()

Indicates whether or not the factory is configured to produce parsers which ignores comments.

boolean isIgnoringElementContentWhitespace()

Indicates whether or not the factory is configured to produce parsers which ignore ignorable whitespace in element content.

boolean isNamespaceAware()

Indicates whether or not the factory is configured to produce parsers which are namespace aware.

boolean isValidating()

Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.

boolean isXIncludeAware()

Get state of XInclude processing.

abstract DocumentBuilder newDocumentBuilder()

Creates a new instance of a DocumentBuilder using the currently configured parameters.

static DocumentBuilderFactory newInstance(String factoryClassName, ClassLoader classLoader)

Returns an instance of the named implementation of DocumentBuilderFactory.

static DocumentBuilderFactory newInstance()

Returns Android's implementation of DocumentBuilderFactory.

abstract void setAttribute(String name, Object value)

Allows the user to set specific attributes on the underlying implementation.

void setCoalescing(boolean coalescing)

Specifies that the parser produced by this code will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node.

void setExpandEntityReferences(boolean expandEntityRef)

Specifies that the parser produced by this code will expand entity reference nodes.

abstract void setFeature(String name, boolean value)

Set a feature for this DocumentBuilderFactory and DocumentBuilders created by this factory.

void setIgnoringComments(boolean ignoreComments)

Specifies that the parser produced by this code will ignore comments.

void setIgnoringElementContentWhitespace(boolean whitespace)

Specifies that the parsers created by this factory must eliminate whitespace in element content (sometimes known loosely as 'ignorable whitespace') when parsing XML documents (see XML Rec 2.10).

void setNamespaceAware(boolean awareness)

Specifies that the parser produced by this code will provide support for XML namespaces.

void setSchema(Schema schema)

Set the Schema to be used by parsers created from this factory.

void setValidating(boolean validating)

Specifies that the parser produced by this code will validate documents as they are parsed.

void setXIncludeAware(boolean state)

Set state of XInclude processing.

Inherited methods

From class java.lang.Object

Protected constructors

DocumentBuilderFactory

Added in API level 1
DocumentBuilderFactory ()

Public methods

getAttribute

Added in API level 1
Object getAttribute (String name)

Allows the user to retrieve specific attributes on the underlying implementation.

Parameters
name String: The name of the attribute.
Returns
Object value The value of the attribute.
Throws
IllegalArgumentException thrown if the underlying implementation doesn't recognize the attribute.

getFeature

Added in API level 1
boolean getFeature (String name)

Get the state of the named feature.

Feature names are fully qualified URIs. Implementations may define their own features. An ParserConfigurationException is thrown if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support the feature. It is possible for an DocumentBuilderFactory to expose a feature value but be unable to change its state.

Parameters
name String: Feature name.
Returns
boolean State of the named feature.
Throws
ParserConfigurationException if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support this feature.

getSchema

Added in API level 8
Schema getSchema ()

Gets the Schema object specified through the setSchema(Schema) method.

Returns
Schema the Schema object that was last set through the setSchema(Schema) method, or null if the method was not invoked since a DocumentBuilderFactory is created.
Throws
UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

isCoalescing

Added in API level 1
boolean isCoalescing ()

Indicates whether or not the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node.

Returns
boolean true if the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node; false otherwise.

isExpandEntityReferences

Added in API level 1
boolean isExpandEntityReferences ()

Indicates whether or not the factory is configured to produce parsers which expand entity reference nodes.

Returns
boolean true if the factory is configured to produce parsers which expand entity reference nodes; false otherwise.

isIgnoringComments

Added in API level 1
boolean isIgnoringComments ()

Indicates whether or not the factory is configured to produce parsers which ignores comments.

Returns
boolean true if the factory is configured to produce parsers which ignores comments; false otherwise.

isIgnoringElementContentWhitespace

Added in API level 1
boolean isIgnoringElementContentWhitespace ()

Indicates whether or not the factory is configured to produce parsers which ignore ignorable whitespace in element content.

Returns
boolean true if the factory is configured to produce parsers which ignore ignorable whitespace in element content; false otherwise.

isNamespaceAware

Added in API level 1
boolean isNamespaceAware ()

Indicates whether or not the factory is configured to produce parsers which are namespace aware.

Returns
boolean true if the factory is configured to produce parsers which are namespace aware; false otherwise.

isValidating

Added in API level 1
boolean isValidating ()

Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.

Returns
boolean true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.

isXIncludeAware

Added in API level 1
boolean isXIncludeAware ()

Get state of XInclude processing.

Returns
boolean current state of XInclude processing
Throws
UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

newDocumentBuilder

Added in API level 1
DocumentBuilder newDocumentBuilder ()

Creates a new instance of a DocumentBuilder using the currently configured parameters.

Returns
DocumentBuilder A new instance of a DocumentBuilder.
Throws
ParserConfigurationException if a DocumentBuilder cannot be created which satisfies the configuration requested.

newInstance

Added in API level 9
DocumentBuilderFactory newInstance (String factoryClassName, 
                ClassLoader classLoader)

Returns an instance of the named implementation of DocumentBuilderFactory.

Parameters
factoryClassName String
classLoader ClassLoader
Returns
DocumentBuilderFactory
Throws
FactoryConfigurationError if factoryClassName is not available or cannot be instantiated.

newInstance

Added in API level 1
DocumentBuilderFactory newInstance ()

Returns Android's implementation of DocumentBuilderFactory. Unlike other Java implementations, this method does not consult system properties, property files, or the services API.

Returns
DocumentBuilderFactory a new DocumentBuilderFactory.

setAttribute

Added in API level 1
void setAttribute (String name, 
                Object value)

Allows the user to set specific attributes on the underlying implementation.

Parameters
name String: The name of the attribute.
value Object: The value of the attribute.
Throws
IllegalArgumentException thrown if the underlying implementation doesn't recognize the attribute.

setCoalescing

Added in API level 1
void setCoalescing (boolean coalescing)

Specifies that the parser produced by this code will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node. By default the value of this is set to false

Parameters
coalescing boolean: true if the parser produced will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node; false otherwise.

setExpandEntityReferences

Added in API level 1
void setExpandEntityReferences (boolean expandEntityRef)

Specifies that the parser produced by this code will expand entity reference nodes. By default the value of this is set to true

Parameters
expandEntityRef boolean: true if the parser produced will expand entity reference nodes; false otherwise.

setFeature

Added in API level 1
void setFeature (String name, 
                boolean value)

Set a feature for this DocumentBuilderFactory and DocumentBuilders created by this factory.

Feature names are fully qualified URIs. Implementations may define their own features. An ParserConfigurationException is thrown if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support the feature. It is possible for an DocumentBuilderFactory to expose a feature value but be unable to change its state.

All implementations are required to support the FEATURE_SECURE_PROCESSING feature. When the feature is:

  • true: the implementation will limit XML processing to conform to implementation limits. Examples include entity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered fatalError(SAXParseException). See setErrorHandler(org.xml.sax.ErrorHandler).
  • false: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.

Parameters
name String: Feature name.
value boolean: Is feature state true or false.
Throws
ParserConfigurationException if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support this feature.
NullPointerException If the name parameter is null.

setIgnoringComments

Added in API level 1
void setIgnoringComments (boolean ignoreComments)

Specifies that the parser produced by this code will ignore comments. By default the value of this is set to false .

Parameters
ignoreComments boolean: boolean value to ignore comments during processing

setIgnoringElementContentWhitespace

Added in API level 1
void setIgnoringElementContentWhitespace (boolean whitespace)

Specifies that the parsers created by this factory must eliminate whitespace in element content (sometimes known loosely as 'ignorable whitespace') when parsing XML documents (see XML Rec 2.10). Note that only whitespace which is directly contained within element content that has an element only content model (see XML Rec 3.2.1) will be eliminated. Due to reliance on the content model this setting requires the parser to be in validating mode. By default the value of this is set to false.

Parameters
whitespace boolean: true if the parser created must eliminate whitespace in the element content when parsing XML documents; false otherwise.

setNamespaceAware

Added in API level 1
void setNamespaceAware (boolean awareness)

Specifies that the parser produced by this code will provide support for XML namespaces. By default the value of this is set to false

Parameters
awareness boolean: true if the parser produced will provide support for XML namespaces; false otherwise.

setSchema

Added in API level 8
void setSchema (Schema schema)

Set the Schema to be used by parsers created from this factory.

When a Schema is non-null, a parser will use a validator created from it to validate documents before it passes information down to the application.

When errors are found by the validator, the parser is responsible to report them to the user-specified ErrorHandler (or if the error handler is not set, ignore them or throw them), just like any other errors found by the parser itself. In other words, if the user-specified ErrorHandler is set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules.

A validator may modify the outcome of a parse (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive modified DOM trees.

Initially, null is set as the Schema.

This processing will take effect even if the isValidating() method returns false.

It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSource property and/or the http://java.sun.com/xml/jaxp/properties/schemaLanguage property in conjunction with a Schema object. Such configuration will cause a ParserConfigurationException exception when the newDocumentBuilder() is invoked.

Note for implementors

A parser must be able to work with any Schema implementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification.

Parameters
schema Schema: Schema to use or null to remove a schema.
Throws
UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

setValidating

Added in API level 1
void setValidating (boolean validating)

Specifies that the parser produced by this code will validate documents as they are parsed. By default the value of this is set to false.

Note that "the validation" here means a validating parser as defined in the XML recommendation. In other words, it essentially just controls the DTD validation. (except the legacy two properties defined in JAXP 1.2. See here for more details.)

To use modern schema languages such as W3C XML Schema or RELAX NG instead of DTD, you can configure your parser to be a non-validating parser by leaving the setValidating(boolean) method false, then use the setSchema(Schema) method to associate a schema to a parser.

Parameters
validating boolean: true if the parser produced will validate documents as they are parsed; false otherwise.

setXIncludeAware

Added in API level 1
void setXIncludeAware (boolean state)

Set state of XInclude processing.

If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0.

XInclude processing defaults to false.

Parameters
state boolean: Set XInclude processing to true or false
Throws
UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.