javax.xml.parsers
public abstract class DocumentBuilderFactory extends Object
Version: $Revision: 226183 $, $Date: 2005-04-08 06:39:14 -0400 (Fri, 08 Apr 2005) $
Constructor Summary | |
---|---|
protected | DocumentBuilderFactory() |
Method Summary | |
---|---|
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. Feature names are fully qualified {@link java.net.URI}s. |
Schema | getSchema()
Gets the {@link Schema} object specified through
the {@link #setSchema(Schema 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 {@link javax.xml.parsers.DocumentBuilder}
using the currently configured parameters.
|
static DocumentBuilderFactory | newInstance()
Obtain a new instance of a
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 Feature names are fully qualified {@link java.net.URI}s. |
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 {@link 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. 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 |
Parameters: name The name of the attribute.
Returns: value The value of the attribute.
Throws: IllegalArgumentException thrown if the underlying implementation doesn't recognize the attribute.
Get the state of the named feature.
Feature names are fully qualified {@link java.net.URI}s.
Implementations may define their own features.
An {@link 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.
Parameters: name Feature name.
Returns: State of the named feature.
Throws: ParserConfigurationException if this DocumentBuilderFactory
or the DocumentBuilder
s it creates cannot support this feature.
Returns: the {@link Schema} object that was last set through the {@link #setSchema(Schema)} method, or null if the method was not invoked since a {@link SAXParserFactory} is created.
Throws: UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.
Since: 1.5
Returns: 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.
Returns: true if the factory is configured to produce parsers which expand entity reference nodes; false otherwise.
Returns: true if the factory is configured to produce parsers which ignores comments; false otherwise.
Returns: true if the factory is configured to produce parsers which ignore ignorable whitespace in element content; false otherwise.
Returns: true if the factory is configured to produce parsers which are namespace aware; false otherwise.
Returns: true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.
Get state of XInclude processing.
Returns: current state of XInclude processing
Throws: UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.
Since: 1.5
Returns: A new instance of a DocumentBuilder.
Throws: ParserConfigurationException if a DocumentBuilder cannot be created which satisfies the configuration requested.
DocumentBuilderFactory
. This static method creates
a new factory instance.
This method uses the following ordered lookup procedure to determine
the DocumentBuilderFactory
implementation class to
load:
javax.xml.parsers.DocumentBuilderFactory
system
property.
java.util.Properties
format and contains the fully qualified name of the
implementation class with the key being the system property defined
above.
The jaxp.properties file is read only once by the JAXP implementation
and it's values are then cached for future use. If the file does not exist
when the first attempt is made to read from it, no further attempts are
made to check for its existence. It is not possible to change the value
of any property in jaxp.properties after it has been read for the first time.
META-INF/services/javax.xml.parsers.DocumentBuilderFactory
in jars available to the runtime.
DocumentBuilderFactory
instance.
DocumentBuilderFactory
it can use the factory to
configure and obtain parser instances.
Setting the jaxp.debug
system property will cause
this method to print a lot of debug messages
to System.err about what it is doing and where it is looking at.
If you have problems loading {@link DocumentBuilder}s, try:
java -Djaxp.debug=1 YourProgram ....
Returns: New instance of a DocumentBuilderFactory
Throws: FactoryConfigurationError if the implementation is not available or cannot be instantiated.
Parameters: name The name of the attribute. value The value of the attribute.
Throws: IllegalArgumentException thrown if the underlying implementation doesn't recognize the attribute.
false
Parameters: 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.
true
Parameters: 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 {@link java.net.URI}s.
Implementations may define their own features.
An {@link 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 {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature. When the feature is:
true
: the implementation will limit XML processing to conform to implementation limits.
Examples include enity 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
{@link org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)}.
See {@link DocumentBuilder#setErrorHandler(org.xml.sax.ErrorHandler errorHandler)}.
false
: the implementation will processing XML according to the XML specifications without
regard to possible implementation limits.
Parameters: name Feature name. value Is feature state true
or false
.
Throws: 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
.
Parameters: ignoreComments boolean
value to ignore comments during processing
false
.
Parameters: whitespace true if the parser created must eliminate whitespace in the element content when parsing XML documents; false otherwise.
false
Parameters: awareness true if the parser produced will provide support for XML namespaces; false otherwise.
Set the {@link Schema} to be used by parsers created from this factory.
When a {@link 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 {@link org.w3c.dom.DOMErrorHandler} (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 {@link org.w3c.dom.DOMErrorHandler} 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.
Initialy, null is set as the {@link Schema}.
This processing will take effect even if the {@link #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 {@link Schema} object.
Such configuration will cause a {@link ParserConfigurationException}
exception when the {@link #newDocumentBuilder()} is invoked.
A parser must be able to work with any {@link 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
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.
Since: 1.5
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 {@link #setValidating(boolean)} method false, then use the {@link #setSchema(Schema)} method to associate a schema to a parser.
Parameters: 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
.
Parameters: state 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.
Since: 1.5