DocumentBuilderFactory

DocumentBuilderFactory

DocumentBuilderFactory ()

getAttribute

Object getAttribute (String name)

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

getFeature

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.

getSchema

Schema getSchema ()

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

isCoalescing

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.

isExpandEntityReferences

boolean isExpandEntityReferences ()

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

isIgnoringComments

boolean isIgnoringComments ()

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

isIgnoringElementContentWhitespace

boolean isIgnoringElementContentWhitespace ()

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

isNamespaceAware

boolean isNamespaceAware ()

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

isValidating

boolean isValidating ()

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

isXIncludeAware

boolean isXIncludeAware ()

Get state of XInclude processing.

newDocumentBuilder

DocumentBuilder newDocumentBuilder ()

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

newInstance

DocumentBuilderFactory newInstance (String factoryClassName, 
                ClassLoader classLoader)

Returns an instance of the named implementation of DocumentBuilderFactory.

newInstance

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.

setAttribute

void setAttribute (String name, 
                Object value)

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

setCoalescing

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

setExpandEntityReferences

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

setFeature

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.

setIgnoringComments

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 .

setIgnoringElementContentWhitespace

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.

setNamespaceAware

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

setSchema

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.

setValidating

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.

setXIncludeAware

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.