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.
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Allows the user to retrieve specific attributes on the underlying
implementation.
| |||||||||||
Get the state of the named feature. | |||||||||||
Gets the
Schema object specified through
the setSchema(Schema) method. | |||||||||||
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.
| |||||||||||
Indicates whether or not the factory is configured to produce
parsers which expand entity reference nodes.
| |||||||||||
Indicates whether or not the factory is configured to produce
parsers which ignores comments.
| |||||||||||
Indicates whether or not the factory is configured to produce
parsers which ignore ignorable whitespace in element content.
| |||||||||||
Indicates whether or not the factory is configured to produce
parsers which are namespace aware.
| |||||||||||
Indicates whether or not the factory is configured to produce
parsers which validate the XML content during parse.
| |||||||||||
Get state of XInclude processing. | |||||||||||
Creates a new instance of a
DocumentBuilder
using the currently configured parameters. | |||||||||||
Returns an instance of the named implementation of
DocumentBuilderFactory . | |||||||||||
Returns Android's implementation of
DocumentBuilderFactory . | |||||||||||
Allows the user to set specific attributes on the underlying
implementation.
| |||||||||||
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.
| |||||||||||
Specifies that the parser produced by this code will
expand entity reference nodes.
| |||||||||||
Set a feature for this | |||||||||||
Specifies that the parser produced by this code will ignore comments. | |||||||||||
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).
| |||||||||||
Specifies that the parser produced by this code will
provide support for XML namespaces.
| |||||||||||
Set the | |||||||||||
Specifies that the parser produced by this code will
validate documents as they are parsed.
| |||||||||||
Set state of XInclude processing. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Allows the user to retrieve specific attributes on the underlying implementation.
name | The name of the attribute. |
---|
IllegalArgumentException | thrown if the underlying implementation doesn't recognize the attribute. |
---|
Get the state of the named feature.
Feature names are fully qualified URI
s.
Implementations may define their own features.
An ParserConfigurationException
is thrown if this DocumentBuilderFactory
or the
DocumentBuilder
s it creates cannot support the feature.
It is possible for an DocumentBuilderFactory
to expose a feature value but be unable to change its state.
name | Feature name. |
---|
ParserConfigurationException | if this DocumentBuilderFactory
or the DocumentBuilder s it creates cannot support this feature.
|
---|
Gets the Schema
object specified through
the setSchema(Schema)
method.
Schema
object that was last set through
the setSchema(Schema)
method, or null
if the method was not invoked since a DocumentBuilderFactory
is created.UnsupportedOperationException | For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
---|
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.
Indicates whether or not the factory is configured to produce parsers which expand entity reference nodes.
Indicates whether or not the factory is configured to produce parsers which ignores comments.
Indicates whether or not the factory is configured to produce parsers which ignore ignorable whitespace in element content.
Indicates whether or not the factory is configured to produce parsers which are namespace aware.
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
Get state of XInclude processing.
UnsupportedOperationException | For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
---|
Creates a new instance of a DocumentBuilder
using the currently configured parameters.
ParserConfigurationException | if a DocumentBuilder cannot be created which satisfies the configuration requested. |
---|
Returns an instance of the named implementation of DocumentBuilderFactory
.
FactoryConfigurationError | if factoryClassName is not available or cannot be
instantiated. |
---|
Returns Android's implementation of DocumentBuilderFactory
.
Unlike other Java implementations, this method does not consult system
properties, property files, or the services API.
Allows the user to set specific attributes on the underlying implementation.
name | The name of the attribute. |
---|---|
value | The value of the attribute. |
IllegalArgumentException | thrown if the underlying implementation doesn't recognize the attribute. |
---|
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
coalescing | true if the parser produced will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node; false otherwise. |
---|
Specifies that the parser produced by this code will
expand entity reference nodes. By default the value of this is set to
true
expandEntityRef | true if the parser produced will expand entity reference nodes; false otherwise. |
---|
Set a feature for this DocumentBuilderFactory
and DocumentBuilder
s created by this factory.
Feature names are fully qualified URI
s.
Implementations may define their own features.
An ParserConfigurationException
is thrown if this DocumentBuilderFactory
or the
DocumentBuilder
s 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.
name | Feature name. |
---|---|
value | Is feature state true or false . |
ParserConfigurationException | if this DocumentBuilderFactory or the DocumentBuilder s
it creates cannot support this feature. |
---|---|
NullPointerException | If the name parameter is null.
|
Specifies that the parser produced by this code will
ignore comments. By default the value of this is set to false
.
ignoreComments | boolean value to ignore comments during processing
|
---|
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
.
whitespace | true if the parser created must eliminate whitespace in the element content when parsing XML documents; false otherwise. |
---|
Specifies that the parser produced by this code will
provide support for XML namespaces. By default the value of this is set
to false
awareness | true if the parser produced will provide support for XML namespaces; false otherwise. |
---|
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.
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.
schema | Schema to use or null to remove a schema. |
---|
UnsupportedOperationException | For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
---|
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.
validating | true if the parser produced will validate documents as they are parsed; false otherwise. |
---|
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
.
state | Set XInclude processing to true or
false |
---|
UnsupportedOperationException | For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
---|