DocumentBuilderFactory

DocumentBuilderFactory

protected DocumentBuilderFactory()

getAttribute

abstract fun getAttribute(name: String!): Any!

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

getFeature

abstract fun getFeature(name: String!): Boolean

Get the state of the named feature.

Feature names are fully qualified java.net.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

open fun getSchema(): Schema!

Gets the Schema object specified through the setSchema(javax.xml.validation.Schema) method.

isCoalescing

open fun isCoalescing(): Boolean

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

open fun isExpandEntityReferences(): Boolean

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

isIgnoringComments

open fun isIgnoringComments(): Boolean

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

isIgnoringElementContentWhitespace

open fun isIgnoringElementContentWhitespace(): Boolean

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

isNamespaceAware

open fun isNamespaceAware(): Boolean

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

isValidating

open fun isValidating(): Boolean

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

isXIncludeAware

open fun isXIncludeAware(): Boolean

Get state of XInclude processing.

newDocumentBuilder

abstract fun newDocumentBuilder(): DocumentBuilder!

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

newInstance

open static fun newInstance(): DocumentBuilderFactory!

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

newInstance

open static fun newInstance(
    factoryClassName: String!, 
    classLoader: ClassLoader!
): DocumentBuilderFactory!

Returns an instance of the named implementation of DocumentBuilderFactory.

setAttribute

abstract fun setAttribute(
    name: String!, 
    value: Any!
): Unit

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

setCoalescing

open fun setCoalescing(coalescing: Boolean): Unit

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

open fun setExpandEntityReferences(expandEntityRef: Boolean): Unit

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

setFeature

abstract fun setFeature(
    name: String!, 
    value: Boolean
): Unit

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

Feature names are fully qualified java.net.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.

Earlier versions of this documentation have mandated support for the javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING feature, but this is not a supported feature on any version of Android.

setIgnoringComments

open fun setIgnoringComments(ignoreComments: Boolean): Unit

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

setIgnoringElementContentWhitespace

open fun setIgnoringElementContentWhitespace(whitespace: Boolean): Unit

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

open fun setNamespaceAware(awareness: Boolean): Unit

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

open fun setSchema(schema: Schema!): Unit

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 org.xml.sax.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 org.xml.sax.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

open fun setValidating(validating: Boolean): Unit

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(javax.xml.validation.Schema) method to associate a schema to a parser.

setXIncludeAware

open fun setXIncludeAware(state: Boolean): Unit

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.