Added in API level 1

DocumentBuilderFactory

abstract class DocumentBuilderFactory
kotlin.Any
   ↳ 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

Public methods
abstract Any!

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

abstract Boolean

Get the state of the named feature.

open Schema!

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

open 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.

open Boolean

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

open Boolean

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

open Boolean

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

open Boolean

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

open Boolean

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

open Boolean

Get state of XInclude processing.

abstract DocumentBuilder!

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

open static DocumentBuilderFactory!

Returns Android's implementation of DocumentBuilderFactory.

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

Returns an instance of the named implementation of DocumentBuilderFactory.

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

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

open Unit
setCoalescing(coalescing: Boolean)

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.

open Unit

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

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

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

open Unit
setIgnoringComments(ignoreComments: Boolean)

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

open 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).

open Unit

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

open Unit
setSchema(schema: Schema!)

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

open Unit
setValidating(validating: Boolean)

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

open Unit

Set state of XInclude processing.

Protected constructors

DocumentBuilderFactory

Added in API level 1
protected DocumentBuilderFactory()

Public methods

getAttribute

Added in API level 1
abstract fun getAttribute(name: String!): Any!

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

Parameters
name String!: The name of the attribute.
Return
Any! value The value of the attribute.
Exceptions
java.lang.IllegalArgumentException thrown if the underlying implementation doesn't recognize the attribute.

getFeature

Added in API level 1
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.

Parameters
name String!: Feature name.
Return
Boolean State of the named feature.
Exceptions
javax.xml.parsers.ParserConfigurationException if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support this feature.

getSchema

Added in API level 8
open fun getSchema(): Schema!

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

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

isCoalescing

Added in API level 1
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.

Return
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
open fun isExpandEntityReferences(): Boolean

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

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

isIgnoringComments

Added in API level 1
open fun isIgnoringComments(): Boolean

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

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

isIgnoringElementContentWhitespace

Added in API level 1
open fun isIgnoringElementContentWhitespace(): Boolean

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

Return
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
open fun isNamespaceAware(): Boolean

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

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

isValidating

Added in API level 1
open fun isValidating(): Boolean

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

Return
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
open fun isXIncludeAware(): Boolean

Get state of XInclude processing.

Return
Boolean current state of XInclude processing
Exceptions
java.lang.UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

newDocumentBuilder

Added in API level 1
abstract fun newDocumentBuilder(): DocumentBuilder!

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

Return
DocumentBuilder! A new instance of a DocumentBuilder.
Exceptions
javax.xml.parsers.ParserConfigurationException if a DocumentBuilder cannot be created which satisfies the configuration requested.

newInstance

Added in API level 1
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.

Return
DocumentBuilderFactory! a new DocumentBuilderFactory.

newInstance

Added in API level 9
open static fun newInstance(
    factoryClassName: String!,
    classLoader: ClassLoader!
): DocumentBuilderFactory!

Returns an instance of the named implementation of DocumentBuilderFactory.

Exceptions
javax.xml.parsers.FactoryConfigurationError if factoryClassName is not available or cannot be instantiated.

setAttribute

Added in API level 1
abstract fun setAttribute(
    name: String!,
    value: Any!
): Unit

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

Parameters
name String!: The name of the attribute.
value Any!: The value of the attribute.
Exceptions
java.lang.IllegalArgumentException thrown if the underlying implementation doesn't recognize the attribute.

setCoalescing

Added in API level 1
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

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

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

setFeature

Added in API level 1
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.

Parameters
name String!: Feature name.
value Boolean: Is feature state true or false.
Exceptions
javax.xml.parsers.ParserConfigurationException if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support this feature.
java.lang.NullPointerException If the name parameter is null.

setIgnoringComments

Added in API level 1
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 .

Parameters
ignoreComments Boolean: boolean value to ignore comments during processing

setIgnoringElementContentWhitespace

Added in API level 1
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.

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

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

setSchema

Added in API level 8
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.

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

setValidating

Added in API level 1
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.

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

setXIncludeAware

Added in API level 1
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.

Parameters
state Boolean: Set XInclude processing to true or false
Exceptions
java.lang.UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.