Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
javax.xml.parsers.DocumentBuilderFactory
public abstract class DocumentBuilderFactory
extends java.lang.Object
Constructor Summary | |
Method Summary | |
abstract Object |
|
abstract boolean |
|
Schema | |
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
abstract DocumentBuilder |
|
static DocumentBuilderFactory |
|
abstract void |
|
void |
|
void |
|
abstract void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
public abstract Object getAttribute(String name) throws IllegalArgumentException
Allows the user to retrieve specific attributes on the underlying implementation.
- Parameters:
name
- The name of the attribute.
- Returns:
- value The value of the attribute.
public abstract boolean getFeature(String name) throws ParserConfigurationException
Get the state of the named feature. Feature names are fully qualifiedjava.net.URI
s. Implementations may define their own features. AnParserConfigurationException
is thrown if thisDocumentBuilderFactory
or theDocumentBuilder
s it creates cannot support the feature. It is possible for anDocumentBuilderFactory
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 thisDocumentBuilderFactory
or theDocumentBuilder
s it creates cannot support this feature.
public Schema getSchema()
Gets theSchema
object specified through thesetSchema(Schema schema)
method.
- Returns:
- the
Schema
object that was last set through thesetSchema(Schema)
method, or null if the method was not invoked since aSAXParserFactory
is created.
- Since:
- 1.5
public 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.
- 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.
public boolean isExpandEntityReferences()
Indicates whether or not the factory is configured to produce parsers which expand entity reference nodes.
- Returns:
- true if the factory is configured to produce parsers which expand entity reference nodes; false otherwise.
public boolean isIgnoringComments()
Indicates whether or not the factory is configured to produce parsers which ignores comments.
- Returns:
- true if the factory is configured to produce parsers which ignores comments; false otherwise.
public boolean isIgnoringElementContentWhitespace()
Indicates whether or not the factory is configured to produce parsers which ignore ignorable whitespace in element content.
- Returns:
- true if the factory is configured to produce parsers which ignore ignorable whitespace in element content; false otherwise.
public boolean isNamespaceAware()
Indicates whether or not the factory is configured to produce parsers which are namespace aware.
- Returns:
- true if the factory is configured to produce parsers which are namespace aware; false otherwise.
public boolean isValidating()
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
- Returns:
- true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.
public boolean isXIncludeAware()
Get state of XInclude processing.
- Returns:
- current state of XInclude processing
- Since:
- 1.5
public abstract DocumentBuilder newDocumentBuilder() throws ParserConfigurationException
Creates a new instance of aDocumentBuilder
using the currently configured parameters.
- Returns:
- A new instance of a DocumentBuilder.
- Throws:
ParserConfigurationException
- if a DocumentBuilder cannot be created which satisfies the configuration requested.
public static DocumentBuilderFactory newInstance()
Obtain a new instance of aDocumentBuilderFactory
. This static method creates a new factory instance. This method uses the following ordered lookup procedure to determine theDocumentBuilderFactory
implementation class to load:Once an application has obtained a reference to a
- Use the
javax.xml.parsers.DocumentBuilderFactory
system property.- Use the properties file "lib/jaxp.properties" in the JRE directory. This configuration file is in standard
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.- Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file
META-INF/services/javax.xml.parsers.DocumentBuilderFactory
in jars available to the runtime.- Platform default
DocumentBuilderFactory
instance.DocumentBuilderFactory
it can use the factory to configure and obtain parser instances.Tip for Trouble-shooting
Setting thejaxp.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 loadingDocumentBuilder
s, try:java -Djaxp.debug=1 YourProgram ....
- Returns:
- New instance of a
DocumentBuilderFactory
public abstract void setAttribute(String name, Object value) throws IllegalArgumentException
Allows the user to set specific attributes on the underlying implementation.
- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
public 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 tofalse
- 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.
public 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 totrue
- Parameters:
expandEntityRef
- true if the parser produced will expand entity reference nodes; false otherwise.
public abstract void setFeature(String name, boolean value) throws ParserConfigurationException
Set a feature for thisDocumentBuilderFactory
andDocumentBuilder
s created by this factory. Feature names are fully qualifiedjava.net.URI
s. Implementations may define their own features. AnParserConfigurationException
is thrown if thisDocumentBuilderFactory
or theDocumentBuilder
s it creates cannot support the feature. It is possible for anDocumentBuilderFactory
to expose a feature value but be unable to change its state. All implementations are required to support theXMLConstants.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 registeredorg.xml.sax.ErrorHandler.fatalError(SAXParseException exception)
. SeeDocumentBuilder.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 statetrue
orfalse
.
- Throws:
ParserConfigurationException
- if thisDocumentBuilderFactory
or theDocumentBuilder
s it creates cannot support this feature.
public void setIgnoringComments(boolean ignoreComments)
Specifies that the parser produced by this code will ignore comments. By default the value of this is set tofalse
.
- Parameters:
ignoreComments
-boolean
value to ignore comments during processing
public 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 tofalse
.
- Parameters:
whitespace
- true if the parser created must eliminate whitespace in the element content when parsing XML documents; false otherwise.
public 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 tofalse
- Parameters:
awareness
- true if the parser produced will provide support for XML namespaces; false otherwise.
public void setSchema(Schema schema)
Set theSchema
to be used by parsers created from this factory. When aSchema
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-specifiedDOMErrorHandler
(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-specifiedDOMErrorHandler
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 theSchema
. This processing will take effect even if theisValidating()
method returns false. It is an error to use thehttp://java.sun.com/xml/jaxp/properties/schemaSource
property and/or thehttp://java.sun.com/xml/jaxp/properties/schemaLanguage
property in conjunction with aSchema
object. Such configuration will cause aParserConfigurationException
exception when thenewDocumentBuilder()
is invoked.Note for implmentors
A parser must be able to work with anySchema
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 ornull
to remove a schema.
- Since:
- 1.5
public 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 tofalse
. 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 thesetValidating(boolean)
method false, then use thesetSchema(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.
public 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 tofalse
.
- Parameters:
state
- Set XInclude processing totrue
orfalse
- Since:
- 1.5